search

koraktor / rubikon

A simple to use, yet powerful Ruby framework for building console-based applications.
http://koraktor.github.com/rubikon
BSD 3-Clause "New" or "Revised" License
93 stars 2 forks source link

Use YARD for documentation #5

Closed koraktor closed 14 years ago

koraktor commented 14 years ago

YARD is a much more powerful documentation tool than RDoc. So everything should be documented YARD-style.

The capability to document special DSL syntax would be great for documenting apps using Rubikon. A new gem called yard-rubikon would be the correct place for this.

koraktor commented 14 years ago

Converted documentation to YARD

Closed by 1b03f7cd6917ee9028e452ba1ae0faf45fca7f68

Additionally more instance methods of the application (i.e. DSL methods) have been made private.