-
Notifications
You must be signed in to change notification settings - Fork 240
Categories
nene edited this page Aug 8, 2012
·
1 revision
By default the list of classes on the opening page if API documentation is auto-generated based on the namespaces. To have some more control use the --categories
option to specify a JSON file that defines which classes belong to which categories. The file should have the following structure:
[
{
"name": "Components",
"groups": [
{
"name": "Windows",
"classes": [
"Ext.MessageBox",
"Ext.window.*"
]
},
{
"name": "Forms",
"classes": [
"Ext.FormPanel",
"Ext.form.*"
]
},
...
]
},
...
]
You can list the classes one-by-one or use the wildcard *
to let JSDuck include all the classes matching the specified pattern.