#306 (all)
JavaScript (change)
18 seconds
18 days 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
Quaternion#set in /src/serialize/Quaternion.js N
A
ThreeVector#set in /src/serialize/ThreeVector.js Ne
A
areObjectsColliding in /src/physics/SimplePhysics/HSHGCollisionDetection.js Ne
A
GameEngine#step in /src/GameEngine.js Ne
A
Renderer#draw in /src/render/Renderer.js Ne
Show 101 more ...
Proper documentation present
B
SimplePhysicsEngine#objectStep in /src/physics/SimplePhysicsEngine.js Ne
B
ClientEngine#step in /src/ClientEngine.js Ne
B
checkPair in /src/physics/SimplePhysics/BruteCollisionDetection.js Ne
B
CannonPhysicsEngine#step in /src/physics/CannonPhysicsEngine.js E
B
SimplePhysicsEngine#step in /src/physics/SimplePhysicsEngine.js E
Show 41 more ...
Please take a look
Undocumented
U
CannonPhysicsEngine#addBox in /src/physics/CannonPhysicsEngine.js Ne
U
Grid#toHash in /src/physics/SimplePhysics/HSHG.js Ne
U
AFrameRenderer#tick in /src/render/AFrameRenderer.js Ne
U
arrayBuffersEqual in /src/lib/Utils.js Ne
U
KeyboardControls#onKeyChange in /src/controls/KeyboardControls.js E
Show 76 more ...

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

This page is for lance-gg/lance 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! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

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.