Permalink
Browse files

trying to fix formatting

  • Loading branch information...
1 parent 3c44380 commit 29e1f73b252ee3736e1d9c3032292c48b368e402 @dtan dtan committed Jun 10, 2011
Showing with 16 additions and 14 deletions.
  1. +16 −14 README.md
View
30 README.md
@@ -57,16 +57,18 @@ YUIDoc original Python build - http://developer.yahoo.com/yui/yuidoc/
- **for**: Used to define an inner class:
/**
- \* 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
- \*/
+ * 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
+ */
- **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.
@@ -78,10 +80,10 @@ YUIDoc original Python build - http://developer.yahoo.com/yui/yuidoc/
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 29e1f73

Please sign in to comment.