RDoc templates...

Discussion in 'Ruby' started by Greg McIntyre, Sep 10, 2003.

  1. Yesterday I tried to write a new RDoc template which did the following:

    - Instead of listing attributes, listed the equivalent accessor and
    setter methods. i.e. A.x and A.x= instead of listing x [RW]. This is
    because I'm a fan of the Uniform Access Principle...

    - Have short descriptions ala Javadoc. That is, at the top of the class
    description have a list of its members (as links) each with a 1 line
    description (up to and including the first period'.' in the comment)
    to its left which leads to a longer description if available.

    And it was pretty much impossible! :(

    So I got my text editor out and in a glorious bout of top-down design I
    bashed out what I'd _like_ to have to write for an RDoc template. As it
    turns out, what I ended up was kind of like the Builder design pattern,
    and I was writing a ConcreteBuilder (with only one method in the Builder
    interface so far!). So anyway, I thought I'd post it here and see what
    people thought, if they liked it, etc. 'Cause I like RDoc from the
    source code end of the stick but it could be more versatile in the
    middle and pretty on the other end of the stick... And if Dave likes
    this I may get more into RDoc development (perhaps as a case study of
    refactoring for my own sake?).

    Anyway! I put it here for easy viewing and to avoid email mangling:

    http://members.optushome.com.au/puyo/htmloutputter.rb

    --
    Greg McIntyre ======[ ]===[ http://puyo.cjb.net ]===
     
    Greg McIntyre, Sep 10, 2003
    #1
    1. Advertisements

Want to reply to this thread or ask your own question?

It takes just 2 minutes to sign up (and it's free!). Just click the sign up button to choose a username and then you can ask your own questions on the forum.
Similar Threads
  1. JKop
    Replies:
    3
    Views:
    690
  2. recover
    Replies:
    2
    Views:
    1,067
    recover
    Jul 25, 2006
  3. Andreas Schwarz
    Replies:
    6
    Views:
    500
    Randy W. Sims
    Jan 1, 2004
  4. Brian Schröder
    Replies:
    5
    Views:
    316
    Dave Thomas
    Sep 18, 2004
  5. Daniel Berger
    Replies:
    1
    Views:
    262
    Dave Thomas
    Nov 2, 2004
  6. Iwan van der Kleyn

    rdoc: how to add readme.rdoc as index.html?

    Iwan van der Kleyn, Apr 26, 2005, in forum: Ruby
    Replies:
    1
    Views:
    351
    Stefan Lang
    Apr 26, 2005
  7. Paul Van Delst

    How to use rdoc parsers outside of rdoc?

    Paul Van Delst, Jul 27, 2006, in forum: Ruby
    Replies:
    0
    Views:
    211
    Paul Van Delst
    Jul 27, 2006
  8. Jesper Rønn-Jensen
    Replies:
    4
    Views:
    328
    Joel VanderWerf
    Feb 22, 2008
Loading...