Make Documentation compatible with ext-doc

Feature requests
Post Reply
crp_spaeth
Posts: 23
Joined: Sat Jul 25, 2009 6:28 pm

Make Documentation compatible with ext-doc

Post by crp_spaeth » Wed Nov 25, 2009 1:05 pm

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

eric_suen
Site Admin
Posts: 678
Joined: Wed Sep 28, 2005 7:00 am
Contact:

Post by eric_suen » Thu Nov 26, 2009 2:25 am

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.

Post Reply

Who is online

Users browsing this forum: No registered users and 2 guests