How to wrap code examples in comments

Ruby
1

Hi guys,
I tried to post this in [email protected] but nobody seems to be
there.
I’m new on documenting Ruby sources, I have some early opinions about
RDoc but this time and want to ask you something.
I tried to wrap code examples in comments using the following:

def setUp

files << File.new()

end

But it doesn’t work, it generates an ugly HTML like
def setUp

@appStates << AppState1.new()

end

What am I missing here?

Thanks,
Ubaldo

2

I found the answer by accident, just adding extra spaces at the begin
of comment line, but now I have another question, I’m trying to place
a labeled list in two lines like:

objInputData:: Optional. The input data required by the logic defined

in

derived classes. It’s commonly a hash map. Set

to nil by default.

Line two HTML is generated in typewriter mode. How could build a
labeled list using multiple lines? Is there a nice site to find more
information about RDoc? RDoc Documentation
seems to be insufficient.

Thanks a lot.

3

I found the answer again, wow this list works great. Just adding or
removing spaces from the second line until RDoc generated the proper
HTML, this is a try-and-error process:

objInputData:: Optional. The input data sent by the testcase caller

and available to be used by the logic defined in

derived testcases. It’s commonly a hash map. Set to

nil by default.

I’m impressed, RDoc is absolutely intuitive and well programmed.