Open paneq opened 12 years ago
http://gnuu.org/2010/05/12/whats-missing-from-tomdoc/ https://github.com/rubyworks/yard-tomdoc/issues/8 https://github.com/rubyworks/yard-tomdoc/issues/7
Documenting first method revealed issues with tomdoc so I am going to stick with YARD
and fix that documentation.
Great documentation is very hard to pull off. To even have good documentation you need to meet three major needs.
@pawelpacana I documented almost everything. Could you take a look ? Here are my doubts for the rest of the stuff:
Rack::Handler::Mongrel2
- I am not comfortable with making this part of API public yet. I expect things to change hear in near future.M2R::RackHandler
- same here.
http://documentup.com/perplexes/m2r http://www.rubydoc.info/github/perplexes/m2r/
Document private / public classes in API.
Which tool should we use for documentation: http://warpspire.com/talks/documentation/ ?
The documentation should be considered from 2 points:
m2r
to runrack
application. ProbablyRuby on Rails
orSinatra
.mongrel2
that has nothing to do withrack
whatsoever.