Jump to content

New Class API documentation


Recommended Posts

Hello team!

I'm thrilled to announce that the new API doc is online. It is still beta so please report here any issue you may find.

We moved to Typedoc to generate our doc in order to get:

- Better readibility

- Better Typescript support

- More flexibility

You can find it here: http://doc.babylonjs.com/api.html

Have fun reading the doc ;)


PS: We are still looking for more volunteers to help writing API code comments ;)

Link to comment
Share on other sites

2 hours ago, inteja said:

Should line comments end in period or not? In your examples some do, some don't.

Examples were existing and from different authors though you are right and consistency is good. 


2 hours ago, inteja said:

Is it worth suggesting something like the VS Code Document This extension to make things quicker?

Defnitely worth a look. Will give it a go soon. Could make a lot of difference to getting more pages done.

Link to comment
Share on other sites

Had a look at `VS Code Document This` unfortunately I don't think it will be of benefit because:

  1. It only work on one entity ( class, enum etc) at a time;
  2. If there is not a space above the entity section it wipes out part of previous line;
  3. It puts in @words that are not used by the documentation generator;
  4.  You (of course) still have to put in the descriptive comments.
Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Create New...