From: Wybo Dekker <wybo@...4all.nl>
Date: 2012-02-21T01:22:43+09:00
Subject: Re: darkfish rdoc sees no rdoc

On 2012-02-20 15:01, David Heitzman wrote:
> I might suggest that instead of trying rdoc on your own test file, to
> instead go into a gem directory (bundler is the one I tried) and just do

The confusion is, that I am talking about a simple Ruby *application*,
not a package of classes and methods.
   I want documentation to explain what the application is good for. But
it seems that rdoc is only looking for documentation belonging to
classes and methods, and skips any other documentation.

What helps is to let the =begin rdoc ... =end block be followed by some
(empty) class definition, for example:

   =begin rdoc
   == test - This is a test
   === Description
   I'm trying to generate documentation from this file.
   =end
   class Documentation
   end

   puts "Hello World! I am an application to tell I was born."

This shows, in Documentation.html:

   class Documentation

   test - This is a test

   Description

   I�m trying to generate documentation from this file.

But, of course, for an application I don't want to see that "class
Documentation" on top.

-- 
Wybo