rdoc 6.7.0 → 6.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/ExampleMarkdown.md +2 -0
- data/ExampleRDoc.rdoc +2 -0
- data/History.rdoc +64 -62
- data/LICENSE.rdoc +2 -0
- data/README.rdoc +13 -0
- data/RI.md +842 -0
- data/TODO.rdoc +8 -7
- data/lib/rdoc/{alias.rb → code_object/alias.rb} +1 -1
- data/lib/rdoc/{any_method.rb → code_object/any_method.rb} +3 -3
- data/lib/rdoc/{attr.rb → code_object/attr.rb} +1 -1
- data/lib/rdoc/{class_module.rb → code_object/class_module.rb} +82 -12
- data/lib/rdoc/{constant.rb → code_object/constant.rb} +1 -1
- data/lib/rdoc/{context → code_object/context}/section.rb +10 -68
- data/lib/rdoc/{method_attr.rb → code_object/method_attr.rb} +17 -5
- data/lib/rdoc/{top_level.rb → code_object/top_level.rb} +5 -5
- data/lib/rdoc/code_object.rb +6 -1
- data/lib/rdoc/comment.rb +11 -1
- data/lib/rdoc/generator/darkfish.rb +41 -3
- data/lib/rdoc/generator/pot/message_extractor.rb +1 -1
- data/lib/rdoc/generator/pot/po_entry.rb +1 -1
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +23 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +1 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +20 -11
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +3 -8
- data/lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml +3 -0
- data/lib/rdoc/generator/template/darkfish/class.rhtml +69 -43
- data/lib/rdoc/generator/template/darkfish/css/rdoc.css +380 -399
- data/lib/rdoc/generator/template/darkfish/index.rhtml +11 -10
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +24 -1
- data/lib/rdoc/generator/template/darkfish/page.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +10 -8
- data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +5 -2
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +11 -0
- data/lib/rdoc/markdown.kpeg +1 -1
- data/lib/rdoc/markdown.rb +21 -11
- data/lib/rdoc/markup/attribute_manager.rb +2 -2
- data/lib/rdoc/markup/formatter.rb +19 -12
- data/lib/rdoc/markup/pre_process.rb +26 -6
- data/lib/rdoc/markup/to_bs.rb +1 -1
- data/lib/rdoc/markup/to_html.rb +1 -1
- data/lib/rdoc/markup/to_html_crossref.rb +63 -12
- data/lib/rdoc/markup/to_rdoc.rb +5 -5
- data/lib/rdoc/markup.rb +18 -13
- data/lib/rdoc/options.rb +78 -12
- data/lib/rdoc/parser/c.rb +26 -2
- data/lib/rdoc/parser/changelog.rb +5 -4
- data/lib/rdoc/parser/prism_ruby.rb +1099 -0
- data/lib/rdoc/parser/ripper_state_lex.rb +7 -305
- data/lib/rdoc/parser/ruby.rb +16 -7
- data/lib/rdoc/parser/simple.rb +1 -1
- data/lib/rdoc/parser.rb +5 -4
- data/lib/rdoc/rd/block_parser.rb +3 -3
- data/lib/rdoc/rd/inline_parser.rb +3 -3
- data/lib/rdoc/rdoc.rb +6 -3
- data/lib/rdoc/ri/driver.rb +74 -29
- data/lib/rdoc/rubygems_hook.rb +90 -8
- data/lib/rdoc/store.rb +12 -0
- data/lib/rdoc/task.rb +2 -3
- data/lib/rdoc/tom_doc.rb +1 -7
- data/lib/rdoc/version.rb +1 -1
- data/lib/rdoc.rb +22 -24
- data/lib/rubygems_plugin.rb +23 -0
- metadata +27 -26
- data/RI.rdoc +0 -57
- data/lib/rdoc/generator/template/darkfish/.document +0 -0
- data/lib/rdoc/generator/template/json_index/.document +0 -1
- /data/lib/rdoc/{anon_class.rb → code_object/anon_class.rb} +0 -0
- /data/lib/rdoc/{context.rb → code_object/context.rb} +0 -0
- /data/lib/rdoc/{extend.rb → code_object/extend.rb} +0 -0
- /data/lib/rdoc/{ghost_method.rb → code_object/ghost_method.rb} +0 -0
- /data/lib/rdoc/{include.rb → code_object/include.rb} +0 -0
- /data/lib/rdoc/{meta_method.rb → code_object/meta_method.rb} +0 -0
- /data/lib/rdoc/{mixin.rb → code_object/mixin.rb} +0 -0
- /data/lib/rdoc/{normal_class.rb → code_object/normal_class.rb} +0 -0
- /data/lib/rdoc/{normal_module.rb → code_object/normal_module.rb} +0 -0
- /data/lib/rdoc/{require.rb → code_object/require.rb} +0 -0
- /data/lib/rdoc/{single_class.rb → code_object/single_class.rb} +0 -0
data/RI.rdoc
DELETED
@@ -1,57 +0,0 @@
|
|
1
|
-
= RI
|
2
|
-
|
3
|
-
+ri+ is a tool that allows Ruby documentation to be viewed on the command-line.
|
4
|
-
|
5
|
-
You can use +ri+ to look up information from either the command line or
|
6
|
-
interactively. When you run +ri+ without any arguments it will launch in
|
7
|
-
interactive mode. In interactive mode you can tab-complete class and method
|
8
|
-
names.
|
9
|
-
|
10
|
-
== Usage
|
11
|
-
|
12
|
-
To see information for a class, do:
|
13
|
-
ri ClassName
|
14
|
-
|
15
|
-
For example, for the Array class, do:
|
16
|
-
ri Array
|
17
|
-
|
18
|
-
To see information on a method on a class, do:
|
19
|
-
ri ClassName.method
|
20
|
-
|
21
|
-
This will show both instance and class methods. For example, the IO
|
22
|
-
class defines both IO::read and IO#read:
|
23
|
-
ri IO.read
|
24
|
-
|
25
|
-
To see information for an instance method, do:
|
26
|
-
ri ClassName#method_name
|
27
|
-
|
28
|
-
For example, for Array's +join+ method, do:
|
29
|
-
ri Array#join
|
30
|
-
|
31
|
-
To see information for a class method, do:
|
32
|
-
ri ClassName::method_name
|
33
|
-
|
34
|
-
For example, for Module's +private+ method, do:
|
35
|
-
ri Module::private
|
36
|
-
|
37
|
-
To read documentation for all +read+ methods, do:
|
38
|
-
ri read
|
39
|
-
|
40
|
-
== Options
|
41
|
-
|
42
|
-
+ri+ supports a variety of options, all of which can be viewed via +--help+.
|
43
|
-
Of particular interest, are:
|
44
|
-
|
45
|
-
[<tt>-f</tt>]
|
46
|
-
Outputs ri data using the selected formatter. You can see the available
|
47
|
-
formatters in <tt>ri --help</tt>
|
48
|
-
[<tt>-T</tt>]
|
49
|
-
Send output to stdout, rather than to a pager.
|
50
|
-
|
51
|
-
All options also can be specified through the +RI+ environment variable.
|
52
|
-
Command-line options always override those specified in the +RI+ environment
|
53
|
-
variable.
|
54
|
-
|
55
|
-
The +RI_PAGER+ environment variable allows you to choose a particular pager or
|
56
|
-
particular options for your pager.
|
57
|
-
|
File without changes
|
@@ -1 +0,0 @@
|
|
1
|
-
# ignore all files in this directory
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|