Allow Aggregating Data From Multiple Sources about rdoc HOT 7 CLOSED

I think the best way to accomplish this would be through a parser for spec files. https://github.com/rdoc/rdoc-rake is a parser for rake files that you could use as an example.

Instead of creating new classes to contain spec data the parser would look up the corresponding class and add the "Spec:" section to the existing comment.

This may require some changes to rdoc to ensure that the spec parser runs after other directories are parsed, but I would be happy to assist with those.

from rdoc.

Hey thanks, it was the bit around ensuring rdoc runs the spec parsing after the other directories were parsed where I thought I'd need help since I think rdoc tends to replace comments instead of append to them (?).

from rdoc.

The ruby parser overwrites method comments but not class comments. Usually classes and modules are extended through reopening but defining a method twice for the same class is not a good idea. Try running rdoc on this example:

# class comment 1
class C
  # method comment 1
  def m
  end
end

# class comment 2
class C
  # method comment 2
  def m
  end
end

If you write a custom parser for spec files this does not have to be true. You can look up a method and append to its comment instead of overwriting it just like for a class.

from rdoc.

Great, then it's just a matter of ensuring the correct ordering (ie: stdlib and then the specs).

from rdoc.

And writing a parser for specs, of course

from rdoc.

Closing this bug as I am not going to write the spec parser.

from rdoc.

No problem, thanks for the information :)

from rdoc.