- 
                Notifications
    You must be signed in to change notification settings 
- Fork 445
Open
Description
Background
I implemented a plugin system for RDoc in #1321 and YARD parsing plugin is implemented.
In the discussion with @st0012, @kou and @vinistock we decided that we should implement YARD parsing feature as a standalone feature without plugin.
The note exists in #1257 (comment)
Steps
There are some steps to have effective YARD parsing feature in RDoc.
-  Adding basic framework to support YARD style document (RDoc::Yardclass or similar)
-  Adding support of YARD tags that already works with current RDoc such as @yieldand@private-  @yield
-  @private
 
-  
-  Adding support of YARD tags that needs simple modification of RDoc such @deprecated-  Adding :deprecateddirective
-  Adding @deprecated
 
-  Adding 
-  Adding features such as type support to utilize information from YARD
-  @return
-  @param
- others (will be edited later)
 
-  
-  Adding support of YARD directives and macros
-  @!attribute
- others (will be edited later)
 
-  
I will implement these step by step.
Note
The idea of plugin system is not completely abandoned but postponed.
adam12flavorjones, olleolleolle and ybiquitous
Metadata
Metadata
Assignees
Labels
No labels