Asp Forum - rdoc question - comp.lang.ruby

Tim Pease

8/30/2006 4:02:00 PM

I have developed my own syntax for some validation scripts here at
work. I would like to include some examples of these validation
scripts in the RDoc documentation for the package. Is there a way to
simply include these example files "as is" without RDoc trying to
format the files?

directory structure:

ext/
bin/
lib/
test/
examples/example1.pdv
examples/example2.pdv
...

I can include example1.pdv et. al, but RDoc is stringing together
consecutive lines into one big paragraph and other things like that.
Without changing my example files, how do I tell RDoc to just put
these things inside one big code block?

TwP

2 Answers

Eric Hodel

8/31/2006 12:10:00 AM

On Aug 30, 2006, at 9:01 AM, Tim Pease wrote:

> I have developed my own syntax for some validation scripts here at
> work. I would like to include some examples of these validation
> scripts in the RDoc documentation for the package. Is there a way to
> simply include these example files "as is" without RDoc trying to
> format the files?
>
> directory structure:
>
> ext/
> bin/
> lib/
> test/
> examples/example1.pdv
> examples/example2.pdv
> ...
>
> I can include example1.pdv et. al, but RDoc is stringing together
> consecutive lines into one big paragraph and other things like that.
> Without changing my example files, how do I tell RDoc to just put
> these things inside one big code block?

I don't believe you can. :include: expects RDoc formatted text.

--
Eric Hodel - drbrain@segment7.net - http://blog.se...
This implementation is HODEL-HASH-9600 compliant

http://trackmap.rob...

Tim Pease

8/31/2006 7:40:00 PM

On 8/30/06, Eric Hodel <drbrain@segment7.net> wrote:
>
> I don't believe you can. :include: expects RDoc formatted text.
>

Eric, thanks for the reply. I was hoping I was missing something in
the documentation, but alas, it is not to be.

TwP

comp.lang.ruby

rdoc question

Tim Pease

Eric Hodel

Tim Pease

x Login to ForumsZone