[rdoc] file vs. class comments

[Michael Neumann]

Hi,

If I've following file test.rb:

# this is my class
class MyClass
...
end

# other class
class OtherClass
end

and run rdoc over it, the comment for MyClass is also the comment for
the test.rb file. I'd like more if there were in this case no comment
for test.rb, or better, if the classes defined in this file were listed.

To document test.rb, you'd have to write:

# documentation
# for test.rb


# this is my class
class MyClass
...


Regards,

Michael

 

[Brian Schröder]

Hi,

If I've following file test.rb:

# this is my class
class MyClass
...
end

# other class
class OtherClass
end

and run rdoc over it, the comment for MyClass is also the comment for
the test.rb file. I'd like more if there were in this case no comment
for test.rb, or better, if the classes defined in this file were listed.

To document test.rb, you'd have to write:

# documentation
# for test.rb


# this is my class
class MyClass
...

I'd think that it would be enough to include one line in the beginning of the
file to inhibit the comment.

#

# this is my class
class MyClass..


Regards,

Brian