From: Nikolai Weibull <mailing-lists.ruby-talk@...>
Date: 2005-03-17T22:46:21+09:00
Subject: Suggestions for RDoc

I have two suggestions for RDoc fixes:

1.  Object#[] doesn't get documented, at least not in C sources.

2.  Could the parser perhaps drop folding-markers from the source?  An
    example comment with a folding-marker would be:

    /* {{{1
     * 
     * call-seq:
     * 		...
     */

    The documentation looks rediculous when these are included.  A
    solutions is to separate the marker from the documentation:

    /* {{{1 */
    /*
     * call-seq:
     *		...
     */

    but it still seems, to me, that RDoc could take care of removing
    them.
    
    A regex to match folding-markers with could be expressed like:

    /(?:{{{|}}})\d*/

    It's pretty standard.

Perhaps a good solution to #2 is to allow project-specific inclusions of
parsers.  What do you think?,
	nikolai

-- 
::: name: Nikolai Weibull    :: aliases: pcp / lone-star / aka :::
::: born: Chicago, IL USA    :: loc atm: Gothenburg, Sweden    :::
::: page: www.pcppopper.org  :: fun atm: gf,lps,ruby,lisp,war3 :::
main(){printf(&linux["\021%six\012\0"],(linux)["have"]+"fun"-97);}