GameMonetize Posted March 23, 2018 Share Posted March 23, 2018 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 meteoritool, unintellisense, aWeirdo and 9 others 11 1 Quote Link to comment Share on other sites More sharing options...
JohnK Posted March 27, 2018 Share Posted March 27, 2018 On 3/23/2018 at 2:10 AM, Deltakosh said: PS: We are still looking for more volunteers to help writing API code comments How you can help http://doc.babylonjs.com/how_to/contribute_to_api GameMonetize and inteja 2 Quote Link to comment Share on other sites More sharing options...
inteja Posted March 27, 2018 Share Posted March 27, 2018 Good guide, thanks @JohnK Just a few questions: Should line comments end in period or not? In your examples some do, some don't. Is it worth suggesting something like the VS Code Document This extension to make things quicker? Quote Link to comment Share on other sites More sharing options...
JohnK Posted March 27, 2018 Share Posted March 27, 2018 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. Quote Link to comment Share on other sites More sharing options...
JohnK Posted March 28, 2018 Share Posted March 28, 2018 Had a look at `VS Code Document This` unfortunately I don't think it will be of benefit because: It only work on one entity ( class, enum etc) at a time; If there is not a space above the entity section it wipes out part of previous line; It puts in @words that are not used by the documentation generator; You (of course) still have to put in the descriptive comments. Quote Link to comment Share on other sites More sharing options...
Guest Posted March 28, 2018 Share Posted March 28, 2018 So my recommendation is to NOT end line with a period Quote Link to comment Share on other sites More sharing options...
JohnK Posted March 28, 2018 Share Posted March 28, 2018 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 GameMonetize 1 Quote Link to comment Share on other sites More sharing options...
Guest Posted March 28, 2018 Share Posted March 28, 2018 Just commented the entire Engine class (did Scene yesterday)....Let's keep the fight V!nc3r and Wingnut 2 Quote Link to comment Share on other sites More sharing options...
Recommended Posts
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.