Skip to content

Commit

Permalink
Adding (thin) details about @param formatting
Browse files Browse the repository at this point in the history
@param {Type} name description
@param {Type} [name] description (optional)
@param {Type} name* description (1..n)
@param {Type} [name*] description (0..n)
  • Loading branch information
lsmith committed Aug 29, 2011
1 parent 266853e commit cb5439f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[yui-customevents]: http://developer.yahoo.com/yui/event/#customevent
[yui-customevents]: http://yuilibrary.com/yui/docs/event-custom/
[yui-element]: http://developer.yahoo.com/yui/element/

# YUIDoc Doc parser
Expand Down Expand Up @@ -56,7 +56,7 @@ YUIDoc original Python build - http://developer.yahoo.com/yui/yuidoc/
- **constructor**: The presence of this tag (which requires no description) indicates that this class is instantiable.
- **static**: If a class does not have a constructor, then the static tag should be present to signal that it is a static class.
- **final**: For constants and for read-only configs and attributes.
- **param**: Defined as @param {type} name description or @param name {type} description, params can be used with classes, methods and events.
- **param**: Defined as @param {type} name description or @param name {type} description, params can be used with classes, methods and events. Use [name] to indicate the param is optional, name* to indicate it is a place holder for 1..n arguments, and [name*] for 0..n arguments.
- **return**: Defined as @return {type} description.
- **for**:

Expand Down

0 comments on commit cb5439f

Please sign in to comment.