![]() Each label must be inside square brackets or followed by two colons: * This is the second item in the original list This is the third conventional paragraph in the * this is a list with three paragraphs in Here's an example (from the RDoc documentation): All subsequent lines should be indented to match the text on the first line of the list item. If a line starts with "*", "-" or "" the following information is a list item, either unnumbered or numbered.Consecutive lines aligned on the left margin (either column 0 in a text file, or after the comment character and whitespace in a source file) are considered a paragraph.SimpleMarkup is a simplified text-based markup system, much like many wiki markup languages. RDoc uses a formatting system called SimpleMarkup for its markup purposes. In this case they are treated as SimpleMarkup (see below) - generally speaking they will just be browsable as plain text files in the HTML documention.įormatting for RDoc The output is always generated in a directory doc/ under the current location.Īny files which aren't recognized as Ruby or C are not parsed by default, but can be included as command-line arguments to rdoc. If no source files are specified, RubyDoc will start searching with the current directory. rdoc will search recursively, which makes it convenient for documenting large trees of code. Handling Multiple Files Īny directories included on the command line will be searched for Ruby files (with an. Once we select either a class or a function it will show more particular information. In this case the lower panel is showing the summary information for the file simpleNumber.rb which has been extracted from the top-level comment in the file. The middle pane lists all of the classes in simpleNumber.rb, and the right panel gives all of the methods in SimpleNumber. What has RDoc done? First, it has scanned the given file (shown in the upper left pane). ![]() Open the file doc/index.html in a web browser and find It contains quite a few files (given such a simple class!)Ĭlasses files fr_file_index.html index.htmlĬreated.rid fr_class_index.html fr_method_index.html rdoc-style.css Here are the contents of the file simpleNumber.rb which contains a class SimpleNumber # This file is called simpleNumber.rbĪ quick look around reveals rdoc has created a new directory called doc/.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |