RDoc Metrics

Discussion in 'Ruby' started by Tony Arcieri, Jul 7, 2009.

  1. Tony Arcieri

    Tony Arcieri Guest

    [Note: parts of this message were removed to make it a legal post.]

    Does there exist a tool for providing basic metrics about the quality of the
    RDoc for a given package?

    I'd like to be able to get a list of all undocumented classes/methods, and
    possibly things like a percentage breakdown of how well methods in
    particular classes are documented. Lovely HTML reports for this sort of
    thing would rule! I'm thinking of something like RCov for the quality of
    our RDoc, if that makes any sense.

    Anything I should be looking at in this regard?

    --
    Tony Arcieri
    medioh.com
    Tony Arcieri, Jul 7, 2009
    #1
    1. Advertising

  2. On Tue, Jul 7, 2009 at 4:15 PM, Tony Arcieri<> wrote:
    > Does there exist a tool for providing basic metrics about the quality of =

    the
    > RDoc for a given package?
    >
    > I'd like to be able to get a list of all undocumented classes/methods, an=

    d
    > possibly things like a percentage breakdown of how well methods in
    > particular classes are documented. =C2=A0Lovely HTML reports for this sor=

    t of
    > thing would rule! =C2=A0I'm thinking of something like RCov for the quali=

    ty of
    > our RDoc, if that makes any sense.
    >
    > Anything I should be looking at in this regard?
    >


    http://dcov.rubyforge.org/ might be what you're looking for.

    Best,
    Michael Guterl
    Michael Guterl, Jul 7, 2009
    #2
    1. Advertising

  3. Tony Arcieri

    Tony Arcieri Guest

    [Note: parts of this message were removed to make it a legal post.]

    On Tue, Jul 7, 2009 at 2:33 PM, Michael Guterl <> wrote:

    > http://dcov.rubyforge.org/ might be what you're looking for.
    >


    Excellent! That looks rather promising. I'll check it out.

    --
    Tony Arcieri
    medioh.com
    Tony Arcieri, Jul 7, 2009
    #3
  4. Tony Arcieri

    Roger Pack Guest

    Roger Pack, Jul 7, 2009
    #4
    1. Advertising

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. lucy
    Replies:
    5
    Views:
    2,184
    Keith Wansbrough
    Aug 4, 2004
  2. Andreas Schwarz
    Replies:
    6
    Views:
    242
    Randy W. Sims
    Jan 1, 2004
  3. Brian Schröder
    Replies:
    5
    Views:
    128
    Dave Thomas
    Sep 18, 2004
  4. Daniel Berger
    Replies:
    1
    Views:
    138
    Dave Thomas
    Nov 2, 2004
  5. 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:
    219
    Stefan Lang
    Apr 26, 2005
Loading...

Share This Page