rDoc : Java Glossary

Basic Ruby rDoc Commands
: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.

Basic Ruby rDoc Commands

Command

Meaning

:title:xxxx

Document title.

major heading.

minor heading.

---

horizontal rule.

bulleted list.

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.

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 :

. If you want your message, your name or email kept confidential, not considered for public posting, please explicitly specify that. Unless you state otherwise, I will treat your message as a letter to the editor that I may or may not publish in the feedback section. After that, it will be too late to retract it. If you disagree with something I said, please quote it and cite the web page where you found it, tell me why you think it is wrong, and, if possible, provide some supporting evidence. Threatening to kill me or spouting obscenities has yet to persuade me to change my mind.

	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
	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 : . If you want your message, your name or email kept confidential, not considered for public posting, please explicitly specify that. Unless you state otherwise, I will treat your message as a letter to the editor that I may or may not publish in the feedback section. After that, it will be too late to retract it. If you disagree with something I said, please quote it and cite the web page where you found it, tell me why you think it is wrong, and, if possible, provide some supporting evidence. Threatening to kill me or spouting obscenities has yet to persuade me to change my mind.
	Canadian Mind Products
	mindprod.com IP:[65.110.21.43]
view Blog	Your face IP:[38.107.179.213]
Feedback	You are visitor number 6,411.