rDoc : Java Glossary

home page go to the Java Glossary Home go to the Computer Buyer’s Glossary up local find full screen, hide local find menu Google search web for more information on this topic jump to foot of page translate this page with Babelfish punctuation 0-9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z (all) ©1996-2012 Roedy Green, Canadian Mind Products
rDoc
A documentation-generating scheme similar to Javadoc used for Ruby. The rDoc processor scans for specially formatted comments in the source code and generates HTML (Hypertext Markup Language). Unlike Javadoc, rDoc has no formal mechanism to document the type or meaning of individual method parameters. The parameter name is supposed to suffice.
Basic Ruby rDoc Commands
Command Meaning
:title:xxxx Document title.
= major heading.
== minor heading.
--- horizontal rule.
* bulleted list.
9. numbered list.
[xxx] named list.
xxx:: aligned named list.
\ treat HTML tags following as literal text rather than markup.
http: hyperlink, URL (Uniform Resource Locator) appears in documentation.
link: relative local hyperlink, URL appears in documentation.
xxx[http://…] hyperlink with URL replaced by xxx text in documentation.
#-- ignore following comments.
#++ stop ignoring comments.
Javadoc
Ruby
CMP homejump to top You can get the freshest copy of this page from: or possibly from your local J: drive (Java virtual drive/mindprod.com website mirror)
http://mindprod.com/jgloss/rdoc.html J:\mindprod\jgloss\rdoc.html
logofeedback Please email your feedback for publication, letters to the editor, errors, omissions, typos, formatting errors, ambiguities, unclear wording, broken/redirected link reports, suggestions to improve this page or comments to Roedy Green : feedback email If you want your message kept confidential, not considered for posting, please explicitly specify that.
mindprod.com IP:[65.110.21.43]
view BlogYour face IP:[38.107.179.211]
You are visitor number 6,266.