List Info

Thread: RDoc-related entries in Wikipedia




RDoc-related entries in Wikipedia
country flaguser name
United States
2007-02-19 16:57:48
I was looking at the Wikipedia page

 "Comparison of documentation generators"
 http://en.wikipedia.org/wiki/Comparison_of_do
cumentation_generators

and noticed the conspicuous absence of RDoc in any of the
tables.  So, I added the information I could readily locate
to the tables on the page.  Unfortunately, some holes
remain:

  *  There was no Wikipedia page for RDoc.  I put in a
stub.

  *  I didn't have anything to offer for the "Other
features"
     table on the comparison page.

  *  I didn't have a good overview link to offer for RDoc.

If you have the knowledge and the time, please contribute
and/or review.

-r
-- 
http://www.cfcl.com/rdm  
         Rich Morin
http://www.cfcl.com/rd
m/resume     rdmcfcl.com
http://www.cfcl.com/rd
m/weblog     +1 650-873-7841

Technical editing and writing, programming, and web
development


Embedding RDoc in a Rails app
country flaguser name
United States
2007-02-20 04:41:24
After putting together a "toy" application that
plays Hangman
in a rather devious manner:

  http://tchm.cfcl.com

I made its (syntax-colored) source code available online:

  http://tchm.cfcl.com/
code/index

then made the generated RDoc pages available, as well:

  http://tchm.cfcl.com/rdoc/page?path=doc/app/index.html


I'm rather a Ruby (and Rails) Nuby, so I suspect that parts
of
the implementation will make some readers shudder.  However,
I
haven't seen anyone else doing this sort of thing, so I
thought
folks on this list might like to see a proof of concept.

If I get really inspired, perhaps I'll look into adding some
of
the features I like on other documentation generators.  As
one
example, I'd love to have the sort of clickable diagrams
that
Doxygen uses Graphviz to produce...

-r
-- 
http://www.cfcl.com/rdm  
         Rich Morin
http://www.cfcl.com/rd
m/resume     rdmcfcl.com
http://www.cfcl.com/rd
m/weblog     +1 650-873-7841

Technical editing and writing, programming, and web
development


Embedding RDoc in a Rails app
country flaguser name
United States
2007-02-20 04:41:24
After putting together a "toy" application that
plays Hangman
in a rather devious manner:

  http://tchm.cfcl.com

I made its (syntax-colored) source code available online:

  http://tchm.cfcl.com/
code/index

then made the generated RDoc pages available, as well:

  http://tchm.cfcl.com/rdoc/page?path=doc/app/index.html


I'm rather a Ruby (and Rails) Nuby, so I suspect that parts
of
the implementation will make some readers shudder.  However,
I
haven't seen anyone else doing this sort of thing, so I
thought
folks on this list might like to see a proof of concept.

If I get really inspired, perhaps I'll look into adding some
of
the features I like on other documentation generators.  As
one
example, I'd love to have the sort of clickable diagrams
that
Doxygen uses Graphviz to produce...

-r
-- 
http://www.cfcl.com/rdm  
         Rich Morin
http://www.cfcl.com/rd
m/resume     rdmcfcl.com
http://www.cfcl.com/rd
m/weblog     +1 650-873-7841

Technical editing and writing, programming, and web
development


[1-3]

about | contact  Other archives ( Real Estate discussion Medical topics )