GoodBoyDigital/pixi.js Pixi.js

Super fast HTML 5 2D rendering engine that uses webGL wit...

#142 (all)
JavaScript (change)
20 seconds
about 1 hour ago

This page shows an evaluation of the project's documentation.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

JavaScript support is still young. Please report any mistakes Inch makes!
Seems really good
A
PIXI.Graphics#arcTo in /src/core/graphics/Graphics.js N
A
PIXI.interaction.InteractionManager#mapPositionToPoint in /src/interaction/InteractionManager.js Ne
A
PIXI.extras.TilingSprite#setTransform in /src/core/display/DisplayObject.js Ne
A
PIXI.extras.BitmapText#setTransform in /src/core/display/DisplayObject.js Ne
A
PIXI.ParticleContainer#setTransform in /src/core/display/DisplayObject.js Ne
Show 580 more ...
Proper documentation present
B
PIXI.Matrix#set in /src/core/math/Matrix.js N
B
PIXI.CanvasRenderer#resize in /src/core/renderers/canvas/CanvasRenderer.js Ne
B
PIXI.Matrix#translate in /src/core/math/Matrix.js Ne
B
PIXI.Point#set in /src/core/math/Point.js Ne
B
PIXI.extras.TilingSprite#swapChildren in /src/core/display/Container.js E
Show 121 more ...
Please take a look
Undocumented
U
PIXI.loaders.Loader.addPixiMiddleware in /src/loaders/loader.js E
U
signum in /src/core/math/GroupD8.js E
U
PIXI.interaction.InteractionManager#eventData.stopPropagation in /src/interaction/InteractionManager.js E
U
PIXI.filters.TiltShiftAxisFilter#gradientBlur.set in /src/filters/tiltshift/TiltShiftAxisFilter.js E
U
PIXI.filters.TiltShiftAxisFilter#gradientBlur.get in /src/filters/tiltshift/TiltShiftAxisFilter.js E
Show 208 more ...

Let's raise the visibility of documentation in Open Source!

This page is for GoodBoyDigital/pixi.js and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.