Help Wanted: Reformatting Documentation

Overview

Recently, we converted our documentation to use webdoc instead of JSDoc. The advantage of this switch is that much more can be inferred from the TypeScript. Right now, the documentation has type cruft from JSDoc, making it kinda unnecessarily verbose. Also, the documentation for members was historically placed within the constructor, but we’d like to move it to the root of the class where the TypeScript member is declared.

We are looking for help! These are straightforward fixes, but require many hands. If you have a free moment, please consider updating a class below (keep in mind that not all classes will need converting).

💥 BONUS POINTS FOR:

• Adding missing descriptions
• Improving descriptions
• Fixing typos

Please please please no code or logic changes.

Goals

• Make the constructor easier to read
• Expose documentation in typings
• Remove redundant information in docs such as access-modifiers and types

Style Rules

• Add initial values and member docs to the class-level
• Remove redundant access modifiers (public/private/protected)
• Remove type declarations for all private
• Make docs single line, if possible
• Remove redundant types for members
• Make sure that any default values or types with PIXI.* are retained (or else Webdoc won’t link)

Example

Old format:

/**	
 * Setting this to true will visually show the divs.	
 *	
 * @type {boolean}
 * @public
 * @default false
 */	
this.debug = false;

New format:

/** Setting this to true will visually show the divs. */
public debug = false;

Here’s an example I created with AccessibilityManager #7113

Classes To Convert

• packages/accessibility/src/AccessibilityManager.ts #7113
• packages/app/src/Application.ts #7160
• packages/app/src/ResizePlugin.ts #7160
• packages/basis/src/BasisLoader.ts #7584
• packages/basis/src/TranscoderWorker.ts #7584
• packages/canvas/canvas-extract/src/CanvasExtract.ts #7584
• packages/canvas/canvas-graphics/src/CanvasGraphicsRenderer.ts #7584
• packages/canvas/canvas-mesh/src/CanvasMeshRenderer.ts #7584
• packages/canvas/canvas-prepare/src/CanvasPrepare.ts #7584
• packages/canvas/canvas-renderer/src/CanvasRenderer.ts #7584
• packages/canvas/canvas-renderer/src/utils/CanvasMaskManager.ts #7584
• packages/canvas/canvas-sprite/src/CanvasSpriteRenderer.ts #7584
• packages/compressed-textures/src/loaders/CompressedTextureLoader.ts #7584
• packages/compressed-textures/src/loaders/DDSLoader.ts #7584
• packages/compressed-textures/src/loaders/KTXLoader.ts #7584
• packages/compressed-textures/src/resources/CompressedTextureResource.ts #7584
• packages/core/src/Renderer.ts #7802
• packages/core/src/System.ts
• packages/core/src/batch/AbstractBatchRenderer.ts #7803
• packages/core/src/batch/BatchDrawCall.ts #7910
• packages/core/src/batch/BatchGeometry.ts #7910
• packages/core/src/batch/BatchPluginFactory.ts #7910
• packages/core/src/batch/BatchShaderGenerator.ts #7910
• packages/core/src/batch/BatchSystem.ts #7910
• packages/core/src/batch/BatchTextureArray.ts #7910
• packages/core/src/batch/ObjectRenderer.ts #7910
• packages/core/src/context/ContextSystem.ts #7885
• packages/core/src/filters/Filter.ts #7992
• packages/core/src/filters/FilterState.ts #7992
• packages/core/src/filters/FilterSystem.ts #7992
• packages/core/src/filters/spriteMask/SpriteMaskFilter.ts #7992
• packages/core/src/framebuffer/Framebuffer.ts #8161
• packages/core/src/framebuffer/FramebufferSystem.ts #8161
• packages/core/src/framebuffer/GLFramebuffer.ts #8161
• packages/core/src/geometry/Attribute.ts #7963
• packages/core/src/geometry/Buffer.ts #7963
• packages/core/src/geometry/Geometry.ts #7963
• packages/core/src/geometry/GeometrySystem.ts #7963
• packages/core/src/geometry/GLBuffer.ts
• packages/core/src/geometry/ViewableBuffer.ts #8162
• packages/core/src/mask/AbstractMaskSystem.ts #7817
• packages/core/src/mask/MaskData.ts #7817
• packages/core/src/mask/MaskSystem.ts #7817
• packages/core/src/mask/ScissorSystem.ts #7817
• packages/core/src/mask/StencilSystem.ts #7817
• packages/core/src/projection/ProjectionSystem.ts #7884
• packages/core/src/renderTexture/BaseRenderTexture.ts #8162
• packages/core/src/renderTexture/RenderTexture.ts #7882
• packages/core/src/renderTexture/RenderTexturePool.ts #7882
• packages/core/src/renderTexture/RenderTextureSystem.ts #7882
• packages/core/src/shader/GLProgram.ts #8162
• packages/core/src/shader/Program.ts #7881
• packages/core/src/shader/Shader.ts #7881
• packages/core/src/shader/ShaderSystem.ts #7881
• packages/core/src/shader/UniformGroup.ts #8162
• packages/core/src/state/State.ts #7883
• packages/core/src/state/StateSystem.ts #7786
• packages/core/src/textures/BaseTexture.ts #8163
• packages/core/src/textures/GLTexture.ts #8163
• packages/core/src/textures/Texture.ts #8163
• packages/core/src/textures/TextureGCSystem.ts #8163
• packages/core/src/textures/TextureMatrix.ts #8164
• packages/core/src/textures/TextureSystem.ts #8164
• packages/core/src/textures/TextureUvs.ts #8164
• packages/core/src/textures/resources/ArrayResource.ts #7993
• packages/core/src/textures/resources/BaseImageResource.ts #7993
• packages/core/src/textures/resources/BufferResource.ts #7993
• packages/core/src/textures/resources/CanvasResource.ts #7993
• packages/core/src/textures/resources/CubeResource.ts #7993
• packages/core/src/textures/resources/DepthResource.ts #7993
• packages/core/src/textures/resources/ImageBitmapResource.ts #7993
• packages/core/src/textures/resources/ImageResource.ts #7993
• packages/core/src/textures/resources/SVGResource.ts #7993
• packages/core/src/textures/resources/VideoResource.ts #7993
• packages/core/src/utils/Quad.ts #8166
• packages/core/src/utils/QuadUv.ts #8166
• packages/display/src/Bounds.ts #8166
• packages/display/src/Container.ts #8166
• packages/display/src/DisplayObject.ts
• packages/extract/src/Extract.ts #8167
• packages/filters/filter-alpha/src/AlphaFilter.ts #7804
• packages/filters/filter-blur/src/BlurFilter.ts #7804
• packages/filters/filter-blur/src/BlurFilterPass.ts #8167
• packages/filters/filter-color-matrix/src/ColorMatrixFilter.ts #7942
• packages/filters/filter-displacement/src/DisplacementFilter.ts #7942
• packages/filters/filter-fxaa/src/FXAAFilter.ts #7942
• packages/filters/filter-noise/src/NoiseFilter.ts #7942
• packages/graphics/src/Graphics.ts #8168
• packages/graphics/src/GraphicsData.ts #8168
• packages/graphics/src/GraphicsGeometry.ts #8168
• packages/graphics/src/styles/FillStyle.ts #8168
• packages/graphics/src/styles/LineStyle.ts #8168
• packages/graphics/src/utils/ArcUtils.ts #8169
• packages/graphics/src/utils/BatchPart.ts #8169
• packages/graphics/src/utils/BezierUtils.ts #8169
• packages/graphics/src/utils/QuadraticUtils.ts #8169
• packages/graphics/src/utils/Star.ts #8169
• packages/interaction/src/InteractionData.ts #8170
• packages/interaction/src/InteractionEvent.ts #8170
• packages/interaction/src/InteractionManager.ts #8170
• packages/interaction/src/InteractionTrackingData.ts #8170
• packages/interaction/src/TreeSearch.ts #8170
• packages/loaders/src/AppLoaderPlugin.ts
• packages/loaders/src/Loader.ts
• packages/loaders/src/TextureLoader.ts
• packages/math/src/Matrix.ts #7905
• packages/math/src/ObservablePoint.ts #7905
• packages/math/src/Point.ts #7414
• packages/math/src/Transform.ts #7787
• packages/math/src/shapes/Circle.ts #7788
• packages/math/src/shapes/Ellipse.ts #7788
• packages/math/src/shapes/Polygon.ts #7966
• packages/math/src/shapes/Rectangle.ts #7876
• packages/math/src/shapes/RoundedRectangle.ts #8171
• packages/mesh/src/Mesh.ts #7965
• packages/mesh/src/MeshBatchUvs.ts #8165
• packages/mesh/src/MeshGeometry.ts #8165
• packages/mesh/src/MeshMaterial.ts #8165
• packages/mesh-extras/src/NineSlicePlane.ts #7812
• packages/mesh-extras/src/SimpleMesh.ts #7812
• packages/mesh-extras/src/SimplePlane.ts #7812
• packages/mesh-extras/src/SimpleRope.ts #7812
• packages/mesh-extras/src/geometry/PlaneGeometry.ts
• packages/mesh-extras/src/geometry/RopeGeometry.ts #8165
• packages/mixin-cache-as-bitmap/src/index.ts
• packages/particles/src/ParticleBuffer.ts #8058
• packages/particles/src/ParticleContainer.ts #8058
• packages/particles/src/ParticleRenderer.ts #8058
• packages/prepare/src/BasePrepare.ts #7805
• packages/prepare/src/CountLimiter.ts #7805
• packages/prepare/src/Prepare.ts #7805
• packages/prepare/src/TimeLimiter.ts #8010
• packages/runner/src/Runner.ts #7811
• packages/sprite/src/Sprite.ts #7841
• packages/sprite-animated/src/AnimatedSprite.ts #7909
• packages/sprite-tiling/src/TilingSprite.ts #7806
• packages/sprite-tiling/src/TilingSpriteRenderer.ts #7806
• packages/spritesheet/src/Spritesheet.ts #7906
• packages/spritesheet/src/SpritesheetLoader.ts #7907
• packages/text/src/Text.ts #7842
• packages/text/src/TextMetrics.ts #7842
• packages/text/src/TextStyle.ts #7843
• packages/text-bitmap/src/BitmapFont.ts #7908
• packages/text-bitmap/src/BitmapFontData.ts #8009
• packages/text-bitmap/src/BitmapFontLoader.ts #8009
• packages/text-bitmap/src/BitmapText.ts #8009
• packages/text-bitmap/src/formats/TextFormat.ts #8009
• packages/text-bitmap/src/formats/XMLFormat.ts #8009
• packages/text-bitmap/src/formats/XMLStringFormat.ts #8009
• packages/ticker/src/Ticker.ts - In Progress #7199
• packages/ticker/src/TickerListener.ts - In Progress #7199
• packages/ticker/src/TickerPlugin.ts #7160
• packages/utils/src/media/CanvasRenderTarget.ts - In Progress #7199

[bigtimebuddy]

Little over a year to complete this task. Great work @ShukantPal and deep thanks for all your work in making this happen.

[ShukantPal]

Type inference is for primitives only right now.