config options

6 views
Skip to first unread message

Arthur K

unread,
Jun 29, 2009, 5:45:21 PM6/29/09
to ext-doc
I'm noticing that ext-doc does a wonderful job of formatting my
documentation... but is there a way to get a "Config Options" section,
like how the ExtJS docs have it? If it's already part of the tool, can
someone give me an example of how to document that for my classes?

Thanks!

oxymoron

unread,
Jun 29, 2009, 8:32:52 PM6/29/09
to ext-doc
To document Config Options use @cfg tag:

/**
* @cfg {String} myConfig The description of my config option.
*/

format:

@cfg {<TYPE>} <NAME> <DESCRIPTION>
Reply all
Reply to author
Forward
0 new messages