Rdoc constants annoyances...

A

Austin Ziegler

I'm wondering if others are experiencing these and if you've found a
way around it.

1. Constants that are defined in different branches are repeated:

module Foo
if RUBY_PLATFORM =~ /win32/
BAR = 'win32'
else
BAR = 'other'
end
end

This will result in two copies of Foo::BAR being documented
*separately* (that is, separate lines in the rdoc generated HTML). I
want them merged. Optionally, I want to have a single documented
version and suppress the documentation of the rest.

2. Constant values are displayed, resulting in garbage. I have a large
hash presented as a constant. I want a document comment for the
constant, but I don't want the values presented in the document. It
takes up a lot of space, and I can present it far better than rdoc's
automated form could ever do. How do I suppress the constant value
printing?

-austin
 

Ask a Question

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

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

Forum statistics

Threads
473,744
Messages
2,569,484
Members
44,903
Latest member
orderPeak8CBDGummies

Latest Threads

Top