Loading README.md +32 −4 Original line number Diff line number Diff line Loading @@ -54,7 +54,7 @@ it would like that you wrote comments like that instead: /** * Basic text field. Can be used as a direct replacement for traditional * text inputs, or as the base class for more sophisticated input controls * (like {@link Ext.form.TextArea} and {@link Ext.form.ComboBox}). * (like Ext.form.TextArea and Ext.form.ComboBox). * * Validation * ---------- Loading Loading @@ -141,10 +141,10 @@ Here's how the resulting documentation will look (ExtJS 3.3.1): * [JsDuck generated documentation](http://triin.net/temp/jsduck/) * [Official ExtJS documentation](http://dev.sencha.com/deploy/dev/docs/) (for comparison) Here's the same for ExtJS 4 Preview 5: Here's the same for ExtJS 4: * [JsDuck generated documentation](http://triin.net/temp/jsduck4/) * [Official ExtJS documentation](http://dev.sencha.com/deploy/ext-4.0-pr5/docs/) (for comparison) * [Official ExtJS documentation](http://docs.sencha.com/ext-js/4-0/api) (for comparison) Documentation Loading Loading @@ -197,12 +197,40 @@ Copying JsDuck is distributed under the terms of the GNU General Public License version 3. JsDuck was developed by [Rene Saarsoo](http://triin.net), with contributions from [Ondřej Jirman](https://github.com/megous). with contributions from [Ondřej Jirman](https://github.com/megous) and [Nick Poulden](https://github.com/nick). Changelog --------- * 0.6 - JsDuck is now used for creating the official ExtJS4 documentation. * Automatic linking of class names found in comments. Instead of writing `{@link Ext.Panel}` one can simply write `Ext.Panel` and link will be automatically created. * In generated docs, method return types and parameter types are also automatically linked to classes if such class is included to docs. * Support for `{@img}` tag for including images to documentation. The markup created by `{@link}` and `{@img}` tags can now be customized using the --img and --link command line options to supply HTML templates. * Links to source code are no more simply links to line numbers. Instead the source code files will contain ID-s like `MyClass-cfg-style`. * New tags: `@docauthor`, `@alternateClassName`, `@mixins`. The latter two Ext4 class properties are both detected from code and can also be defined (or overriden) in doc-comments. * Global methods are now placed to separate "global" class. Creation of this can be turned off using `--ignore-global`. * Much improved search feature. Search results are now ordered so that best matches are at the top. No more is there a select-box to match at beginning/middle/end - we automatically search first by exact match, then beginning and finally by middle. Additionally the search no more lists a lot of duplicates - only the class that defines a method is listed, ignoring all the classes that inherit it. * Support for doc-comments in [SASS](http://sass-lang.com/) .scss files: For now, it's possible to document SASS variables and mixins. * Several bug fixes. * 0.5 - Search and export * Search from the actually generated docs (not through sencha.com) * JSON export with --json switch. Loading Loading
README.md +32 −4 Original line number Diff line number Diff line Loading @@ -54,7 +54,7 @@ it would like that you wrote comments like that instead: /** * Basic text field. Can be used as a direct replacement for traditional * text inputs, or as the base class for more sophisticated input controls * (like {@link Ext.form.TextArea} and {@link Ext.form.ComboBox}). * (like Ext.form.TextArea and Ext.form.ComboBox). * * Validation * ---------- Loading Loading @@ -141,10 +141,10 @@ Here's how the resulting documentation will look (ExtJS 3.3.1): * [JsDuck generated documentation](http://triin.net/temp/jsduck/) * [Official ExtJS documentation](http://dev.sencha.com/deploy/dev/docs/) (for comparison) Here's the same for ExtJS 4 Preview 5: Here's the same for ExtJS 4: * [JsDuck generated documentation](http://triin.net/temp/jsduck4/) * [Official ExtJS documentation](http://dev.sencha.com/deploy/ext-4.0-pr5/docs/) (for comparison) * [Official ExtJS documentation](http://docs.sencha.com/ext-js/4-0/api) (for comparison) Documentation Loading Loading @@ -197,12 +197,40 @@ Copying JsDuck is distributed under the terms of the GNU General Public License version 3. JsDuck was developed by [Rene Saarsoo](http://triin.net), with contributions from [Ondřej Jirman](https://github.com/megous). with contributions from [Ondřej Jirman](https://github.com/megous) and [Nick Poulden](https://github.com/nick). Changelog --------- * 0.6 - JsDuck is now used for creating the official ExtJS4 documentation. * Automatic linking of class names found in comments. Instead of writing `{@link Ext.Panel}` one can simply write `Ext.Panel` and link will be automatically created. * In generated docs, method return types and parameter types are also automatically linked to classes if such class is included to docs. * Support for `{@img}` tag for including images to documentation. The markup created by `{@link}` and `{@img}` tags can now be customized using the --img and --link command line options to supply HTML templates. * Links to source code are no more simply links to line numbers. Instead the source code files will contain ID-s like `MyClass-cfg-style`. * New tags: `@docauthor`, `@alternateClassName`, `@mixins`. The latter two Ext4 class properties are both detected from code and can also be defined (or overriden) in doc-comments. * Global methods are now placed to separate "global" class. Creation of this can be turned off using `--ignore-global`. * Much improved search feature. Search results are now ordered so that best matches are at the top. No more is there a select-box to match at beginning/middle/end - we automatically search first by exact match, then beginning and finally by middle. Additionally the search no more lists a lot of duplicates - only the class that defines a method is listed, ignoring all the classes that inherit it. * Support for doc-comments in [SASS](http://sass-lang.com/) .scss files: For now, it's possible to document SASS variables and mixins. * Several bug fixes. * 0.5 - Search and export * Search from the actually generated docs (not through sencha.com) * JSON export with --json switch. Loading