From: Hugh Sasse <hgs@...>
Date: 2008-11-14T02:39:52+09:00
Subject: Re: Getting the comments(RDoc/ri) while running



On Fri, 14 Nov 2008, Vassilis Rizopoulos wrote:

> OK, just to clarify a bit:
> I use these methods in my app and they add functionality that needs specific
> parameters and configuration. It's an exte. The parameters are described in
> the comments for the methods.
> Now, I want to be able (from within my app) to display the documentation for
> those methods. I can do it by calling `ri method_name` and grabbind the output
> but I was wondering if there is a cleverer way (and one that does not require
> ri to be in the path)
> Cheers,
> V.-

ri gets docs built with rdoc. When you build those docs with rdoc, do 
you get better results with -p?


RDoc V1.0.1 - 20041108

Usage:

  rdoc [options]  [names...]
        [...]
Options:
        [...]
   --promiscuous, -p        When documenting a file that contains a module
                            or class also defined in other files, show
                            all stuff for that module/class in each files
                            page. By default, only show stuff defined in
                            that particular file.

        Hugh