Sign in to follow this  
Deltakosh

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 ;)

image.png

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

Share this post


Link to post
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.

Share this post


Link to post
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.

Share this post


Link to post
Share on other sites
1 hour ago, Deltakosh said:

So my recommendation is to NOT end line with a period

For consistency have removed full stops at ends of line in examples in "contribute to api docs". Too big a job though to do it in src in babylonjs

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
Sign in to follow this  

  • Recently Browsing   0 members

    No registered users viewing this page.