Update of /cvsroot/rubydoc/rubydoc
In directory usw-pr-cvs1:/tmp/cvs-serv16234
Added Files:
SPEC
Log Message:
*) A quick two bits on rubydoc
--- NEW FILE: SPEC ---
# See the LICENSE file for copyright and distribution information.
#
# $Id: SPEC,v 1.1 2002/06/10 20:36:52 thetitan Exp $
A quick ditty about how rubydoc will work:
* Rubydoc piggy-backs ontop of rd documentation. A rubydoc
section starts with a '=begin' tag and ends with a '=end' tag and
are therefore automatically ignored by the Ruby parser.
* Rubydoc is XML embedded in rd comments (=begin/=end blocks)
* Rubydoc may possibly use DocBook verbatim, but will likely be a
knock off of DocBook
* rubydoc is a CLI that looks for Rubydoc XML in a module or in a
document cache and formats it for review by users.
* 'rubydoc --extract [module_name]' finds and echo's rubydoc
comments from a file and prints them to stdout.
* 'rubydoc --install [module_name]' extracts the rubydoc comments
from a file and puts them in the central document cache/folder.
Does it modify the file?
* rubydoc is a wrapper around many smaller libraries and modules
and is essentially a getopt parser and library goo machine,
similar to the rubynet CLI.
* rubydoc should have a --publish option/library that lets module
authors publish updated documentation to a rubynet server.
* 'rubydoc --output=[format] [module_name]' loads the xslt
stylesheet corresponding to [format] and parses over the rubydoc
comments found for [module_name] and prints the result to stdout
after it has been translated by the stylesheet.
|
