Skip to content
This repository
Browse code

trying to fix formatting

  • Loading branch information...
commit 29e1f73b252ee3736e1d9c3032292c48b368e402 1 parent 3c44380
dtan dtan authored

Showing 1 changed file with 16 additions and 14 deletions. Show diff stats Hide diff stats

  1. +16 14 README.md
30 README.md
Source Rendered
@@ -57,16 +57,18 @@ YUIDoc original Python build - http://developer.yahoo.com/yui/yuidoc/
57 57 - **for**: Used to define an inner class:
58 58
59 59 /**
60   - \* An inner class
61   - \* @class foo
62   - \* @for OuterClass
63   - \*/
64   - After the class is done, you need to inform the parser to start working on the outer class again:
65   - /**
66   - \* Another method for the outer class
67   - \* @method bar
68   - \* @for OuterClass
69   - \*/
  60 + * An inner class
  61 + * @class foo
  62 + * @for OuterClass
  63 + */
  64 +
  65 +After the class is done, you need to inform the parser to start working on the outer class again:
  66 +
  67 + /**
  68 + * Another method for the outer class
  69 + * @method bar
  70 + * @for OuterClass
  71 + */
70 72
71 73 - **type**: For properties, configs and attributes.
72 74 - **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/
78 80 Example:
79 81
80 82 /**
81   - \* My method description. Like other pieces of your comment blocks,
82   - \* this can span multiple lines.
83   - \* @method methodName
84   - \*/
  83 + * My method description. Like other pieces of your comment blocks,
  84 + * this can span multiple lines.
  85 + * @method methodName
  86 + */
85 87
86 88 ## Dav's Thoughts:
87 89

0 comments on commit 29e1f73

Please sign in to comment.
Something went wrong with that request. Please try again.