Skip to content

Commit f043429

Browse files
committed
Documented the big 0.6 release.
1 parent 2defe51 commit f043429

File tree

1 file changed

+32
-4
lines changed

1 file changed

+32
-4
lines changed

README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ it would like that you wrote comments like that instead:
5454
/**
5555
* Basic text field. Can be used as a direct replacement for traditional
5656
* text inputs, or as the base class for more sophisticated input controls
57-
* (like {@link Ext.form.TextArea} and {@link Ext.form.ComboBox}).
57+
* (like Ext.form.TextArea and Ext.form.ComboBox).
5858
*
5959
* Validation
6060
* ----------
@@ -141,10 +141,10 @@ Here's how the resulting documentation will look (ExtJS 3.3.1):
141141
* [JsDuck generated documentation](http://triin.net/temp/jsduck/)
142142
* [Official ExtJS documentation](http://dev.sencha.com/deploy/dev/docs/) (for comparison)
143143

144-
Here's the same for ExtJS 4 Preview 5:
144+
Here's the same for ExtJS 4:
145145

146146
* [JsDuck generated documentation](http://triin.net/temp/jsduck4/)
147-
* [Official ExtJS documentation](http://dev.sencha.com/deploy/ext-4.0-pr5/docs/) (for comparison)
147+
* [Official ExtJS documentation](http://docs.sencha.com/ext-js/4-0/api) (for comparison)
148148

149149

150150
Documentation
@@ -197,12 +197,40 @@ Copying
197197
JsDuck is distributed under the terms of the GNU General Public License version 3.
198198

199199
JsDuck was developed by [Rene Saarsoo](http://triin.net),
200-
with contributions from [Ondřej Jirman](https://github.com/megous).
200+
with contributions from [Ondřej Jirman](https://github.com/megous)
201+
and [Nick Poulden](https://github.com/nick).
201202

202203

203204
Changelog
204205
---------
205206

207+
* 0.6 - JsDuck is now used for creating the official ExtJS4 documentation.
208+
* Automatic linking of class names found in comments. Instead of writing
209+
`{@link Ext.Panel}` one can simply write `Ext.Panel` and link will be
210+
automatically created.
211+
* In generated docs, method return types and parameter types are also
212+
automatically linked to classes if such class is included to docs.
213+
* Support for `{@img}` tag for including images to documentation.
214+
The markup created by `{@link}` and `{@img}` tags can now be customized using
215+
the --img and --link command line options to supply HTML templates.
216+
* Links to source code are no more simply links to line numbers.
217+
Instead the source code files will contain ID-s like `MyClass-cfg-style`.
218+
* New tags: `@docauthor`, `@alternateClassName`, `@mixins`.
219+
The latter two Ext4 class properties are both detected from code and
220+
can also be defined (or overriden) in doc-comments.
221+
* Global methods are now placed to separate "global" class.
222+
Creation of this can be turned off using `--ignore-global`.
223+
* Much improved search feature.
224+
Search results are now ordered so that best matches are at the top.
225+
No more is there a select-box to match at beginning/middle/end -
226+
we automatically search first by exact match, then beginning and
227+
finally by middle. Additionally the search no more lists a lot of
228+
duplicates - only the class that defines a method is listed, ignoring
229+
all the classes that inherit it.
230+
* Support for doc-comments in [SASS](http://sass-lang.com/) .scss files:
231+
For now, it's possible to document SASS variables and mixins.
232+
* Several bug fixes.
233+
206234
* 0.5 - Search and export
207235
* Search from the actually generated docs (not through sencha.com)
208236
* JSON export with --json switch.

0 commit comments

Comments
 (0)