Permalink
Browse files

trying to fix formatting

  • Loading branch information...
1 parent 8fc21db commit 3c443809f575f25a2d33f4beb0b09752c9344036 @dtan dtan committed Jun 10, 2011
Showing with 13 additions and 12 deletions.
  1. +13 −12 README.md
View
@@ -57,16 +57,16 @@ YUIDoc original Python build - http://developer.yahoo.com/yui/yuidoc/
- **for**: Used to define an inner class:
/**
- * An inner class
- * @class foo
- * @for OuterClass
- */
+ \* An inner class
+ \* @class foo
+ \* @for OuterClass
+ \*/
After the class is done, you need to inform the parser to start working on the outer class again:
/**
- * Another method for the outer class
- * @method bar
- * @for OuterClass
- */
+ \* Another method for the outer class
+ \* @method bar
+ \* @for OuterClass
+ \*/
- **type**: For properties, configs and attributes.
- **private**: Privates by default are suppressed from the API docs. All methods and properties are assumed to be public unless marked as private.
@@ -76,11 +76,12 @@ YUIDoc original Python build - http://developer.yahoo.com/yui/yuidoc/
- **uses**: For classes that use YAHOO.lang.augmentProto or YAHOO.lang.augmentObject. Optional method/properties (supplied to augmentProto or augmentObject) are not parsed by YUI Doc.
Example:
+
/**
- * My method description. Like other pieces of your comment blocks,
- * this can span multiple lines.
- * @method methodName
- */
+ \* My method description. Like other pieces of your comment blocks,
+ \* this can span multiple lines.
+ \* @method methodName
+ \*/
## Dav's Thoughts:

0 comments on commit 3c44380

Please sign in to comment.