Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated docs

  • Loading branch information...
commit a3f3cbcce641680732c7c10fc1e671956b48eabb 1 parent b509cc8
@puzrin puzrin authored
Showing with 16 additions and 8 deletions.
  1. +8 −0 HISTORY.md
  2. +3 −2 README.md
  3. +5 −6 syntax.md
View
8 HISTORY.md
@@ -1,3 +1,11 @@
+1.0.3 / 2011-12-14
+------------------
+
+* Added events support,
+* Added nested arguments support in signatures (for callbacks & iterators)
+* Added back icons for global methods/properties
+
+
1.0.2 / 2011-12-13
------------------
View
5 README.md
@@ -9,6 +9,7 @@ but has some differences:
- Added options for `deprecated` tag: you can set versions, when tag was deprecated and
when it will be removed.
- Added new tags: `read-only`, `internal`, `chainable`
+- Events support.
## How to Install
@@ -66,9 +67,9 @@ If you like to make patches or develop skins - install NDoc in developer mode:
After installation is done you can generate prototype documentation for test:
- bin/ndoc ./tests -o ./tests/doc
+ make test
-Then open `./test/doc/index.html`. Here is [hosted doc example](http://nodeca.github.com/ndoc/tests/doc/). There are also some shortcuts in [Makefile](https://github.com/nodeca/ndoc/blob/master/Makefile),
+Then open `./test/proto-doc/index.html`. Here is [hosted doc example](http://nodeca.github.com/ndoc/tests/doc/). There are also some shortcuts in [Makefile](https://github.com/nodeca/ndoc/blob/master/Makefile),
if you make skin changes and need to constantly rebuild samples.
View
11 syntax.md
@@ -262,14 +262,12 @@ Constant must have their value specified using the equal sign (`=`).
* ...
**/
-### Events
+#### Events
-Some methods can fire native or custom events. These are indicated below the arguments descriptions:
+Events are identified by `@`:
/**
- * Ajax.Request#respondToReadyState(readyState) -> undefined
- * - readyState (Number): a number from 0 to 4 corresponding to the state of the request.
- * fires ajax:created, ajax:completed
+ * Features@head(request, socket, head)
*
* ...
**/
@@ -299,4 +297,5 @@ Difference from PDoc
1. Descriptions should be ALWAYS separated by empty line from the upper string (signature, section, tags...).
2. `deprecated` can have options.
-3. Additional tags - read-only, internal, chainable
+3. Additional tags - read-only, internal, chainable.
+4. Events support.
Please sign in to comment.
Something went wrong with that request. Please try again.