Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Fix properties and other improvements #1675

Merged

Conversation

aidinabedi
Copy link
Contributor

PR updates tsd-jsdoc to 2.40, which adds support for @property (among other things). I should know I added all the new features in this tsd-jsdoc update 😉

Property fixes:

  • fix invalid @property types (referencing constants) in multiple classes
  • add full documentation for pc.ParticleSystemComponent#blend
  • fix misplaced @property tag in pc.SoundInstance3d
  • fix remaining issues with unspecified array type (incl pc.Asset#resources)
  • add possible null value on texture properties for materials.
  • add possible null value for pc.StandardMaterial#shader, #stencilFront, #stencilBack
  • add possible number value in property pc.ModelComponent#asset
  • add possible attached components as properties to pc.Entity
  • add properties for pc.MeshInstance#node and #mesh
  • add property pc.VertexIterator#element
  • improve property pc.CurveSet#type
  • add property pc.Curve#type
  • add property pc.Scene#defaultMaterial
  • add property pc.GraphicsDevice#fullscreen
  • add property pc.GraphicsDevice#maxPixelRatio
  • add property pc.GraphicsDevice#textureFloatHighPrecision
  • add property pc.GraphicsDevice#textureHalfRenderable and #textureHalfFloatRenderable
  • add property to pc.Mat3#data and pc.Mat4#data
  • add property pc.Mesh#primitive

Other improvements:

  • improve pc.GraphicsDevice#draw
  • mark interface method pc.ResourceHandler#patch as optional
  • fix duplicate jsdoc names for constant pc.SHADER_FORWARD
  • fix missing options in pc.Application constructor parameter
  • fix alternative type in pc.Keyboard constructor parameter

I confirm I have signed the Contributor License Agreement.

aidinabedi and others added 30 commits August 24, 2019 01:14
…-properties

# Conflicts:
#	src/graphics/device.js
@willeastcott willeastcott merged commit 9ab0893 into playcanvas:master Sep 1, 2019
@aidinabedi aidinabedi deleted the feature/jsdoc-fix-properties branch September 1, 2019 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants