Documenting DSLs

[Intransition]

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.

 

[Ryan Davis]

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.

Seems you're not in "transition" anymore.

2.1.0 / 2008-07-20
=95 3 Major Enhancements:
=95 RDoc now knows about meta-programmed methods, =
seeRDoc:arser::Ruby

http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html

 

[Roger Pack]

Has anyone done any work on documenting Ruby DSLs? Eg. RDoc can
document this:
# This does ...
define 'some' do
...
end
end

Then no RDocy.

I had to ask the same question recently.

http://article.gmane.org/gmane.comp.lang.ruby.documentation/1102

-r

 

[Florian Gilcher]

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

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: (e-mail address removed)
jabber: (e-mail address removed)
gpg: 533148E2

 

[Suraj Kurapati]

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

I think you meant to say ERBook[1] (which generates beautiful user
manuals) rather than Inochi[2] (which is a framework for creating
gem-based libraries and command-line apps).

Cheers.

[1]: http://snk.tuxfamily.org/lib/erbook/
[2]: http://snk.tuxfamily.org/lib/inochi/