Doxygen

Post your help queries and engine programming questions here

Doxygen

Postby Genestealer » Fri May 09, 2014 6:10 pm

Hello,

I have to document my program. I have to use doxygen for that.
The parser seems to parse only the variable in the document.

Exemple:

var MyClass = IgeClass.extend({
init: function() {
},
run: function(){
}
});

The doxygen will read only the variable "MyClass"
Have you any idea to make doxygen read the class with the function inside this class ?

Thank you,
Genestealer
User avatar
Genestealer
 
Posts: 5
Joined: Sun Mar 16, 2014 5:36 pm

Re: Doxygen

Postby robaldred » Fri May 09, 2014 7:45 pm

The engine is documented with JsDoc comments. You'll need to write a parser for doxygen to parse jsdoc comments.

Doxygen does not natively support JavaScript I believe there are a few scripts no idea how complete they are.

I'd suggest using jsdoc, its very easy to use.
I don't work for Irrelon. All comments are my own.
I would strongly encourage anyone building production projects with Isogenic to buy a premium licence, it costs very little and will help towards continued development of the engine. Irrelon have spent thousands of hours developing this wonderful platform with many features found in AAA game engine.
User avatar
robaldred
 
Posts: 243
Joined: Wed Oct 23, 2013 8:09 pm
Location: Manchester, England

Re: Doxygen

Postby Genestealer » Mon May 12, 2014 9:51 am

Thank you,

I'll try this
User avatar
Genestealer
 
Posts: 5
Joined: Sun Mar 16, 2014 5:36 pm


Return to Help & Questions

Who is online

Users browsing this forum: No registered users and 1 guest
cron