rDoc : Java Glossary

home page go to the Java Glossary Home go to the Computer Buyer’s Glossary up jump to foot of page Google search web for more information on this topic Pinterest pin button
* 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-2017 Roedy Green of 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.

This page is posted
on the web at:

 http://mindprod.com/jgloss/rdoc.html

Optional Replicator mirror
of mindprod.com
on local hard disk J:

 J:\mindprod\jgloss\rdoc.html
Canadian Mind Products
Please the feedback from other visitors, or your own feedback about the site.
Contact Roedy. Please feel free to link to this page without explicit permission.

IP:[65.110.21.43]
Your face IP:[216.73.216.139]
You are visitor number