voloko-sdoc 0.1.2 → 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- data/rdoc/History.txt +254 -0
- data/rdoc/Manifest.txt +126 -0
- data/rdoc/README.txt +47 -0
- data/rdoc/RI.txt +58 -0
- data/rdoc/Rakefile +70 -0
- data/rdoc/bin/rdoc +35 -0
- data/rdoc/bin/ri +5 -0
- data/rdoc/lib/rdoc/alias.rb +54 -0
- data/rdoc/lib/rdoc/anon_class.rb +10 -0
- data/rdoc/lib/rdoc/any_method.rb +190 -0
- data/rdoc/lib/rdoc/attr.rb +79 -0
- data/rdoc/lib/rdoc/cache.rb +41 -0
- data/rdoc/lib/rdoc/class_module.rb +87 -0
- data/rdoc/lib/rdoc/code_object.rb +152 -0
- data/rdoc/lib/rdoc/code_objects.rb +23 -0
- data/rdoc/lib/rdoc/constant.rb +36 -0
- data/rdoc/lib/rdoc/context.rb +712 -0
- data/rdoc/lib/rdoc/diagram.rb +340 -0
- data/rdoc/lib/rdoc/dot.rb +249 -0
- data/rdoc/lib/rdoc/generator/darkfish.rb +455 -0
- data/rdoc/lib/rdoc/generator/markup.rb +194 -0
- data/rdoc/lib/rdoc/generator/ri.rb +230 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/classpage.rhtml +281 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/filepage.rhtml +112 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/brick.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/brick_link.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/bug.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/bullet_black.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/date.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/find.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/macFFBgHack.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/package.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/page_green.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/page_white_text.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/page_white_width.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/plugin.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/ruby.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/tag_green.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/wrench.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/wrench_orange.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/images/zoom.png +0 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/index.rhtml +64 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/js/darkfish.js +116 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/js/jquery.js +32 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/js/quicksearch.js +114 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js +10 -0
- data/rdoc/lib/rdoc/generator/template/darkfish/rdoc.css +696 -0
- data/rdoc/lib/rdoc/generator.rb +8 -0
- data/rdoc/lib/rdoc/ghost_method.rb +8 -0
- data/rdoc/lib/rdoc/include.rb +39 -0
- data/rdoc/lib/rdoc/known_classes.rb +68 -0
- data/rdoc/lib/rdoc/markup/attribute_manager.rb +311 -0
- data/rdoc/lib/rdoc/markup/formatter.rb +25 -0
- data/rdoc/lib/rdoc/markup/fragments.rb +377 -0
- data/rdoc/lib/rdoc/markup/inline.rb +126 -0
- data/rdoc/lib/rdoc/markup/lines.rb +156 -0
- data/rdoc/lib/rdoc/markup/preprocess.rb +80 -0
- data/rdoc/lib/rdoc/markup/to_flow.rb +211 -0
- data/rdoc/lib/rdoc/markup/to_html.rb +406 -0
- data/rdoc/lib/rdoc/markup/to_html_crossref.rb +140 -0
- data/rdoc/lib/rdoc/markup/to_latex.rb +328 -0
- data/rdoc/lib/rdoc/markup/to_test.rb +53 -0
- data/rdoc/lib/rdoc/markup/to_texinfo.rb +73 -0
- data/rdoc/lib/rdoc/markup.rb +378 -0
- data/rdoc/lib/rdoc/meta_method.rb +8 -0
- data/rdoc/lib/rdoc/normal_class.rb +18 -0
- data/rdoc/lib/rdoc/normal_module.rb +34 -0
- data/rdoc/lib/rdoc/options.rb +542 -0
- data/rdoc/lib/rdoc/parser/c.rb +678 -0
- data/rdoc/lib/rdoc/parser/perl.rb +165 -0
- data/rdoc/lib/rdoc/parser/ruby.rb +2904 -0
- data/rdoc/lib/rdoc/parser/simple.rb +39 -0
- data/rdoc/lib/rdoc/parser.rb +138 -0
- data/rdoc/lib/rdoc/rdoc.rb +375 -0
- data/rdoc/lib/rdoc/require.rb +32 -0
- data/rdoc/lib/rdoc/ri/cache.rb +187 -0
- data/rdoc/lib/rdoc/ri/descriptions.rb +156 -0
- data/rdoc/lib/rdoc/ri/display.rb +340 -0
- data/rdoc/lib/rdoc/ri/driver.rb +828 -0
- data/rdoc/lib/rdoc/ri/formatter.rb +654 -0
- data/rdoc/lib/rdoc/ri/paths.rb +93 -0
- data/rdoc/lib/rdoc/ri/reader.rb +106 -0
- data/rdoc/lib/rdoc/ri/util.rb +79 -0
- data/rdoc/lib/rdoc/ri/writer.rb +68 -0
- data/rdoc/lib/rdoc/ri.rb +8 -0
- data/rdoc/lib/rdoc/single_class.rb +8 -0
- data/rdoc/lib/rdoc/stats.rb +178 -0
- data/rdoc/lib/rdoc/task.rb +276 -0
- data/rdoc/lib/rdoc/tokenstream.rb +33 -0
- data/rdoc/lib/rdoc/top_level.rb +242 -0
- data/rdoc/lib/rdoc.rb +398 -0
- metadata +1 -1
data/rdoc/History.txt
ADDED
@@ -0,0 +1,254 @@
|
|
1
|
+
=== 2.4.2 / 2009-03-25
|
2
|
+
|
3
|
+
* 2 Minor Enhancements
|
4
|
+
* Added --pipe for turning RDoc on stdin into HTML
|
5
|
+
* Added rdoc/task.rb containing a replacement for rake/rdoctask.rb. Use
|
6
|
+
RDoc::Task now instead of Rake::RDocTask.
|
7
|
+
|
8
|
+
* 10 Bug Fixes
|
9
|
+
* Writing the ri cache file to the proper directory. Bug #24459 by Lars
|
10
|
+
Christensen.
|
11
|
+
* Possible fix for Dir::[] and Pathname interaction on 1.9. Bug #24650 by
|
12
|
+
tiburon.
|
13
|
+
* Fixed scanning constants for if/end, etc. pairs. Bug #24609 by Ryan
|
14
|
+
Davis.
|
15
|
+
* Fixed private methods in the C parser. Bug #24599 by Aaron Patterson.
|
16
|
+
* Fixed display of markup on RDoc main page. Bug #24168 by rhubarb.
|
17
|
+
* Fixed display of \\ character in documentation proceeding words.
|
18
|
+
Bug #22112 by James Gray. See RDoc for details.
|
19
|
+
* Fixed parsing and display of arg params for some corner cases. Bug #21113
|
20
|
+
by Csiszár Attila.
|
21
|
+
* Fixed links in Files box. Patch #24403 by Eric Wong.
|
22
|
+
* Toplevel methods now appear in Object. Bug #22677 by Ryan Davis.
|
23
|
+
* Added back --promiscuous which didn't do anything you cared about. Why
|
24
|
+
did you enable it? Nobody looked at that page! Oh, it warns, too.
|
25
|
+
|
26
|
+
=== 2.4.1 / 2009-02-26
|
27
|
+
|
28
|
+
* 1 Minor Enhancements
|
29
|
+
* Added :attr:, :attr_reader:, :attr_writer:, :attr_accessor: directives.
|
30
|
+
Replaces --accessor. See RDoc::Parser::Ruby for details.
|
31
|
+
|
32
|
+
* 3 Bug Fixes
|
33
|
+
* Don't complain when exiting normally. Bug by Matt Neuburg.
|
34
|
+
* Restore --inline-source that warns
|
35
|
+
* Fixed links to files in Darkfish output
|
36
|
+
|
37
|
+
=== 2.4.0 / 2009-02-24
|
38
|
+
|
39
|
+
* 9 Minor Enhancements
|
40
|
+
* `ri -f html` is now XHTML-happy
|
41
|
+
* Clarified RDoc::Markup link syntax. Bug #23517 by Eric Armstrong.
|
42
|
+
* Number of threads to parse with is now configurable
|
43
|
+
* Darkfish can now use alternate templates from $LOAD_PATH via -T
|
44
|
+
* Removed F95 parser in favor of the rdoc-f95 gem
|
45
|
+
* Moved HTML and XML generators to unmaintained
|
46
|
+
* No gem will be provided as it's too difficult to make them work
|
47
|
+
* Removed options --one-file, --style=, --inline-source, --promiscuous,
|
48
|
+
--op-name
|
49
|
+
* Removed support for --accessor, use regular documentation or
|
50
|
+
the method directive instead. See RDoc::Parser::Ruby
|
51
|
+
* Removed --ri-system as it is unused by Ruby's makefiles
|
52
|
+
* Added method list to index.html
|
53
|
+
|
54
|
+
* 6 Bug Fixes
|
55
|
+
* nodoc'd classes no longer appear in the index. Bug #23751 by Clifford
|
56
|
+
Heath.
|
57
|
+
* Fix 1.9 compatibility issues. Bug #23815 by paddor.
|
58
|
+
* Darkfish now respects --charset
|
59
|
+
* RDoc no longer attempts to be lazy when building HTML. This is a
|
60
|
+
workaround. Bug #23893 by Stefano Crocco.
|
61
|
+
* RDoc doesn't crash with def (blah).foo() end
|
62
|
+
* RDoc doesn't crash with #define functions
|
63
|
+
|
64
|
+
=== 2.3.0 / 2009-01-28
|
65
|
+
|
66
|
+
* 3 Major Enhancements
|
67
|
+
* Michael Granger's Darkfish generator is now the default for HTML output
|
68
|
+
* Various rdoc generation speedups by Hongli Lai. Patches #22555, #22556,
|
69
|
+
#22557, #22562, #22565.
|
70
|
+
* rdoc/discover.rb files are loaded automatically from installed gems
|
71
|
+
|
72
|
+
* 8 Minor Enhancements
|
73
|
+
* Added a space after the commas in ri class method lists. RubyForge
|
74
|
+
enhancement #22182.
|
75
|
+
* Improved ri --interactive
|
76
|
+
* Generators can now override generated file locations
|
77
|
+
* Moved unmaintained CHM generator to it's own package
|
78
|
+
* Moved unmaintained extra HTML templates to their own package
|
79
|
+
* Removed experimental texinfo generator
|
80
|
+
* Converted to minitest
|
81
|
+
* Known classes and modules list outputs once per line now for grep
|
82
|
+
|
83
|
+
* 11 Bug Fixes
|
84
|
+
* Fix missing superclass in ri output
|
85
|
+
* Fix an RDoc crash when told to parse an empty file
|
86
|
+
* Ignore nonexistent files instead of crashing
|
87
|
+
* .txt and .rdoc files are always considered text. Patch #22897 by Aaron
|
88
|
+
Patterson.
|
89
|
+
* When merging ri data with a nonexistant directory, RDoc no longer crashes
|
90
|
+
* Fix visibility of methods in XML output. Issue by Yehuda Katz.
|
91
|
+
* Fixed relative link generation
|
92
|
+
* Fix crash, RDoc now ignores comments above local variable assignments in
|
93
|
+
modules
|
94
|
+
* RDoc now only accepts adjacent comments for rb_define_module and
|
95
|
+
rb_define_class
|
96
|
+
* C file RDoc is no longer included in token stream
|
97
|
+
* Scan all gem paths to match gem name for ri output
|
98
|
+
|
99
|
+
=== 2.2.1 / 2008-09-24
|
100
|
+
This version provides some minor fixes and enhancements to 2.2.0 intended
|
101
|
+
to polish RDoc for Ruby 1.9.1.
|
102
|
+
|
103
|
+
* 3 Minor Enhancements
|
104
|
+
* Support for parsing RDoc from SWIG. Ruby patch #10742 by Gonzalo
|
105
|
+
Garramuno, #13993 by Steven Jenkins.
|
106
|
+
* Simple support for Perl POD documentation. Patch by Hugh Sasse.
|
107
|
+
* Changed the default character set of RDoc's output from iso-8859-1 to
|
108
|
+
utf-8.
|
109
|
+
|
110
|
+
* 9 Bug Fixes
|
111
|
+
* Explicitly set the html template's text color, so that the generated
|
112
|
+
documentation will display correctly on browsers with custom text and
|
113
|
+
background color settings (patch by Luther Thompson).
|
114
|
+
* Ensure that RDoc correctly will associate an alias and a method, even
|
115
|
+
if it encounters the alias first because the alias lives in a different
|
116
|
+
file.
|
117
|
+
* Fix the parsing of multiline constants (patch by Chris Alfeld and
|
118
|
+
Joel VanderWerf)
|
119
|
+
* Make --exclude usuable. Ruby patch #11671 by Trans.
|
120
|
+
* Detect inline C functions. Ruby Bug #11993 by Florian Frank.
|
121
|
+
* Fix an issue in which RDoc might not document a class'
|
122
|
+
superclass correctly if the class was defined in multiple files and
|
123
|
+
depending on the order in which RDoc processed the files. This should
|
124
|
+
ensure that the child class -> parent class relationship is correct in
|
125
|
+
ri documentation, allowing ri to lookup inherited methods (i.e., File.read).
|
126
|
+
* Stop ri from crashing when it looks for a completely bogus method (i.e.,
|
127
|
+
File#reada). Now, ri exits with a helpful error message.
|
128
|
+
* Fixed missing display of constant values in ri.
|
129
|
+
* Fixed display of constants in ri's html output.
|
130
|
+
|
131
|
+
=== 2.2.0 / 2008-09-19
|
132
|
+
This version includes some significant enhancements to ri. See RI.txt for
|
133
|
+
documentation about ri.
|
134
|
+
|
135
|
+
* 5 Major Enhancements
|
136
|
+
* More extensive unit tests (special thanks to Chris Lowis for contributing
|
137
|
+
a test).
|
138
|
+
* Made ri twice as fast for the most common use case of displaying
|
139
|
+
information for a class or a fully-qualified method
|
140
|
+
(i.e., ri Array#flatten, after ri has created a cache the first time that
|
141
|
+
it runs).
|
142
|
+
* Made ri many times faster when searching for an unqualified method (i.e.,
|
143
|
+
ri read, again after the first such search has populated ri's cache)
|
144
|
+
* Changed ri to do regular expression searches for unqualified methods;
|
145
|
+
now, a regular expression for a method can be passed to ri on the
|
146
|
+
command-line.
|
147
|
+
* Added an interactive mode to ri (patch by Daniel Choi). Now, when ri
|
148
|
+
is given a -i argument, it will allow the user to disambiguate
|
149
|
+
unqualified methods if more than one is present and also will allow a
|
150
|
+
user to get information for a class' method.
|
151
|
+
|
152
|
+
* 8 Minor Enhancements
|
153
|
+
* RDoc now adds the package title to the web pages that it generates
|
154
|
+
for files and classes/modules, which helps them appear better in
|
155
|
+
search engine results.
|
156
|
+
* RDoc now automatically generates cross-reference links for classes and
|
157
|
+
methods specified relative to the global namespace (i.e., ::A::B::C#method).
|
158
|
+
* All built-in templates now output valid, strict XHTML.
|
159
|
+
* The documentation is slightly better organized (the markup details were
|
160
|
+
merged into the RDoc module's documentation).
|
161
|
+
* Improved rdoc's HTML generation speed by about 20% (on Windows, the
|
162
|
+
boost seems larger).
|
163
|
+
* Provided an ri command-line option to control its caching behavior.
|
164
|
+
* Improved RDoc's documentation. Added RI.txt to document ri.
|
165
|
+
* Allow HTML templates distributed as gems to be loaded with the -T option,
|
166
|
+
just like the standard templates in rdoc/generator/html (so an HTML
|
167
|
+
template lib/new_template.rb in a gem can be used with rdoc -T new_template)
|
168
|
+
|
169
|
+
* 25 Bug fixes:
|
170
|
+
* Fixed prototype detection in C parser. Can process ruby 1.8 C files
|
171
|
+
again.
|
172
|
+
* Fixed the main page for frameless template. Patch by Marcin Raczkowski.
|
173
|
+
* Fixed the main page for frame templates. Now, if no main page is
|
174
|
+
specified, RDoc will default to the README.
|
175
|
+
* Fixed missing stylesheet in generated chm. Patch by Gordon Thiesfeld.
|
176
|
+
* Fixed the parsing of module names starting with '::'. Patch by
|
177
|
+
Giuseppe Bilotta.
|
178
|
+
* Fixed a case where RDoc first would encounter Foo::Bar and then would
|
179
|
+
encounter class Foo. Previously, RDoc erroneously would have considered
|
180
|
+
that both a Foo class and a Foo module existed.
|
181
|
+
* Fix a clase where RDoc would not generate correct cross-reference links
|
182
|
+
to a class contained within a module of the same name (i.e. RDoc::RDoc)
|
183
|
+
* Prevented RDoc from trying to parse binary files, which would produce
|
184
|
+
garbage output.
|
185
|
+
* RDoc now correctly converts ' characters to apostrophes, opening single
|
186
|
+
quotes, and closing single quotes in most cases (smart single quotes).
|
187
|
+
* RDoc now correctly converts " characters to opening double quotes and
|
188
|
+
and closing double quotes in most cases (smart double quotes).
|
189
|
+
* (c) correctly is converted into the copyright symbol.
|
190
|
+
* '&' characters in text now correctly are translated to HTML character codes.
|
191
|
+
* Fixed missing stylesheet in generated chm. Patch by Gordon Thiesfeld.
|
192
|
+
* Fixed broken method links in the built-in templates.
|
193
|
+
* RDoc properly links to files and classes in the one page HTML template.
|
194
|
+
* The kilmer and hefss templates properly syntax highlight when inlining
|
195
|
+
source code.
|
196
|
+
* The kilmer and hefss template class pages properly display methods again.
|
197
|
+
* Fixed broken class, file, and method links in the frameless template.
|
198
|
+
* Fixed the clipping of source code in the html and frameless templates when
|
199
|
+
the source code cannot fit into the window; a scrollbar now will allow
|
200
|
+
all of the source code to be viewed.
|
201
|
+
* Fixed the missing constant descriptions in the html and frameless
|
202
|
+
templates.
|
203
|
+
* Fixed the ri command-line options that customize the directories to be
|
204
|
+
searched for documentation.
|
205
|
+
* Fixed the XML generator. Patch by Anthony Durity.
|
206
|
+
* Stopped the XML template from generating invalid XML due to malformed
|
207
|
+
embedded ruby.
|
208
|
+
* Adding missing information about a class' constants to the XML template.
|
209
|
+
* Fixed the horizontal rule markup (---) so that it correctly adds a
|
210
|
+
horizontal rule rather than suppressing all text that follows.
|
211
|
+
|
212
|
+
=== 2.1.0 / 2008-07-20
|
213
|
+
|
214
|
+
* 3 Major Enhancements:
|
215
|
+
* RDoc now knows about meta-programmed methods, see RDoc::Parser::Ruby
|
216
|
+
* Reorganized parsers under RDoc::Parser base class
|
217
|
+
* ri now walks the ancestors of a class looking for a method e.g. ri
|
218
|
+
File#read displays documentation for IO#read (may require regeneration of
|
219
|
+
ri data)
|
220
|
+
* 5 Minor Enhancements:
|
221
|
+
* Allow links to files
|
222
|
+
* Default options now taken from RDOCOPT environment variable
|
223
|
+
* Class method documentation can be found at toplevel now (def X.foo)
|
224
|
+
* Allow HTML templates distributed as gems to be loaded with the -T option,
|
225
|
+
just like the standard templates in rdoc/generator/html (so an HTML
|
226
|
+
template lib/new_template.rb in a gem can be used with rdoc -T new_template)
|
227
|
+
* `rdoc -v` prints out files, classes, modules and methods as it goes
|
228
|
+
* 11 Bug Fixes:
|
229
|
+
* `ri Foo.bar` now looks for class methods also
|
230
|
+
* Sections work in the default template again
|
231
|
+
* Doesn't warn about :foo:: list item being an unrecognized directive
|
232
|
+
* RDoc no longer converts characters inside tt tags
|
233
|
+
* Fixed "unitialized constant RDoc::Markup::ToHtml::HTML"
|
234
|
+
* Fixed generation of relative links
|
235
|
+
* Fixed various diagram generation issues
|
236
|
+
* Fixed templates broken by switch to erb
|
237
|
+
* Fixed issue with <!-- --> style comments
|
238
|
+
* Lowercase words are no longer rdoc'd as methods without leading #, as
|
239
|
+
described in the documentation
|
240
|
+
* RDoc now correctly sets superclasses if they were originally unknown
|
241
|
+
|
242
|
+
=== 2.0.0 / 2008-04-10
|
243
|
+
|
244
|
+
* 3 Major Enhancements:
|
245
|
+
* Renamespaced everything RDoc under the RDoc module.
|
246
|
+
* New `ri` implementation.
|
247
|
+
* Reads from a cache in ~/.ri/ for enhanced speed.
|
248
|
+
* RubyGems aware, only searches latest gem versions.
|
249
|
+
* Now up to over 100 tests and 200 assertions.
|
250
|
+
* 4 Minor Enhancements:
|
251
|
+
* Switched to an ERb-based TemplatePage, see RDoc::TemplatePage.
|
252
|
+
* Class/module ri now displays attribute and constant comments.
|
253
|
+
* Cross-references can be disabled with a leading \.
|
254
|
+
* Relaxed parsing for some RDoc inline markup.
|
data/rdoc/Manifest.txt
ADDED
@@ -0,0 +1,126 @@
|
|
1
|
+
.autotest
|
2
|
+
.document
|
3
|
+
History.txt
|
4
|
+
Manifest.txt
|
5
|
+
README.txt
|
6
|
+
RI.txt
|
7
|
+
Rakefile
|
8
|
+
bin/rdoc
|
9
|
+
bin/ri
|
10
|
+
lib/rdoc.rb
|
11
|
+
lib/rdoc/alias.rb
|
12
|
+
lib/rdoc/anon_class.rb
|
13
|
+
lib/rdoc/any_method.rb
|
14
|
+
lib/rdoc/attr.rb
|
15
|
+
lib/rdoc/cache.rb
|
16
|
+
lib/rdoc/class_module.rb
|
17
|
+
lib/rdoc/code_object.rb
|
18
|
+
lib/rdoc/code_objects.rb
|
19
|
+
lib/rdoc/constant.rb
|
20
|
+
lib/rdoc/context.rb
|
21
|
+
lib/rdoc/diagram.rb
|
22
|
+
lib/rdoc/dot.rb
|
23
|
+
lib/rdoc/generator.rb
|
24
|
+
lib/rdoc/generator/darkfish.rb
|
25
|
+
lib/rdoc/generator/markup.rb
|
26
|
+
lib/rdoc/generator/ri.rb
|
27
|
+
lib/rdoc/generator/template/darkfish/.document
|
28
|
+
lib/rdoc/generator/template/darkfish/classpage.rhtml
|
29
|
+
lib/rdoc/generator/template/darkfish/filepage.rhtml
|
30
|
+
lib/rdoc/generator/template/darkfish/images/brick.png
|
31
|
+
lib/rdoc/generator/template/darkfish/images/brick_link.png
|
32
|
+
lib/rdoc/generator/template/darkfish/images/bug.png
|
33
|
+
lib/rdoc/generator/template/darkfish/images/bullet_black.png
|
34
|
+
lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png
|
35
|
+
lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png
|
36
|
+
lib/rdoc/generator/template/darkfish/images/date.png
|
37
|
+
lib/rdoc/generator/template/darkfish/images/find.png
|
38
|
+
lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif
|
39
|
+
lib/rdoc/generator/template/darkfish/images/macFFBgHack.png
|
40
|
+
lib/rdoc/generator/template/darkfish/images/package.png
|
41
|
+
lib/rdoc/generator/template/darkfish/images/page_green.png
|
42
|
+
lib/rdoc/generator/template/darkfish/images/page_white_text.png
|
43
|
+
lib/rdoc/generator/template/darkfish/images/page_white_width.png
|
44
|
+
lib/rdoc/generator/template/darkfish/images/plugin.png
|
45
|
+
lib/rdoc/generator/template/darkfish/images/ruby.png
|
46
|
+
lib/rdoc/generator/template/darkfish/images/tag_green.png
|
47
|
+
lib/rdoc/generator/template/darkfish/images/wrench.png
|
48
|
+
lib/rdoc/generator/template/darkfish/images/wrench_orange.png
|
49
|
+
lib/rdoc/generator/template/darkfish/images/zoom.png
|
50
|
+
lib/rdoc/generator/template/darkfish/index.rhtml
|
51
|
+
lib/rdoc/generator/template/darkfish/js/darkfish.js
|
52
|
+
lib/rdoc/generator/template/darkfish/js/jquery.js
|
53
|
+
lib/rdoc/generator/template/darkfish/js/quicksearch.js
|
54
|
+
lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js
|
55
|
+
lib/rdoc/generator/template/darkfish/rdoc.css
|
56
|
+
lib/rdoc/ghost_method.rb
|
57
|
+
lib/rdoc/include.rb
|
58
|
+
lib/rdoc/known_classes.rb
|
59
|
+
lib/rdoc/markup.rb
|
60
|
+
lib/rdoc/markup/attribute_manager.rb
|
61
|
+
lib/rdoc/markup/formatter.rb
|
62
|
+
lib/rdoc/markup/fragments.rb
|
63
|
+
lib/rdoc/markup/inline.rb
|
64
|
+
lib/rdoc/markup/lines.rb
|
65
|
+
lib/rdoc/markup/preprocess.rb
|
66
|
+
lib/rdoc/markup/to_flow.rb
|
67
|
+
lib/rdoc/markup/to_html.rb
|
68
|
+
lib/rdoc/markup/to_html_crossref.rb
|
69
|
+
lib/rdoc/markup/to_latex.rb
|
70
|
+
lib/rdoc/markup/to_test.rb
|
71
|
+
lib/rdoc/markup/to_texinfo.rb
|
72
|
+
lib/rdoc/meta_method.rb
|
73
|
+
lib/rdoc/normal_class.rb
|
74
|
+
lib/rdoc/normal_module.rb
|
75
|
+
lib/rdoc/options.rb
|
76
|
+
lib/rdoc/parser.rb
|
77
|
+
lib/rdoc/parser/c.rb
|
78
|
+
lib/rdoc/parser/perl.rb
|
79
|
+
lib/rdoc/parser/ruby.rb
|
80
|
+
lib/rdoc/parser/simple.rb
|
81
|
+
lib/rdoc/rdoc.rb
|
82
|
+
lib/rdoc/require.rb
|
83
|
+
lib/rdoc/ri.rb
|
84
|
+
lib/rdoc/ri/cache.rb
|
85
|
+
lib/rdoc/ri/descriptions.rb
|
86
|
+
lib/rdoc/ri/display.rb
|
87
|
+
lib/rdoc/ri/driver.rb
|
88
|
+
lib/rdoc/ri/formatter.rb
|
89
|
+
lib/rdoc/ri/paths.rb
|
90
|
+
lib/rdoc/ri/reader.rb
|
91
|
+
lib/rdoc/ri/util.rb
|
92
|
+
lib/rdoc/ri/writer.rb
|
93
|
+
lib/rdoc/single_class.rb
|
94
|
+
lib/rdoc/stats.rb
|
95
|
+
lib/rdoc/task.rb
|
96
|
+
lib/rdoc/tokenstream.rb
|
97
|
+
lib/rdoc/top_level.rb
|
98
|
+
test/binary.dat
|
99
|
+
test/test.ja.rdoc
|
100
|
+
test/test.ja.txt
|
101
|
+
test/test_attribute_manager.rb
|
102
|
+
test/test_rdoc_any_method.rb
|
103
|
+
test/test_rdoc_code_object.rb
|
104
|
+
test/test_rdoc_constant.rb
|
105
|
+
test/test_rdoc_context.rb
|
106
|
+
test/test_rdoc_include.rb
|
107
|
+
test/test_rdoc_markup.rb
|
108
|
+
test/test_rdoc_markup_attribute_manager.rb
|
109
|
+
test/test_rdoc_markup_to_html.rb
|
110
|
+
test/test_rdoc_markup_to_html_crossref.rb
|
111
|
+
test/test_rdoc_normal_module.rb
|
112
|
+
test/test_rdoc_parser.rb
|
113
|
+
test/test_rdoc_parser_c.rb
|
114
|
+
test/test_rdoc_parser_perl.rb
|
115
|
+
test/test_rdoc_parser_ruby.rb
|
116
|
+
test/test_rdoc_require.rb
|
117
|
+
test/test_rdoc_ri_attribute_formatter.rb
|
118
|
+
test/test_rdoc_ri_default_display.rb
|
119
|
+
test/test_rdoc_ri_driver.rb
|
120
|
+
test/test_rdoc_ri_formatter.rb
|
121
|
+
test/test_rdoc_ri_html_formatter.rb
|
122
|
+
test/test_rdoc_ri_overstrike_formatter.rb
|
123
|
+
test/test_rdoc_task.rb
|
124
|
+
test/test_rdoc_top_level.rb
|
125
|
+
test/xref_data.rb
|
126
|
+
test/xref_test_case.rb
|
data/rdoc/README.txt
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
= \RDoc
|
2
|
+
|
3
|
+
* {RDoc Project Page}[http://rubyforge.org/projects/rdoc/]
|
4
|
+
* {RDoc Documentation}[http://rdoc.rubyforge.org/]
|
5
|
+
* {RDoc Bug Tracker}[http://rubyforge.org/tracker/?atid=2472&group_id=627&func=browse]
|
6
|
+
|
7
|
+
== DESCRIPTION:
|
8
|
+
|
9
|
+
RDoc is an application that produces documentation for one or more Ruby source
|
10
|
+
files. RDoc includes the +rdoc+ and +ri+ tools for generating and displaying
|
11
|
+
online documentation.
|
12
|
+
|
13
|
+
At this point in time, RDoc 2.x is a work in progress and may incur further
|
14
|
+
API changes beyond what has been made to RDoc 1.0.1. Command-line tools are
|
15
|
+
largely unaffected, but internal APIs may shift rapidly.
|
16
|
+
|
17
|
+
See RDoc for a description of RDoc's markup and basic use.
|
18
|
+
|
19
|
+
== SYNOPSIS:
|
20
|
+
|
21
|
+
gem 'rdoc'
|
22
|
+
require 'rdoc/rdoc'
|
23
|
+
# ... see RDoc
|
24
|
+
|
25
|
+
== BUGS:
|
26
|
+
|
27
|
+
The markup engine has lots of little bugs. In particular:
|
28
|
+
* Escaping does not work for all markup.
|
29
|
+
* Typesetting is not always correct.
|
30
|
+
* Some output formats (ri, for example) do not correctly handle all of the
|
31
|
+
markup.
|
32
|
+
|
33
|
+
RDoc has some subtle bugs processing classes that are split across multiple
|
34
|
+
files (bugs that may or may not manifest depending on the order in which
|
35
|
+
the files are encountered). This issue can be tracked here[http://rubyforge.org/tracker/index.php?func=detail&aid=22135&group_id=627&atid=2475].
|
36
|
+
|
37
|
+
If you find a bug, please report it at the RDoc project's
|
38
|
+
tracker[http://rubyforge.org/tracker/?group_id=627] on RubyForge:
|
39
|
+
|
40
|
+
== LICENSE:
|
41
|
+
|
42
|
+
RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.
|
43
|
+
Portions (c) 2007-2009 Eric Hodel. Portions copyright others, see individual
|
44
|
+
files for details.
|
45
|
+
|
46
|
+
It is free software, and may be redistributed under the terms specified in the
|
47
|
+
README file of the Ruby distribution.
|
data/rdoc/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/rdoc/Rakefile
ADDED
@@ -0,0 +1,70 @@
|
|
1
|
+
require 'hoe'
|
2
|
+
|
3
|
+
$rdoc_rakefile = true
|
4
|
+
|
5
|
+
$:.unshift 'lib'
|
6
|
+
require 'rdoc'
|
7
|
+
|
8
|
+
Hoe.new "rdoc", RDoc::VERSION do |rdoc|
|
9
|
+
rdoc.developer 'Eric Hodel', 'drbrain@segment7.net'
|
10
|
+
rdoc.developer 'Dave Thomas', ''
|
11
|
+
rdoc.developer 'Phil Hagelberg', 'technomancy@gmail.com'
|
12
|
+
rdoc.developer 'Tony Strauss', 'tony.strauss@designingpatterns.com'
|
13
|
+
rdoc.remote_rdoc_dir = ''
|
14
|
+
|
15
|
+
rdoc.extra_dev_deps << ['minitest', '~> 1.3']
|
16
|
+
rdoc.spec_extras['required_rubygems_version'] = '>= 1.3'
|
17
|
+
rdoc.spec_extras['homepage'] = 'http://rdoc.rubyforge.org'
|
18
|
+
end
|
19
|
+
|
20
|
+
# These tasks expect to have the following directory structure:
|
21
|
+
#
|
22
|
+
# git/git.rubini.us/code # Rubinius git HEAD checkout
|
23
|
+
# svn/ruby/trunk # ruby subversion HEAD checkout
|
24
|
+
# svn/rdoc/trunk # RDoc subversion HEAD checkout
|
25
|
+
#
|
26
|
+
# If you don't have this directory structure, set RUBY_PATH and/or
|
27
|
+
# RUBINIUS_PATH.
|
28
|
+
|
29
|
+
diff_options = "-urpN --exclude '*svn*' --exclude '*swp' --exclude '*rbc'"
|
30
|
+
rsync_options = "-avP --exclude '*svn*' --exclude '*swp' --exclude '*rbc' --exclude '*.rej' --exclude '*.orig'"
|
31
|
+
|
32
|
+
rubinius_dir = ENV['RUBINIUS_PATH'] || '../../../git/git.rubini.us/code'
|
33
|
+
ruby_dir = ENV['RUBY_PATH'] || '../../ruby/trunk'
|
34
|
+
|
35
|
+
desc "Updates Ruby HEAD with the currently checked-out copy of RDoc."
|
36
|
+
task :update_ruby do
|
37
|
+
sh "rsync #{rsync_options} bin/rdoc #{ruby_dir}/bin/rdoc"
|
38
|
+
sh "rsync #{rsync_options} bin/ri #{ruby_dir}/bin/ri"
|
39
|
+
sh "rsync #{rsync_options} lib/ #{ruby_dir}/lib"
|
40
|
+
sh "rsync #{rsync_options} test/ #{ruby_dir}/test/rdoc"
|
41
|
+
end
|
42
|
+
|
43
|
+
desc "Diffs Ruby HEAD with the currently checked-out copy of RDoc."
|
44
|
+
task :diff_ruby do
|
45
|
+
options = "-urpN --exclude '*svn*' --exclude '*swp' --exclude '*rbc'"
|
46
|
+
|
47
|
+
sh "diff #{diff_options} bin/rdoc #{ruby_dir}/bin/rdoc; true"
|
48
|
+
sh "diff #{diff_options} bin/ri #{ruby_dir}/bin/ri; true"
|
49
|
+
sh "diff #{diff_options} lib/rdoc.rb #{ruby_dir}/lib/rdoc.rb; true"
|
50
|
+
sh "diff #{diff_options} lib/rdoc #{ruby_dir}/lib/rdoc; true"
|
51
|
+
sh "diff #{diff_options} test #{ruby_dir}/test/rdoc; true"
|
52
|
+
end
|
53
|
+
|
54
|
+
desc "Updates Rubinius HEAD with the currently checked-out copy of RDoc."
|
55
|
+
task :update_rubinius do
|
56
|
+
sh "rsync #{rsync_options} bin/rdoc #{rubinius_dir}/lib/bin/rdoc.rb"
|
57
|
+
sh "rsync #{rsync_options} bin/ri #{rubinius_dir}/lib/bin/ri.rb"
|
58
|
+
sh "rsync #{rsync_options} lib/ #{rubinius_dir}/lib"
|
59
|
+
sh "rsync #{rsync_options} test/ #{rubinius_dir}/test/rdoc"
|
60
|
+
end
|
61
|
+
|
62
|
+
desc "Diffs Rubinius HEAD with the currently checked-out copy of RDoc."
|
63
|
+
task :diff_rubinius do
|
64
|
+
sh "diff #{diff_options} bin/rdoc #{rubinius_dir}/lib/bin/rdoc.rb; true"
|
65
|
+
sh "diff #{diff_options} bin/ri #{rubinius_dir}/lib/bin/ri.rb; true"
|
66
|
+
sh "diff #{diff_options} lib/rdoc.rb #{rubinius_dir}/lib/rdoc.rb; true"
|
67
|
+
sh "diff #{diff_options} lib/rdoc #{rubinius_dir}/lib/rdoc; true"
|
68
|
+
sh "diff #{diff_options} test #{rubinius_dir}/test/rdoc; true"
|
69
|
+
end
|
70
|
+
|
data/rdoc/bin/rdoc
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
#
|
3
|
+
# RDoc: Documentation tool for source code
|
4
|
+
# (see lib/rdoc/rdoc.rb for more information)
|
5
|
+
#
|
6
|
+
# Copyright (c) 2003 Dave Thomas
|
7
|
+
# Released under the same terms as Ruby
|
8
|
+
#
|
9
|
+
# $Revision: 15033 $
|
10
|
+
|
11
|
+
require 'rdoc/rdoc'
|
12
|
+
|
13
|
+
begin
|
14
|
+
r = RDoc::RDoc.new
|
15
|
+
r.document ARGV
|
16
|
+
rescue Interrupt
|
17
|
+
$stderr.puts
|
18
|
+
$stderr.puts "Interrupted"
|
19
|
+
exit 1
|
20
|
+
rescue SystemExit
|
21
|
+
raise
|
22
|
+
rescue Exception => e
|
23
|
+
if $DEBUG_RDOC then
|
24
|
+
$stderr.puts e.message
|
25
|
+
$stderr.puts "#{e.backtrace.join "\n\t"}"
|
26
|
+
$stderr.puts
|
27
|
+
else
|
28
|
+
$stderr.puts "uh-oh! RDoc had a problem:"
|
29
|
+
$stderr.puts e.message
|
30
|
+
$stderr.puts
|
31
|
+
$stderr.puts "run with --debug for full backtrace"
|
32
|
+
end
|
33
|
+
exit 1
|
34
|
+
end
|
35
|
+
|
data/rdoc/bin/ri
ADDED
@@ -0,0 +1,54 @@
|
|
1
|
+
require 'rdoc/code_object'
|
2
|
+
|
3
|
+
##
|
4
|
+
# Represent an alias, which is an old_name/new_name pair associated with a
|
5
|
+
# particular context
|
6
|
+
|
7
|
+
class RDoc::Alias < RDoc::CodeObject
|
8
|
+
|
9
|
+
##
|
10
|
+
# Allow comments to be overridden
|
11
|
+
|
12
|
+
attr_writer :comment
|
13
|
+
|
14
|
+
##
|
15
|
+
# Aliased name
|
16
|
+
|
17
|
+
attr_accessor :new_name
|
18
|
+
|
19
|
+
##
|
20
|
+
# Aliasee's name
|
21
|
+
|
22
|
+
attr_accessor :old_name
|
23
|
+
|
24
|
+
##
|
25
|
+
# Source file token stream
|
26
|
+
|
27
|
+
attr_accessor :text
|
28
|
+
|
29
|
+
##
|
30
|
+
# Creates a new Alias with a token stream of +text+ that aliases +old_name+
|
31
|
+
# to +new_name+ and has +comment+
|
32
|
+
|
33
|
+
def initialize(text, old_name, new_name, comment)
|
34
|
+
super()
|
35
|
+
@text = text
|
36
|
+
@old_name = old_name
|
37
|
+
@new_name = new_name
|
38
|
+
self.comment = comment
|
39
|
+
end
|
40
|
+
|
41
|
+
def inspect # :nodoc:
|
42
|
+
"#<%s:0x%x %s.alias_method %s, %s>" % [
|
43
|
+
self.class, object_id,
|
44
|
+
parent.name, @old_name, @new_name,
|
45
|
+
]
|
46
|
+
end
|
47
|
+
|
48
|
+
def to_s # :nodoc:
|
49
|
+
"alias: #{self.old_name} -> #{self.new_name}\n#{self.comment}"
|
50
|
+
end
|
51
|
+
|
52
|
+
end
|
53
|
+
|
54
|
+
|