On Jan 6, 2004, at 23:56, GGarramuno wrote: > 1) Is there any document describing the syntax and rules that rdoc > uses? The README that comes with it has a fair amount of information. Anything else, just ask. > > 2) Is it possible to place the rdoc documentation at the end of the > file (after __END__) as in perl? This is for two reasons: a) speed up > ruby's compilation of it by not having it parse useless docs and b) > helping the programmer not be swamped when docs are several pages > long. > Not really, because a lot of the motivation for RDoc is that it picks up information from the source as well as the comments. In fact, you can feed it a class with no documentation whatsoever and it can come back with something useful. However, you can always put your documentation in a separate file, and then either 1. Just include that file in the documentation run, or 2. use :include: <filename> to bring the documentation into the main source file Cheers Dave