Posted By

noah on 12/24/08


Tagged

format template ruby document documentation rdoc


Versions (?)

Who likes this?

2 people have marked this snippet as a favorite

inkdeep
webstic


RDoc format example


 / Published in: Ruby
 

This is a boilerplate RDoc template which I paste into new Ruby files that I create. It demonstrates some of the features of RDoc markup, such as links and comments (The 'this code is proprietary' message is commented out in favor of the MIT license)

The title directive will not work in plain text files, due to a bug in RDoc

  1. # :title:A Shell Script
  2. # = Name
  3. #
  4. # = Synopsis
  5. #
  6. # = Description
  7. #
  8. # = Todo
  9. # == Upcoming Features
  10. # 0. Nothing yet.
  11. # == Known Issues
  12. # 0. Nothing yet.
  13. # = References
  14. # 0. <i>I made it up as I went along.</i>
  15. # = License
  16. # This code is provided under the terms of the {MIT License.}[http://www.opensource.org/licenses/mit-license.php]
  17. #
  18. #--
  19. # This code is the proprietary intellectual property of its authors. It is not intended for publication.
  20. #++
  21. # = Authors
  22. # Noah Sussman
  23. #

Report this snippet  

You need to login to post a comment.