@@ -117,30 +117,34 @@ JsDuck depends on [json][], [RDiscount][], and [parallel][] plus [RSpec][] for t
117117Usage
118118-----
119119
120- Just call it from command line with output directory and a list of
121- JavaScript files:
120+ Just call it from command line with output directory and a directory
121+ containing your JavaScript files:
122122
123- $ jsduck --verbose --output some/dir your/project/*. js
123+ $ jsduck --verbose --output some/dir your/project/js
124124
125- To specify a lot of files you should probably create a script that
126- generates a file list and passes it through ` xargs ` to ` jsduck ` .
125+ The ` --verbose ` flag creates a lot of output, but at least you will
126+ see that something is happening .
127127
128- For example to generate documentation for ExtJS:
128+ You pass in both directories and JavaScript files. For example to
129+ generate docs for ExtJS 3, the simplest way is the following:
129130
130- $ find ext-3.3.1/src/ -name '*.js' | egrep -v 'locale/|test/|adapter/' | xargs jsduck -v -o output /
131+ $ jsduck -v -o output/ ext-3.3.1/src/
131132
132- The ` --verbose ` flag creates a lot of output, but at least you will
133- see that something is happening.
133+ But this will give you a bunch of warnings, so you should better
134+ create a script that takes just the files really needed and passes
135+ them through ` xargs ` to ` jsduck ` :
136+
137+ $ find ext-3.3.1/src/ -name '*.js' | egrep -v 'locale/|test/|adapter/' | xargs jsduck -v -o output/
134138
135139Here's how the resulting documentation will look (ExtJS 3.3.1):
136140
137141* [ JsDuck generated documentation] ( http://triin.net/temp/jsduck/ )
138142* [ Official ExtJS documentation] ( http://dev.sencha.com/deploy/dev/docs/ ) (for comparison)
139143
140- Here's the same for ExtJS 4 Preview 2 :
144+ Here's the same for ExtJS 4 Preview 5 :
141145
142146* [ JsDuck generated documentation] ( http://triin.net/temp/jsduck4/ )
143- * [ Official ExtJS documentation] ( http://dev.sencha.com/deploy/ext-4.0-pr2 /docs/ ) (for comparison)
147+ * [ Official ExtJS documentation] ( http://dev.sencha.com/deploy/ext-4.0-pr5 /docs/ ) (for comparison)
144148
145149
146150Documentation
@@ -183,8 +187,6 @@ missing.
183187Missing features and TODO
184188-------------------------
185189
186- * Search, not just searching from official ExtJS documentation.
187-
188190* Support for custom @tags . Ext-doc supports this, I personally have
189191 never used this feature, so I'm thinking it's not really needed.
190192
@@ -194,12 +196,21 @@ Copying
194196
195197JsDuck is distributed under the terms of the GNU General Public License version 3.
196198
197- JsDuck was developed by [ Rene Saarsoo] ( http://triin.net ) .
199+ JsDuck was developed by [ Rene Saarsoo] ( http://triin.net ) ,
200+ with contributions from [ Ondřej Jirman] ( https://github.com/megous ) .
198201
199202
200203Changelog
201204---------
202205
206+ * 0.5 - Search and export
207+ * Search from the actually generated docs (not through sencha.com)
208+ * JSON export with --json switch.
209+ * Listing of mixed into classes.
210+ * Option to control or disable parallel processing.
211+ * Accepting directories as input (those are scanned for .js files)
212+ * Many bug fixes.
213+
203214* 0.4 - Ext4 support
204215 * Support for Ext.define() syntax from ExtJS 4.
205216 * Showing @xtype and @author information on generated pages.
0 commit comments