rDoc : Java Glossary

go to home page R words 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 by Roedy Green ©1996-2008 Canadian Mind Products
index page for letter ⇒ 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)
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. 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 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
CMP logo		 feedback Please email your feedback for publication, errors, omissions, broken/redirected link reports
and suggestions to improve this page to Roedy Green : feedback email
made with CSS
HTML Checked!
ICRA ratings logo
mindprod.com IP:[65.110.21.43]
Your face IP:[38.103.63.61] The information on this page is for non-military use only.
You are visitor number 3,280. Military use includes use by defence contractors.
You can get a fresh 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