From: Florian Gilcher <flo@...>
Date: 2009-10-10T01:16:07+09:00
Subject: Re: Documenting DSLs

YARD can be pretty easily made to parse such stuff.

But extending the generated HTML is kind of unintuitive, IMHO.

If you want narrative documentation, Inochi is a gem that tries
to fix this problem.

Regards,
Florian


On Oct 8, 2009, at 1:38 PM, Intransition wrote:

> Has anyone done any work on documenting Ruby DSLs? Eg. RDoc can
> document this:
>
>  # This plugin ...
>  class MyThing < Plugin
>     # This does ...
>     def some
>       ...
>     end
>  end
>
> But if one were to make a DSL out of it, say:
>
>  # This plugin ...
>  plugin 'MyThing' do
>    # This does ...
>    define 'some' do
>      ...
>    end
>  end
>
> Then no RDocy.
>

--
Florian Gilcher

smtp:   flo@andersground.net
jabber: Skade@jabber.ccc.de
gpg:    533148E2