rdoc 2.1.0 → 2.2.0
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of rdoc might be problematic. Click here for more details.
- data/History.txt +82 -1
- data/Manifest.txt +8 -0
- data/README.txt +33 -9
- data/RI.txt +58 -0
- data/Rakefile +2 -0
- data/bin/ri +1 -2
- data/lib/rdoc.rb +154 -36
- data/lib/rdoc/code_objects.rb +38 -2
- data/lib/rdoc/diagram.rb +17 -15
- data/lib/rdoc/generator.rb +21 -15
- data/lib/rdoc/generator/chm/chm.rb +2 -0
- data/lib/rdoc/generator/html.rb +137 -89
- data/lib/rdoc/generator/html/common.rb +24 -0
- data/lib/rdoc/generator/html/frameless.rb +28 -731
- data/lib/rdoc/generator/html/hefss.rb +47 -311
- data/lib/rdoc/generator/html/html.rb +226 -156
- data/lib/rdoc/generator/html/kilmer.rb +31 -298
- data/lib/rdoc/generator/html/kilmerfactory.rb +427 -0
- data/lib/rdoc/generator/html/one_page_html.rb +6 -5
- data/lib/rdoc/generator/texinfo.rb +3 -6
- data/lib/rdoc/generator/xml.rb +4 -7
- data/lib/rdoc/generator/xml/xml.rb +21 -9
- data/lib/rdoc/markup.rb +0 -95
- data/lib/rdoc/markup/inline.rb +1 -1
- data/lib/rdoc/markup/to_html.rb +9 -6
- data/lib/rdoc/markup/to_html_crossref.rb +67 -21
- data/lib/rdoc/markup/to_texinfo.rb +1 -1
- data/lib/rdoc/parser.rb +22 -1
- data/lib/rdoc/parser/c.rb +14 -16
- data/lib/rdoc/parser/ruby.rb +3 -3
- data/lib/rdoc/parser/simple.rb +1 -1
- data/lib/rdoc/rdoc.rb +0 -1
- data/lib/rdoc/ri/cache.rb +5 -6
- data/lib/rdoc/ri/descriptions.rb +3 -0
- data/lib/rdoc/ri/display.rb +157 -37
- data/lib/rdoc/ri/driver.rb +314 -198
- data/lib/rdoc/ri/formatter.rb +1 -1
- data/lib/rdoc/ri/paths.rb +2 -11
- data/lib/rdoc/ri/reader.rb +3 -3
- data/lib/rdoc/ri/util.rb +0 -2
- data/test/binary.dat +0 -0
- data/test/rdoc_markup_to_html_crossref_reference.rb +31 -0
- data/test/test_attribute_manager.rb +73 -0
- data/test/test_rdoc_info_formatting.rb +6 -6
- data/test/test_rdoc_info_sections.rb +2 -2
- data/test/test_rdoc_markup_attribute_manager.rb +14 -14
- data/test/test_rdoc_markup_to_html.rb +15 -3
- data/test/test_rdoc_markup_to_html_crossref.rb +276 -7
- data/test/test_rdoc_parser.rb +13 -0
- data/test/test_rdoc_parser_c.rb +1 -1
- data/test/test_rdoc_parser_ruby.rb +72 -1
- data/test/test_rdoc_ri_default_display.rb +23 -22
- data/test/test_rdoc_ri_driver.rb +1 -1
- data/test/test_rdoc_ri_formatter.rb +1 -1
- metadata +27 -35
- data.tar.gz.sig +0 -1
- metadata.gz.sig +0 -0
data/History.txt
CHANGED
@@ -1,4 +1,85 @@
|
|
1
|
-
=== 2.
|
1
|
+
=== 2.2.0 / 2008-09-19
|
2
|
+
This version includes some significant enhancements to ri. See RI.txt for
|
3
|
+
documentation about ri.
|
4
|
+
|
5
|
+
* 5 Major Enhancements
|
6
|
+
* More extensive unit tests (special thanks to Chris Lowis for contributing
|
7
|
+
a test).
|
8
|
+
* Made ri twice as fast for the most common use case of displaying
|
9
|
+
information for a class or a fully-qualified method
|
10
|
+
(i.e., ri Array#flatten, after ri has created a cache the first time that
|
11
|
+
it runs).
|
12
|
+
* Made ri many times faster when searching for an unqualified method (i.e.,
|
13
|
+
ri read, again after the first such search has populated ri's cache)
|
14
|
+
* Changed ri to do regular expression searches for unqualified methods;
|
15
|
+
now, a regular expression for a method can be passed to ri on the
|
16
|
+
command-line.
|
17
|
+
* Added an interactive mode to ri (patch by Daniel Choi). Now, when ri
|
18
|
+
is given a -i argument, it will allow the user to disambiguate
|
19
|
+
unqualified methods if more than one is present and also will allow a
|
20
|
+
user to get information for a class' method.
|
21
|
+
|
22
|
+
* 8 Minor Enhancements
|
23
|
+
* RDoc now adds the package title to the web pages that it generates
|
24
|
+
for files and classes/modules, which helps them appear better in
|
25
|
+
search engine results.
|
26
|
+
* RDoc now automatically generates cross-reference links for classes and
|
27
|
+
methods specified relative to the global namespace (i.e., ::A::B::C#method).
|
28
|
+
* All built-in templates now output valid, strict XHTML.
|
29
|
+
* The documentation is slightly better organized (the markup details were
|
30
|
+
merged into the RDoc module's documentation).
|
31
|
+
* Improved rdoc's HTML generation speed by about 20% (on Windows, the
|
32
|
+
boost seems larger).
|
33
|
+
* Provided an ri command-line option to control its caching behavior.
|
34
|
+
* Improved RDoc's documentation. Added RI.txt to document ri.
|
35
|
+
* Allow HTML templates distributed as gems to be loaded with the -T option,
|
36
|
+
just like the standard templates in rdoc/generator/html (so an HTML
|
37
|
+
template lib/new_template.rb in a gem can be used with rdoc -T new_template)
|
38
|
+
|
39
|
+
* 25 Bug fixes:
|
40
|
+
* Fixed prototype detection in C parser. Can process ruby 1.8 C files
|
41
|
+
again.
|
42
|
+
* Fixed the main page for frameless template. Patch by Marcin Raczkowski.
|
43
|
+
* Fixed the main page for frame templates. Now, if no main page is
|
44
|
+
specified, RDoc will default to the README.
|
45
|
+
* Fixed missing stylesheet in generated chm. Patch by Gordon Thiesfeld.
|
46
|
+
* Fixed the parsing of module names starting with '::'. Patch by
|
47
|
+
Giuseppe Bilotta.
|
48
|
+
* Fixed a case where RDoc first would encounter Foo::Bar and then would
|
49
|
+
encounter class Foo. Previously, RDoc erroneously would have considered
|
50
|
+
that both a Foo class and a Foo module existed.
|
51
|
+
* Fix a clase where RDoc would not generate correct cross-reference links
|
52
|
+
to a class contained within a module of the same name (i.e. RDoc::RDoc)
|
53
|
+
* Prevented RDoc from trying to parse binary files, which would produce
|
54
|
+
garbage output.
|
55
|
+
* RDoc now correctly converts ' characters to apostrophes, opening single
|
56
|
+
quotes, and closing single quotes in most cases (smart single quotes).
|
57
|
+
* RDoc now correctly converts " characters to opening double quotes and
|
58
|
+
and closing double quotes in most cases (smart double quotes).
|
59
|
+
* (c) correctly is converted into the copyright symbol.
|
60
|
+
* '&' characters in text now correctly are translated to HTML character codes.
|
61
|
+
* Fixed missing stylesheet in generated chm. Patch by Gordon Thiesfeld.
|
62
|
+
* Fixed broken method links in the built-in templates.
|
63
|
+
* RDoc properly links to files and classes in the one page HTML template.
|
64
|
+
* The kilmer and hefss templates properly syntax highlight when inlining
|
65
|
+
source code.
|
66
|
+
* The kilmer and hefss template class pages properly display methods again.
|
67
|
+
* Fixed broken class, file, and method links in the frameless template.
|
68
|
+
* Fixed the clipping of source code in the html and frameless templates when
|
69
|
+
the source code cannot fit into the window; a scrollbar now will allow
|
70
|
+
all of the source code to be viewed.
|
71
|
+
* Fixed the missing constant descriptions in the html and frameless
|
72
|
+
templates.
|
73
|
+
* Fixed the ri command-line options that customize the directories to be
|
74
|
+
searched for documentation.
|
75
|
+
* Fixed the XML generator. Patch by Anthony Durity.
|
76
|
+
* Stopped the XML template from generating invalid XML due to malformed
|
77
|
+
embedded ruby.
|
78
|
+
* Adding missing information about a class' constants to the XML template.
|
79
|
+
* Fixed the horizontal rule markup (---) so that it correctly adds a
|
80
|
+
horizontal rule rather than suppressing all text that follows.
|
81
|
+
|
82
|
+
=== 2.1.0 / 2008-07-20
|
2
83
|
|
3
84
|
* 3 Major Enhancements:
|
4
85
|
* RDoc now knows about meta-programmed methods, see RDoc::Parser::Ruby
|
data/Manifest.txt
CHANGED
@@ -2,6 +2,7 @@ History.txt
|
|
2
2
|
Manifest.txt
|
3
3
|
README.txt
|
4
4
|
Rakefile
|
5
|
+
RI.txt
|
5
6
|
bin/rdoc
|
6
7
|
bin/ri
|
7
8
|
lib/rdoc.rb
|
@@ -12,10 +13,12 @@ lib/rdoc/generator.rb
|
|
12
13
|
lib/rdoc/generator/chm.rb
|
13
14
|
lib/rdoc/generator/chm/chm.rb
|
14
15
|
lib/rdoc/generator/html.rb
|
16
|
+
lib/rdoc/generator/html/common.rb
|
15
17
|
lib/rdoc/generator/html/frameless.rb
|
16
18
|
lib/rdoc/generator/html/hefss.rb
|
17
19
|
lib/rdoc/generator/html/html.rb
|
18
20
|
lib/rdoc/generator/html/kilmer.rb
|
21
|
+
lib/rdoc/generator/html/kilmerfactory.rb
|
19
22
|
lib/rdoc/generator/html/one_page_html.rb
|
20
23
|
lib/rdoc/generator/ri.rb
|
21
24
|
lib/rdoc/generator/texinfo.rb
|
@@ -60,10 +63,15 @@ lib/rdoc/ri/writer.rb
|
|
60
63
|
lib/rdoc/stats.rb
|
61
64
|
lib/rdoc/template.rb
|
62
65
|
lib/rdoc/tokenstream.rb
|
66
|
+
test/binary.dat
|
67
|
+
test/rdoc_markup_to_html_crossref_reference.rb
|
63
68
|
test/test_rdoc_info_formatting.rb
|
64
69
|
test/test_rdoc_info_sections.rb
|
65
70
|
test/test_rdoc_markup.rb
|
66
71
|
test/test_rdoc_markup_attribute_manager.rb
|
72
|
+
test/test_rdoc_markup_to_html.rb
|
73
|
+
test/test_rdoc_markup_to_html_crossref.rb
|
74
|
+
test/test_rdoc_parser.rb
|
67
75
|
test/test_rdoc_parser_c.rb
|
68
76
|
test/test_rdoc_parser_ruby.rb
|
69
77
|
test/test_rdoc_ri_attribute_formatter.rb
|
data/README.txt
CHANGED
@@ -1,17 +1,30 @@
|
|
1
|
-
= RDoc
|
1
|
+
= \RDoc
|
2
2
|
|
3
|
-
* http://rubyforge.org/projects/rdoc/
|
3
|
+
* Project Page: http://rubyforge.org/projects/rdoc/
|
4
|
+
* Documentation: http://rdoc.rubyforge.org/
|
4
5
|
|
5
6
|
== DESCRIPTION:
|
6
7
|
|
7
8
|
RDoc is an application that produces documentation for one or more Ruby source
|
8
|
-
files. RDoc includes the
|
9
|
+
files. RDoc includes the +rdoc+ and +ri+ tools for generating and displaying
|
9
10
|
online documentation.
|
10
11
|
|
11
12
|
At this point in time, RDoc 2.x is a work in progress and may incur further
|
12
13
|
API changes beyond what has been made to the RDoc 1.0.1. Command-line tools
|
13
14
|
are largely unaffected, but internal APIs may shift rapidly.
|
14
15
|
|
16
|
+
See RDoc for a description of RDoc's markup and basic use.
|
17
|
+
|
18
|
+
== TEMPLATE NOTE:
|
19
|
+
|
20
|
+
RDoc comes with five built-in HTML templates. We use a 3rd party template,
|
21
|
+
however, for RDoc's own documentation site[http://rdoc.rubyforge.org]. This
|
22
|
+
template is Hanna[http://github.com/mislav/hanna/tree/master].
|
23
|
+
|
24
|
+
We strongly are considering making Hanna as RDoc's default template
|
25
|
+
in a future release, but for now this template can be downloaded separately
|
26
|
+
and used with the +-T+ option.
|
27
|
+
|
15
28
|
== SYNOPSIS:
|
16
29
|
|
17
30
|
gem 'rdoc'
|
@@ -19,11 +32,23 @@ are largely unaffected, but internal APIs may shift rapidly.
|
|
19
32
|
# ... see RDoc
|
20
33
|
|
21
34
|
== BUGS:
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
35
|
+
---
|
36
|
+
RDoc's Fortran 95 support is pretty broken right now.
|
37
|
+
The rdoc-f95[http://www.gfd-dennou.org/library/dcmodel/rdoc-f95/] project has
|
38
|
+
patches for RDoc 1.x that provide excellent Fortran 95 support. Properly
|
39
|
+
supporting Fortran 95 requires a rewrite of RDoc's markup engine, which
|
40
|
+
is high on our list of goals. The Fortran 95 issue can be tracked
|
41
|
+
here[http://rubyforge.org/tracker/index.php?func=detail&aid=21542&group_id=627&atid=2475].
|
42
|
+
---
|
43
|
+
The markup engine has lots of little bugs. In particular:
|
44
|
+
* Escaping does not work for all markup.
|
45
|
+
* Typesetting is not always correct.
|
46
|
+
* Some output formats (ri, for example) do not correctly handle all of the
|
47
|
+
markup.
|
48
|
+
The markup engine needs a rewrite, which can be tracked here[http://rubyforge.org/tracker/index.php?func=detail&aid=21540&group_id=627&atid=2475].
|
49
|
+
-------
|
50
|
+
If you find a bug, please report it at the RDoc project's
|
51
|
+
tracker[http://rubyforge.org/tracker/?group_id=627] on RubyForge:
|
27
52
|
|
28
53
|
== LICENSE:
|
29
54
|
|
@@ -31,4 +56,3 @@ RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers,
|
|
31
56
|
portions (c) 2007-2008 Eric Hodel. It is free software, and may be
|
32
57
|
redistributed under the terms specified in the README file of the Ruby
|
33
58
|
distribution.
|
34
|
-
|
data/RI.txt
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
= RI
|
2
|
+
== Background
|
3
|
+
+ri+ is a tool that allows Ruby documentation to be viewed on the command-line.
|
4
|
+
It is part of RDoc and is expected to work on any platform supported by Ruby.
|
5
|
+
|
6
|
+
+ri+ will be a bit slow the first time that it runs (or any time that the
|
7
|
+
underlying documentation changes) because it builds a cache in the +.ri+
|
8
|
+
directory within the user's home directory in order to make future accesses
|
9
|
+
faster.
|
10
|
+
|
11
|
+
== Usage
|
12
|
+
To see information for a class, do:
|
13
|
+
ri class_name
|
14
|
+
|
15
|
+
For example, for the +Array+ class, do
|
16
|
+
ri Array
|
17
|
+
|
18
|
+
To see information for an instance method, do:
|
19
|
+
ri class_name#method_name
|
20
|
+
|
21
|
+
For example, for Array's +join+ method, do:
|
22
|
+
ri Array#join
|
23
|
+
|
24
|
+
To see information for a class method, do:
|
25
|
+
ri class_name.method_name
|
26
|
+
|
27
|
+
For example, for Module's +private+ method, do:
|
28
|
+
ri Module.private
|
29
|
+
|
30
|
+
To search for all methods containing +read+, do:
|
31
|
+
ri read
|
32
|
+
|
33
|
+
To search for all methods starting with +read+, do:
|
34
|
+
ri '^read'
|
35
|
+
|
36
|
+
To search for all +read+ methods, do:
|
37
|
+
ri '^read$'
|
38
|
+
|
39
|
+
== Options
|
40
|
+
+ri+ supports a variety of options, all of which can be viewed via +--help+.
|
41
|
+
Of particular interest, are:
|
42
|
+
[-d directory]
|
43
|
+
List of directories from which to source documentation in addition to
|
44
|
+
the standard directories. May be repeated. This can be used to specify
|
45
|
+
the location of site-specific documentation (which can be generated with
|
46
|
+
RDoc).
|
47
|
+
[-i]
|
48
|
+
This makes +ri+ go into interactive mode. When +ri+ is in interactive mode,
|
49
|
+
it will allow the user to disambiguate lists of methods in case multiple
|
50
|
+
methods match against a method search string. It also will allow the user
|
51
|
+
to enter in a method name (with auto-completion, if readline is supported)
|
52
|
+
when viewing a class.
|
53
|
+
[-T]
|
54
|
+
Send output to stdout, rather than to a pager.
|
55
|
+
|
56
|
+
All options also can be specified through the +RI+ environment variable.
|
57
|
+
Command-line options always override those specified in the +RI+ environment
|
58
|
+
variable.
|
data/Rakefile
CHANGED
@@ -7,6 +7,8 @@ Hoe.new "rdoc", RDoc::VERSION do |rdoc|
|
|
7
7
|
rdoc.developer 'Eric Hodel', 'drbrain@segment7.net'
|
8
8
|
rdoc.developer 'Dave Thomas', ''
|
9
9
|
rdoc.developer 'Phil Hagelberg', 'technomancy@gmail.com'
|
10
|
+
rdoc.developer 'Tony Strauss', 'tony.strauss@designingpatterns.com'
|
11
|
+
rdoc.remote_rdoc_dir = ''
|
10
12
|
end
|
11
13
|
|
12
14
|
# These tasks expect to have the following directory structure:
|
data/bin/ri
CHANGED
data/lib/rdoc.rb
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
$DEBUG_RDOC = nil
|
2
2
|
|
3
3
|
##
|
4
|
-
# RDoc - Ruby Documentation System
|
4
|
+
# = \RDoc - Ruby Documentation System
|
5
5
|
#
|
6
6
|
# This package contains RDoc and RDoc::Markup. RDoc is an application that
|
7
|
-
# produces documentation for one or more Ruby source files.
|
7
|
+
# produces documentation for one or more Ruby source files. It works similarly
|
8
8
|
# to JavaDoc, parsing the source, and extracting the definition for classes,
|
9
|
-
# modules, and methods (along with includes and requires).
|
9
|
+
# modules, and methods (along with includes and requires). It associates with
|
10
10
|
# these optional documentation contained in the immediately preceding comment
|
11
|
-
# block, and then
|
11
|
+
# block, and then renders the result using a pluggable output formatter.
|
12
12
|
# RDoc::Markup is a library that converts plain text into various output
|
13
13
|
# formats. The markup library is used to interpret the comment blocks that
|
14
14
|
# RDoc uses to document methods, classes, and so on.
|
@@ -18,8 +18,6 @@ $DEBUG_RDOC = nil
|
|
18
18
|
# * If you want to use RDoc to create documentation for your Ruby source files,
|
19
19
|
# read on.
|
20
20
|
# * If you want to include extensions written in C, see RDoc::Parser::C
|
21
|
-
# * For information on the various markups available in comment blocks, see
|
22
|
-
# RDoc::Markup.
|
23
21
|
# * If you want to drive RDoc programmatically, see RDoc::RDoc.
|
24
22
|
# * If you want to use the library to format text blocks into HTML, have a look
|
25
23
|
# at RDoc::Markup.
|
@@ -28,21 +26,21 @@ $DEBUG_RDOC = nil
|
|
28
26
|
#
|
29
27
|
# == Summary
|
30
28
|
#
|
31
|
-
# Once installed, you can create documentation using the
|
32
|
-
# (the command is 'rdoc.bat' under Windows)
|
29
|
+
# Once installed, you can create documentation using the +rdoc+ command
|
33
30
|
#
|
34
31
|
# % rdoc [options] [names...]
|
35
32
|
#
|
36
|
-
#
|
33
|
+
# For an up-to-date option summary, type
|
34
|
+
# % rdoc --help
|
37
35
|
#
|
38
36
|
# A typical use might be to generate documentation for a package of Ruby
|
39
|
-
# source (such as
|
37
|
+
# source (such as RDoc itself).
|
40
38
|
#
|
41
39
|
# % rdoc
|
42
40
|
#
|
43
41
|
# This command generates documentation for all the Ruby and C source
|
44
42
|
# files in and below the current directory. These will be stored in a
|
45
|
-
# documentation tree starting in the subdirectory
|
43
|
+
# documentation tree starting in the subdirectory +doc+.
|
46
44
|
#
|
47
45
|
# You can make this slightly more useful for your readers by having the
|
48
46
|
# index page contain the documentation for the primary file. In our
|
@@ -54,20 +52,46 @@ $DEBUG_RDOC = nil
|
|
54
52
|
# in comment blocks in the documentation this generates.
|
55
53
|
#
|
56
54
|
# RDoc uses file extensions to determine how to process each file. File names
|
57
|
-
# ending +.rb+ and
|
55
|
+
# ending +.rb+ and +.rbw+ are assumed to be Ruby source. Files
|
58
56
|
# ending +.c+ are parsed as C files. All other files are assumed to
|
59
57
|
# contain just Markup-style markup (with or without leading '#' comment
|
60
58
|
# markers). If directory names are passed to RDoc, they are scanned
|
61
59
|
# recursively for C and Ruby source files only.
|
62
60
|
#
|
63
|
-
#
|
61
|
+
# == \Options
|
62
|
+
# rdoc can be passed a variety of command-line options. In addition,
|
63
|
+
# options can be specified via the +RDOCOPT+ environment variable, which
|
64
|
+
# functions similarly to the +RUBYOPT+ environment variable.
|
64
65
|
#
|
65
|
-
#
|
66
|
-
# RDoc::Markup.
|
66
|
+
# % export RDOCOPT="-S"
|
67
67
|
#
|
68
|
-
#
|
68
|
+
# will make rdoc default to inline method source code. Command-line options
|
69
|
+
# always will override those in +RDOCOPT+.
|
70
|
+
#
|
71
|
+
# Run
|
72
|
+
#
|
73
|
+
# % rdoc --help
|
74
|
+
#
|
75
|
+
# for full details on rdoc's options.
|
76
|
+
#
|
77
|
+
# Here are some of the most commonly used options.
|
78
|
+
# [-d, --diagram]
|
79
|
+
# Generate diagrams showing modules and
|
80
|
+
# classes. You need dot V1.8.6 or later to
|
81
|
+
# use the --diagram option correctly. Dot is
|
82
|
+
# available from http://graphviz.org
|
83
|
+
#
|
84
|
+
# [-S, --inline-source]
|
85
|
+
# Show method source code inline, rather than via a popup link.
|
86
|
+
#
|
87
|
+
# [-T, --template=NAME]
|
88
|
+
# Set the template used when generating output.
|
89
|
+
#
|
90
|
+
# == Documenting Source Code
|
91
|
+
#
|
92
|
+
# Comment blocks can be written fairly naturally, either using +#+ on
|
69
93
|
# successive lines of the comment, or by including the comment in
|
70
|
-
#
|
94
|
+
# a =begin/=end block. If you use the latter form, the =begin line must be
|
71
95
|
# flagged with an RDoc tag:
|
72
96
|
#
|
73
97
|
# =begin rdoc
|
@@ -93,7 +117,7 @@ $DEBUG_RDOC = nil
|
|
93
117
|
# # ...
|
94
118
|
# end
|
95
119
|
#
|
96
|
-
# Names of classes,
|
120
|
+
# Names of classes, files, and any method names containing an
|
97
121
|
# underscore or preceded by a hash character are automatically hyperlinked
|
98
122
|
# from comment text to their description.
|
99
123
|
#
|
@@ -124,15 +148,109 @@ $DEBUG_RDOC = nil
|
|
124
148
|
# +:yields:+ is an example of a documentation directive. These appear
|
125
149
|
# immediately after the start of the document element they are modifying.
|
126
150
|
#
|
151
|
+
# == \Markup
|
152
|
+
#
|
153
|
+
# * The markup engine looks for a document's natural left margin. This is
|
154
|
+
# used as the initial margin for the document.
|
155
|
+
#
|
156
|
+
# * Consecutive lines starting at this margin are considered to be a
|
157
|
+
# paragraph.
|
158
|
+
#
|
159
|
+
# * If a paragraph starts with a "*", "-", or with "<digit>.", then it is
|
160
|
+
# taken to be the start of a list. The margin in increased to be the first
|
161
|
+
# non-space following the list start flag. Subsequent lines should be
|
162
|
+
# indented to this new margin until the list ends. For example:
|
163
|
+
#
|
164
|
+
# * this is a list with three paragraphs in
|
165
|
+
# the first item. This is the first paragraph.
|
166
|
+
#
|
167
|
+
# And this is the second paragraph.
|
168
|
+
#
|
169
|
+
# 1. This is an indented, numbered list.
|
170
|
+
# 2. This is the second item in that list
|
171
|
+
#
|
172
|
+
# This is the third conventional paragraph in the
|
173
|
+
# first list item.
|
174
|
+
#
|
175
|
+
# * This is the second item in the original list
|
176
|
+
#
|
177
|
+
# * You can also construct labeled lists, sometimes called description
|
178
|
+
# or definition lists. Do this by putting the label in square brackets
|
179
|
+
# and indenting the list body:
|
180
|
+
#
|
181
|
+
# [cat] a small furry mammal
|
182
|
+
# that seems to sleep a lot
|
183
|
+
#
|
184
|
+
# [ant] a little insect that is known
|
185
|
+
# to enjoy picnics
|
186
|
+
#
|
187
|
+
# A minor variation on labeled lists uses two colons to separate the
|
188
|
+
# label from the list body:
|
189
|
+
#
|
190
|
+
# cat:: a small furry mammal
|
191
|
+
# that seems to sleep a lot
|
192
|
+
#
|
193
|
+
# ant:: a little insect that is known
|
194
|
+
# to enjoy picnics
|
195
|
+
#
|
196
|
+
# This latter style guarantees that the list bodies' left margins are
|
197
|
+
# aligned: think of them as a two column table.
|
198
|
+
#
|
199
|
+
# * Any line that starts to the right of the current margin is treated
|
200
|
+
# as verbatim text. This is useful for code listings. The example of a
|
201
|
+
# list above is also verbatim text.
|
202
|
+
#
|
203
|
+
# * A line starting with an equals sign (=) is treated as a
|
204
|
+
# heading. Level one headings have one equals sign, level two headings
|
205
|
+
# have two,and so on.
|
206
|
+
#
|
207
|
+
# * A line starting with three or more hyphens (at the current indent)
|
208
|
+
# generates a horizontal rule. The more hyphens, the thicker the rule
|
209
|
+
# (within reason, and if supported by the output device)
|
210
|
+
#
|
211
|
+
# * You can use markup within text (except verbatim) to change the
|
212
|
+
# appearance of parts of that text. Out of the box, RDoc::Markup
|
213
|
+
# supports word-based and general markup.
|
214
|
+
#
|
215
|
+
# Word-based markup uses flag characters around individual words:
|
216
|
+
#
|
217
|
+
# [\*word*] displays word in a *bold* font
|
218
|
+
# [\_word_] displays word in an _emphasized_ font
|
219
|
+
# [\+word+] displays word in a +code+ font
|
220
|
+
#
|
221
|
+
# General markup affects text between a start delimiter and and end
|
222
|
+
# delimiter. Not surprisingly, these delimiters look like HTML markup.
|
223
|
+
#
|
224
|
+
# [\<b>text...</b>] displays word in a *bold* font
|
225
|
+
# [\<em>text...</em>] displays word in an _emphasized_ font
|
226
|
+
# [\\<i>text...</i>] displays word in an <i>italicized</i> font
|
227
|
+
# [\<tt>text...</tt>] displays word in a +code+ font
|
228
|
+
#
|
229
|
+
# Unlike conventional Wiki markup, general markup can cross line
|
230
|
+
# boundaries. You can turn off the interpretation of markup by
|
231
|
+
# preceding the first character with a backslash. This only works for
|
232
|
+
# simple markup, not HTML-style markup.
|
233
|
+
#
|
234
|
+
# * Hyperlinks to the web starting http:, mailto:, ftp:, or www. are
|
235
|
+
# recognized. An HTTP url that references an external image file is
|
236
|
+
# converted into an inline <IMG..>. Hyperlinks starting 'link:' are
|
237
|
+
# assumed to refer to local files whose path is relative to the --op
|
238
|
+
# directory.
|
239
|
+
#
|
240
|
+
# Hyperlinks can also be of the form <tt>label</tt>[url], in which
|
241
|
+
# case the label is used in the displayed text, and +url+ is
|
242
|
+
# used as the target. If +label+ contains multiple words,
|
243
|
+
# put it in braces: <em>{multi word label}[</em>url<em>]</em>.
|
244
|
+
#
|
127
245
|
# == Directives
|
128
246
|
#
|
129
247
|
# [+:nodoc:+ / +:nodoc:+ all]
|
130
|
-
#
|
131
|
-
# and modules, the methods, aliases,
|
132
|
-
# directly within the affected class or
|
133
|
-
# omitted. By default, though, modules and
|
134
|
-
# class of module _will_ be documented. This is
|
135
|
-
# adding the +all+ modifier.
|
248
|
+
# This directive prevents documentation for the element from
|
249
|
+
# being generated. For classes and modules, the methods, aliases,
|
250
|
+
# constants, and attributes directly within the affected class or
|
251
|
+
# module also will be omitted. By default, though, modules and
|
252
|
+
# classes within that class of module _will_ be documented. This is
|
253
|
+
# turned off by adding the +all+ modifier.
|
136
254
|
#
|
137
255
|
# module MyModule # :nodoc:
|
138
256
|
# class Input
|
@@ -144,22 +262,22 @@ $DEBUG_RDOC = nil
|
|
144
262
|
# end
|
145
263
|
# end
|
146
264
|
#
|
147
|
-
# In the above code, only class
|
148
|
-
# The
|
149
|
-
#
|
150
|
-
# particular set of methods, etc.
|
265
|
+
# In the above code, only class <tt>MyModule::Input</tt> will be documented.
|
266
|
+
# The +:nodoc:+ directive is global across all files for the class or module
|
267
|
+
# to which it applies, so use +:stopdoc:+/+:startdoc:+ to suppress
|
268
|
+
# documentation only for a particular set of methods, etc.
|
151
269
|
#
|
152
270
|
# [+:doc:+]
|
153
|
-
#
|
154
|
-
#
|
271
|
+
# Forces a method or attribute to be documented even if it wouldn't be
|
272
|
+
# otherwise. Useful if, for example, you want to include documentation of a
|
155
273
|
# particular private method.
|
156
274
|
#
|
157
275
|
# [+:notnew:+]
|
158
276
|
# Only applicable to the +initialize+ instance method. Normally RDoc
|
159
|
-
# assumes that the documentation and parameters for
|
160
|
-
# actually for the
|
161
|
-
# The
|
162
|
-
# so you won't see the documentation unless you use the
|
277
|
+
# assumes that the documentation and parameters for +initialize+ are
|
278
|
+
# actually for the +new+ method, and so fakes out a +new+ for the class.
|
279
|
+
# The +:notnew:+ modifier stops this. Remember that +initialize+ is private,
|
280
|
+
# so you won't see the documentation unless you use the +-a+ command line
|
163
281
|
# option.
|
164
282
|
#
|
165
283
|
# Comment blocks can contain other directives:
|
@@ -209,7 +327,7 @@ $DEBUG_RDOC = nil
|
|
209
327
|
# last. If you don't specify a +:startdoc:+ by the end of the container,
|
210
328
|
# disables documentation for the entire class or module.
|
211
329
|
#
|
212
|
-
#
|
330
|
+
# == Other stuff
|
213
331
|
#
|
214
332
|
# RDoc is currently being maintained by Eric Hodel <drbrain@segment7.net>
|
215
333
|
#
|
@@ -254,7 +372,7 @@ module RDoc
|
|
254
372
|
##
|
255
373
|
# RDoc version you are using
|
256
374
|
|
257
|
-
VERSION = "2.
|
375
|
+
VERSION = "2.2.0"
|
258
376
|
|
259
377
|
##
|
260
378
|
# Name of the dotfile that contains the description of files to be processed
|