[Ruby] rdoc S.T.B.

Laurel Fan laurel.fan at gmail.com
Thu Apr 26 16:40:16 PDT 2007


On 4/26/07, Daevid Vincent <daevid at daevid.com> wrote:
> RDoc failure in
> gems/1.8/gems/rails-1.1.6/lib/rails_generator/generators/components/controll
> er/templates/controller.rb at or around line 10 column 4
>
> Before reporting this, could you check that the file
> you're documenting compiles cleanly--RDoc is not a
> full Ruby parser, and gets confused easily if fed
> invalid programs.

Generator templates are definitely invalid programs (as you can tell
with all that erb stuff in them).
So you should probably exclude them from rdoc.  Is there any chance
that rails has a rake task that builds the docs and knows what to
exclude?  (caveat: I've never built the rdoc, I just use google or
gotapi...)

-- 
Laurel Fan
http://blog.gorgorg.org


More information about the Ruby mailing list