0
@@ -30,47 +30,45 @@ FEATURE LIST
0
    YARD uses a '@tag' style definition syntax for meta tags alongside  regular code

0
    documentation. These tags should be able to happily sit side by side RDoc formatted

0
    documentation, but provide a much more consistent and usable way to describe

0
-   important information about objects, such as what parameters they take and what types they are expected to be, what type a

0
-   method should return, what exceptions it can raise, if it is deprecated, etc..
0
-   It also allows information to be better (and more consistently) organized

0
-   during the output generation phase. Some of the main tags are listed below:

0
+   important information about objects, such as what parameters they take and what types
0
+   they are expected to be, what type a
method should return, what exceptions it can 
0
+   raise, if it is deprecated, etc.. It also allows information to be better (and more 
0
+   consistently) organized
during the output generation phase. Some of the main tags 
0
+   are listed below:

0
                                                                               
0
-   **Table 1. Meta-tags and their descriptions**
0
+   #### Table 1. Meta-tags and their descriptions ####
0
                                                                               
0
-   `@param [Types] name description`   
0
-     Description Allows for the definition of a method parameter with

0
-     optional type information.
0
+   ##### `@param [Types] name Description` #####
0
+     Allows for the definition of a method parameter with
optional type information.
0
                                                                               
0
-   `@yieldparam [Types] name description`   
0
-     Description Allows for the definition of a method parameter to a
0
-     yield block with optional type information.
0
+   ##### `@yieldparam [Types] name Description` #####
0
+     Allows for the definition of a method parameter to a yield block with optional
0
+     type information.
0
    
0
-   `@yield [paramnames] description`   
0
-     Allows the developer to document the purpose of a yield block in 
0
-     a method.
0
+   ##### `@yield [paramnames] Description` #####
0
+     Allows the developer to document the purpose of a yield block in a method.
0
    
0
-   `@return [Types] description`   
0
+   ##### `@return [Types] Description` #####
0
      Describes what the method returns with optional type information.
0
 
0
-   `@deprecated description`   
0
+   ##### `@deprecated Description` #####
0
      Informs the developer that a method is deprecated and should no 
0
      longer be used. The description offers the developer an alternative 
0
      solution or method for the problem.
0
                                                  
0
-   `@raise class description`   
0
-     Tells the developer that the method may raise an exception and of 
0
-     what type. 
0
+   ##### `@raise [Class] Description` #####
0
+     Tells the developer that the method may raise an exception and of what type. 
0
    
0
-   `@see name`   
0
+   ##### `@see name` #####
0
      References another object, URL, or other for extra information. 
0
 
0
-   `@since number`   
0
+   ##### `@since number` #####
0
      Lists the version number in which the object first appeared. 
0
 
0
-   `@version number`   
0
+   ##### `@version number` #####
0
      Lists the current version of the documentation for the object. 
0
 
0
-   `@author name`   
0
+   ##### `@author name` #####
0
      The authors responsible for the module
0
 
0
    You might have noticed the optional "types" declarations for certain tags.