Page 1 of 1

Make Documentation compatible with ext-doc

Posted: Wed Nov 25, 2009 1:05 pm
by crp_spaeth
Hey Eric, I just found a small issue in the Processing logic of your Documentation parser...

In Extjs the documentation is build up in the following way:

/**
* @class classname
* @extends superclassname
* CLASS Description goes here
* @config
* @singleton
*/

your parser seems to consume the following format:

/**
* CLASS Description goes here
* @class classname
* @extends superclassname
* @config
* @singleton
*/

The documentation still works here but its kind of ugly since the class documentation will stand next to @extend.

Since I am using ext-doc (opensource Project) which also consumes the "Ext standard" its kinde of odd to have different documentation formats...

Would be nice if you could take a look...

best regards martin

Posted: Thu Nov 26, 2009 2:25 am
by eric_suen
The format of JSDoc is like:

Descriptions

@tag content
@tag content
...

both description and content may be single or multi line, obviously the doc in Ext is not in standard format.