From: Phrogz <phrogz@...>
Date: 2007-11-19T23:35:02+09:00
Subject: Re: Short introduction on how to create good source doc?

On Nov 19, 6:46 am, Joshua Muheim <fo...@josh.ch> wrote:
> I'd like to document my Ruby sources in a clean and standardized way.
> But I couldn't find a short introduction on how to do that, e.g. what
> markup tags to use  etc.? Anyone can post me a link or two?

I think I use RDoc markup well and consistently in this file:
http://phrogz.net/RubyLibs/Ouroboros.rb

which produces:
  http://phrogz.net/RubyLibs/rdoc/files/Ouroboros_rb.html
  http://phrogz.net/RubyLibs/rdoc/classes/Ouroboros.html
when run through RDoc.

Basically, if you want to document your code in a standard way, find a
file whose documentation you think is good and follow its conventions.
Just view the source of the ruby file. (Not HTML.)