Re: RDoc :enddoc:

From: Dave Thomas <dave@...>
Date: 2004-04-11 15:15:28 UTC
List: ruby-core #2772
On Apr 11, 2004, at 5:34, Tanaka Akira wrote:

> module M
> end
>
> # :enddoc:
>
> class M::C
>   def m
>   end
> end
>

The problem here is the RDoc currently interpreters :enddoc: as an 
instruction to the container (either a top-level file or a 
class/module). In this case, the top-level container (the file) has 
been told not to document anything. However, when you say "class M::C", 
RDoc is not documenting in the context of the container 'M', which has 
not been told to end documenting. It therefore accepts the 
documentation for the nested class 'C'.

I could change this behavior so that :enddoc: stopped _all_ future 
documentation, but I'm not sure what the semantics should be.

Any ideas?

Cheers

Dave


In This Thread