rdoc 3.1 → 6.3.3
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.
- checksums.yaml +7 -0
- data/CONTRIBUTING.rdoc +220 -0
- data/CVE-2013-0256.rdoc +49 -0
- data/ExampleMarkdown.md +37 -0
- data/ExampleRDoc.rdoc +208 -0
- data/Gemfile +12 -0
- data/History.rdoc +1666 -0
- data/LEGAL.rdoc +50 -0
- data/LICENSE.rdoc +57 -0
- data/README.rdoc +129 -0
- data/RI.rdoc +57 -0
- data/Rakefile +84 -81
- data/TODO.rdoc +59 -0
- data/bin/console +7 -0
- data/bin/setup +6 -0
- data/{bin → exe}/rdoc +11 -2
- data/exe/ri +12 -0
- data/lib/rdoc/alias.rb +1 -2
- data/lib/rdoc/anon_class.rb +3 -2
- data/lib/rdoc/any_method.rb +234 -40
- data/lib/rdoc/attr.rb +79 -11
- data/lib/rdoc/class_module.rb +443 -71
- data/lib/rdoc/code_object.rb +216 -20
- data/lib/rdoc/code_objects.rb +4 -21
- data/lib/rdoc/comment.rb +250 -0
- data/lib/rdoc/constant.rb +110 -9
- data/lib/rdoc/context/section.rb +232 -0
- data/lib/rdoc/context.rb +392 -172
- data/lib/rdoc/cross_reference.rb +202 -0
- data/lib/rdoc/encoding.rb +83 -28
- data/lib/rdoc/erb_partial.rb +19 -0
- data/lib/rdoc/erbio.rb +8 -3
- data/lib/rdoc/extend.rb +10 -0
- data/lib/rdoc/generator/darkfish.rb +507 -84
- data/lib/rdoc/generator/json_index.rb +300 -0
- data/lib/rdoc/generator/markup.rb +27 -74
- data/lib/rdoc/generator/pot/message_extractor.rb +68 -0
- data/lib/rdoc/generator/pot/po.rb +84 -0
- data/lib/rdoc/generator/pot/po_entry.rb +141 -0
- data/lib/rdoc/generator/pot.rb +98 -0
- data/lib/rdoc/generator/ri.rb +8 -62
- data/lib/rdoc/generator/template/darkfish/_footer.rhtml +5 -0
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +22 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +19 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +9 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +15 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +9 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +15 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +15 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +12 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml +11 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +12 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +11 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +14 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +11 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +18 -0
- data/lib/rdoc/generator/template/darkfish/class.rhtml +172 -0
- data/lib/rdoc/generator/template/darkfish/css/fonts.css +167 -0
- data/lib/rdoc/generator/template/darkfish/css/rdoc.css +639 -0
- data/lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf +0 -0
- data/lib/rdoc/generator/template/darkfish/images/add.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/arrow_up.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/delete.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/tag_blue.png +0 -0
- data/lib/rdoc/generator/template/darkfish/images/transparent.png +0 -0
- data/lib/rdoc/generator/template/darkfish/index.rhtml +18 -60
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +51 -83
- data/lib/rdoc/generator/template/darkfish/js/search.js +110 -0
- data/lib/rdoc/generator/template/darkfish/page.rhtml +18 -0
- data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +18 -0
- data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +62 -0
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +58 -0
- data/lib/rdoc/generator/template/json_index/.document +1 -0
- data/lib/rdoc/generator/template/json_index/js/navigation.js +105 -0
- data/lib/rdoc/generator/template/json_index/js/searcher.js +229 -0
- data/lib/rdoc/generator.rb +24 -13
- data/lib/rdoc/ghost_method.rb +1 -2
- data/lib/rdoc/i18n/locale.rb +102 -0
- data/lib/rdoc/i18n/text.rb +126 -0
- data/lib/rdoc/i18n.rb +10 -0
- data/lib/rdoc/include.rb +5 -95
- data/lib/rdoc/known_classes.rb +5 -2
- data/lib/rdoc/markdown/entities.rb +2132 -0
- data/lib/rdoc/markdown/literals.kpeg +23 -0
- data/lib/rdoc/markdown/literals.rb +416 -0
- data/lib/rdoc/markdown.kpeg +1237 -0
- data/lib/rdoc/markdown.rb +16684 -0
- data/lib/rdoc/markup/attr_changer.rb +23 -0
- data/lib/rdoc/markup/attr_span.rb +36 -0
- data/lib/rdoc/markup/attribute_manager.rb +135 -62
- data/lib/rdoc/markup/attributes.rb +71 -0
- data/lib/rdoc/markup/blank_line.rb +1 -0
- data/lib/rdoc/markup/block_quote.rb +15 -0
- data/lib/rdoc/markup/document.rb +96 -9
- data/lib/rdoc/markup/formatter.rb +138 -25
- data/lib/rdoc/markup/hard_break.rb +32 -0
- data/lib/rdoc/markup/heading.rb +61 -2
- data/lib/rdoc/markup/include.rb +43 -0
- data/lib/rdoc/markup/indented_paragraph.rb +48 -0
- data/lib/rdoc/markup/list.rb +25 -4
- data/lib/rdoc/markup/list_item.rb +18 -4
- data/lib/rdoc/markup/paragraph.rb +15 -0
- data/lib/rdoc/markup/parser.rb +180 -88
- data/lib/rdoc/markup/pre_process.rb +183 -38
- data/lib/rdoc/markup/raw.rb +6 -5
- data/lib/rdoc/markup/regexp_handling.rb +41 -0
- data/lib/rdoc/markup/rule.rb +1 -0
- data/lib/rdoc/markup/table.rb +47 -0
- data/lib/rdoc/markup/to_ansi.rb +17 -7
- data/lib/rdoc/markup/to_bs.rb +5 -8
- data/lib/rdoc/markup/to_html.rb +238 -137
- data/lib/rdoc/markup/to_html_crossref.rb +125 -152
- data/lib/rdoc/markup/to_html_snippet.rb +285 -0
- data/lib/rdoc/markup/to_joined_paragraph.rb +47 -0
- data/lib/rdoc/markup/to_label.rb +75 -0
- data/lib/rdoc/markup/to_markdown.rb +192 -0
- data/lib/rdoc/markup/to_rdoc.rb +85 -15
- data/lib/rdoc/markup/to_table_of_contents.rb +89 -0
- data/lib/rdoc/markup/to_test.rb +2 -4
- data/lib/rdoc/markup/to_tt_only.rb +121 -0
- data/lib/rdoc/markup/verbatim.rb +39 -0
- data/lib/rdoc/markup.rb +388 -110
- data/lib/rdoc/meta_method.rb +1 -2
- data/lib/rdoc/method_attr.rb +87 -21
- data/lib/rdoc/mixin.rb +121 -0
- data/lib/rdoc/normal_class.rb +39 -10
- data/lib/rdoc/normal_module.rb +22 -7
- data/lib/rdoc/options.rb +613 -73
- data/lib/rdoc/parser/c.rb +621 -287
- data/lib/rdoc/parser/changelog.rb +335 -0
- data/lib/rdoc/parser/markdown.rb +24 -0
- data/lib/rdoc/parser/rd.rb +23 -0
- data/lib/rdoc/parser/ripper_state_lex.rb +590 -0
- data/lib/rdoc/parser/ruby.rb +1368 -762
- data/lib/rdoc/parser/ruby_tools.rb +42 -35
- data/lib/rdoc/parser/simple.rb +23 -11
- data/lib/rdoc/parser/text.rb +12 -0
- data/lib/rdoc/parser.rb +162 -89
- data/lib/rdoc/rd/block_parser.rb +1056 -0
- data/lib/rdoc/rd/block_parser.ry +639 -0
- data/lib/rdoc/rd/inline.rb +72 -0
- data/lib/rdoc/rd/inline_parser.rb +1208 -0
- data/lib/rdoc/rd/inline_parser.ry +593 -0
- data/lib/rdoc/rd.rb +100 -0
- data/lib/rdoc/rdoc.rb +208 -115
- data/lib/rdoc/require.rb +1 -2
- data/lib/rdoc/ri/driver.rb +734 -239
- data/lib/rdoc/ri/formatter.rb +1 -0
- data/lib/rdoc/ri/paths.rb +91 -48
- data/lib/rdoc/ri/store.rb +3 -261
- data/lib/rdoc/ri/task.rb +71 -0
- data/lib/rdoc/ri.rb +5 -2
- data/lib/rdoc/rubygems_hook.rb +246 -0
- data/lib/rdoc/servlet.rb +451 -0
- data/lib/rdoc/single_class.rb +14 -2
- data/lib/rdoc/stats/normal.rb +19 -12
- data/lib/rdoc/stats/quiet.rb +1 -0
- data/lib/rdoc/stats/verbose.rb +1 -0
- data/lib/rdoc/stats.rb +262 -104
- data/lib/rdoc/store.rb +979 -0
- data/lib/rdoc/task.rb +84 -44
- data/lib/rdoc/text.rb +117 -72
- data/lib/rdoc/token_stream.rb +73 -4
- data/lib/rdoc/tom_doc.rb +263 -0
- data/lib/rdoc/top_level.rb +111 -261
- data/lib/rdoc/version.rb +8 -0
- data/lib/rdoc.rb +127 -64
- data/man/ri.1 +247 -0
- data/rdoc.gemspec +249 -0
- metadata +171 -291
- data/.autotest +0 -16
- data/.document +0 -5
- data/History.txt +0 -594
- data/LICENSE.txt +0 -57
- data/Manifest.txt +0 -158
- data/README.txt +0 -45
- data/RI.txt +0 -58
- data/bin/ri +0 -5
- data/lib/rdoc/gauntlet.rb +0 -52
- data/lib/rdoc/generator/template/darkfish/classpage.rhtml +0 -296
- data/lib/rdoc/generator/template/darkfish/filepage.rhtml +0 -124
- data/lib/rdoc/generator/template/darkfish/js/jquery.js +0 -32
- data/lib/rdoc/generator/template/darkfish/js/quicksearch.js +0 -114
- data/lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js +0 -10
- data/lib/rdoc/generator/template/darkfish/rdoc.css +0 -706
- data/lib/rdoc/markup/formatter_test_case.rb +0 -689
- data/lib/rdoc/markup/inline.rb +0 -137
- data/lib/rdoc/markup/text_formatter_test_case.rb +0 -116
- data/lib/rdoc/ruby_lex.rb +0 -1291
- data/lib/rdoc/ruby_token.rb +0 -416
- data/test/README +0 -1
- data/test/binary.dat +0 -0
- data/test/hidden.zip.txt +0 -1
- data/test/test.ja.rdoc +0 -10
- data/test/test.ja.txt +0 -8
- data/test/test.txt +0 -1
- data/test/test_attribute_manager.rb +0 -120
- data/test/test_rdoc_alias.rb +0 -13
- data/test/test_rdoc_any_method.rb +0 -126
- data/test/test_rdoc_attr.rb +0 -61
- data/test/test_rdoc_class_module.rb +0 -233
- data/test/test_rdoc_code_object.rb +0 -165
- data/test/test_rdoc_constant.rb +0 -15
- data/test/test_rdoc_context.rb +0 -370
- data/test/test_rdoc_encoding.rb +0 -166
- data/test/test_rdoc_generator_darkfish.rb +0 -119
- data/test/test_rdoc_generator_ri.rb +0 -76
- data/test/test_rdoc_include.rb +0 -96
- data/test/test_rdoc_markup.rb +0 -37
- data/test/test_rdoc_markup_attribute_manager.rb +0 -240
- data/test/test_rdoc_markup_document.rb +0 -51
- data/test/test_rdoc_markup_paragraph.rb +0 -9
- data/test/test_rdoc_markup_parser.rb +0 -1395
- data/test/test_rdoc_markup_pre_process.rb +0 -185
- data/test/test_rdoc_markup_raw.rb +0 -27
- data/test/test_rdoc_markup_to_ansi.rb +0 -328
- data/test/test_rdoc_markup_to_bs.rb +0 -341
- data/test/test_rdoc_markup_to_html.rb +0 -335
- data/test/test_rdoc_markup_to_html_crossref.rb +0 -169
- data/test/test_rdoc_markup_to_rdoc.rb +0 -327
- data/test/test_rdoc_method_attr.rb +0 -122
- data/test/test_rdoc_normal_class.rb +0 -17
- data/test/test_rdoc_normal_module.rb +0 -31
- data/test/test_rdoc_options.rb +0 -342
- data/test/test_rdoc_parser.rb +0 -83
- data/test/test_rdoc_parser_c.rb +0 -912
- data/test/test_rdoc_parser_ruby.rb +0 -1754
- data/test/test_rdoc_parser_simple.rb +0 -99
- data/test/test_rdoc_rdoc.rb +0 -164
- data/test/test_rdoc_require.rb +0 -25
- data/test/test_rdoc_ri_driver.rb +0 -846
- data/test/test_rdoc_ri_paths.rb +0 -43
- data/test/test_rdoc_ri_store.rb +0 -352
- data/test/test_rdoc_ruby_lex.rb +0 -23
- data/test/test_rdoc_stats.rb +0 -38
- data/test/test_rdoc_task.rb +0 -92
- data/test/test_rdoc_text.rb +0 -251
- data/test/test_rdoc_top_level.rb +0 -120
- data/test/xref_data.rb +0 -62
- data/test/xref_test_case.rb +0 -61
- data.tar.gz.sig +0 -3
- metadata.gz.sig +0 -0
data/History.txt
DELETED
@@ -1,594 +0,0 @@
|
|
1
|
-
=== 3.1 / 2010-12-28
|
2
|
-
|
3
|
-
RDoc has moved to github. Releases after 3.1 reference github unless
|
4
|
-
otherwise noted.
|
5
|
-
|
6
|
-
* Minor enhancements
|
7
|
-
* RDoc::Task now features a #generator option to choose an alternate
|
8
|
-
generator. Pull Request #2 by Erik Hollensbe.
|
9
|
-
* Enhanced test for RDoc::Parser::binary? RubyForge patch #28538 by Eito
|
10
|
-
Katagiri.
|
11
|
-
* Generator list in --help is no longer static. Generator description comes
|
12
|
-
from the generator's DESCRIPTION constant.
|
13
|
-
* Documentation summary is now displayed with dynamic width.
|
14
|
-
* Bug fixes
|
15
|
-
* Strip encoding comment from input to avoid overriding file comment.
|
16
|
-
RubyForge Bug #22113 by James Gray.
|
17
|
-
* Restore call-seq parsing behavior when the call-seq is the only comment.
|
18
|
-
RubyForge Bug #26290 by Sylvain Joyeux.
|
19
|
-
* Coverage report no longer crashes for constant aliases. Pull Request #1
|
20
|
-
by Andy Lindeman.
|
21
|
-
* RDoc no longer looses ghost methods when followed by certain tokens.
|
22
|
-
RubyForge bug #27793 by Aaron Patterson.
|
23
|
-
* RDoc no longer crashes in ri if HOME is not set. Ruby Bug #4202 by
|
24
|
-
Shyouhei Urabe.
|
25
|
-
* ri no longer crashes with HTML format output. RubyForge bug #28675 by
|
26
|
-
7rans.
|
27
|
-
* RDoc::Markup::ToHtml#gen_url now initializes #from_path to ''.
|
28
|
-
Additionally, #from_path is now settable. RubyForge bug #27838 by Claus
|
29
|
-
Folke Brobak.
|
30
|
-
* Comments in the C parser ar enow normalized before being combined.
|
31
|
-
RubyForge patch #28646 by Sven Herzberg.
|
32
|
-
* RDoc::Parser::C no longer requires a comment and finds more method bodies.
|
33
|
-
RubyForge patch #28643 by Sven Herzberg.
|
34
|
-
* Darkfish now has a "Class/Module Index" instead of a "Class Index".
|
35
|
-
RubyForge patch #28364 by James Tucker.
|
36
|
-
* RDoc::Parser::Ruby now parses negative numbers correctly. RubyForge patch
|
37
|
-
#28544 by Eito Katagiri.
|
38
|
-
|
39
|
-
=== 3.0.1 / 2010-12-19
|
40
|
-
|
41
|
-
* Bug fix
|
42
|
-
* RDoc no longer has a Perl parser.
|
43
|
-
|
44
|
-
=== 3.0 / 2010-12-19
|
45
|
-
|
46
|
-
Special thanks to Thierry Lambert for massive improvements to RDoc.
|
47
|
-
|
48
|
-
* Major enhancements
|
49
|
-
* Ruby 1.8.6 is no longer supported by RDoc.
|
50
|
-
* RDoc now converts input files to a single encoding specified by
|
51
|
-
<tt>--encoding</tt>. See RDoc::RDoc and RDoc::Options#encoding.
|
52
|
-
<tt>--encoding</tt> is now preferred over <tt>--charset</tt>
|
53
|
-
* RDoc now supports a <tt>--coverage-report</tt> flag (also <tt>-C</tt> and
|
54
|
-
<tt>--dcov</tt>) that outputs a report on items lacking documentation.
|
55
|
-
* Templates (<tt>rdoc -T</tt>) are now checked for existence in
|
56
|
-
RDoc::Options. Generator authors can now use RDoc::Options#template_dir
|
57
|
-
which is the full path to the template directory.
|
58
|
-
* Added support for class aliases. Patch by Thierry Lambert.
|
59
|
-
* Improved merging of classes and modules across multiple files including
|
60
|
-
more accurate documentation statistics. Patch by Thierry Lambert.
|
61
|
-
* Improved handling of method aliases. Patch by Thierry Lambert.
|
62
|
-
* Improved handling of visibility of RDoc code objects. Patch by Thierry
|
63
|
-
Lambert.
|
64
|
-
* RDoc::Attr#type is now RDoc::Attr#definition. Patch by Thierry Lambert.
|
65
|
-
* Removed TimeConstantMethods
|
66
|
-
* RDoc now calls ::new instead of ::for on generators.
|
67
|
-
* Minor enhancements
|
68
|
-
* Added rdoc arguments <tt>--dry-run</tt>, <tt>--all</tt>,
|
69
|
-
<tt>--visibility</tt>, <tt>--force-output</tt>, <tt>--hyperlink-all</tt>.
|
70
|
-
Patch by Thierry Lambert.
|
71
|
-
* RDoc::Markup::FormatterTestCase has been expanded. Patch by Thierry
|
72
|
-
Lambert.
|
73
|
-
* RDoc::Markup::TextFormatterTestCase has been extracted from RDoc tests.
|
74
|
-
Patch by Thierry Lambert.
|
75
|
-
* Various RDoc::Parser::Ruby enhancements. Patch by Thierry Lambert.
|
76
|
-
* Various RDoc::Markup::Parser enhancements. Patch by Thierry Lambert.
|
77
|
-
* RDoc::Parser::binary? is more robust now that it uses Encoding.
|
78
|
-
* Deprecated rdoc arguments are now explicitly mentioned in rdoc command
|
79
|
-
output. Patch by Thierry Lambert.
|
80
|
-
* Constant values are formatted more accurately. Patch by Thierry Lambert.
|
81
|
-
* Enhanced call-seq parsing in RDoc::Parser::C. Patch by Thierry Lambert.
|
82
|
-
* RDoc no longer uses kw, cmt, re or str classes for embedded source code
|
83
|
-
snippets. Patch by Thierry Lambert.
|
84
|
-
* RDoc directives may now be escaped with a leading '\\'. Patch by Thierry
|
85
|
-
Lambert.
|
86
|
-
* RDoc note lists (<tt>label::</tt>) now generate a table with class
|
87
|
-
"rdoc-list". Patch by Thierry Lambert.
|
88
|
-
* RDoc markup documentation has been moved to RDoc::Markup including notes
|
89
|
-
on how to document source code.
|
90
|
-
* An RDoc::Require is now always listed at the file level. Patch by Thierry
|
91
|
-
Lambert.
|
92
|
-
* RDoc::CodeObjects now know which file they were defined in.
|
93
|
-
* RDoc::Options calls ::setup_options on the generator class specified by
|
94
|
-
<tt>--format</tt>. See RDoc::Options::setup_generator.
|
95
|
-
* rdoc gives an error when multiple formats are given.
|
96
|
-
* Files with erb inside will no longer trip RDoc::Parser::binary?
|
97
|
-
* Last <tt>--title</tt> wins. Patch by Thierry Lambert.
|
98
|
-
* Better block params handling. Patch by Thierry Lambert.
|
99
|
-
* Moved rdoc/tokenstream.rb to rdoc/token_stream.rb.
|
100
|
-
* Moved rdoc/markup/preprocess.rb to rdoc/markup/pre_process.rb.
|
101
|
-
* Removed "':' not followed by operator or identifier" warning for new Hash
|
102
|
-
syntax.
|
103
|
-
* rb_attr() is now supported for attributes.
|
104
|
-
* RDoc::Parser::C now supports yields, doc, and args directives like
|
105
|
-
RDoc::Parser::Ruby.
|
106
|
-
* Moved RDoc::Parser::PerlPOD to the rdoc-perl_pod gem.
|
107
|
-
* Bug fixes
|
108
|
-
* RDoc::Generator tests no longer require any installed RDoc on Ruby 1.9
|
109
|
-
* Load existing cache before generating ri. Ruby r27749 by NAKAMURA Usaku.
|
110
|
-
* RDoc now handles BOM. Ruby r28062 by Nobuyoshi Nakada.
|
111
|
-
* Use proper XML encoding for darkfish classpage. Ruby r28083 by NARUSE,
|
112
|
-
Yui.
|
113
|
-
* Fix ri output when special characters are inside html tags. Patch by Tomo
|
114
|
-
Kazahaya, Ruby Bug #3512.
|
115
|
-
* Don't bother checking if the pager exists, it's already done. Ruby r28842
|
116
|
-
by NAKAMURA Usaku.
|
117
|
-
* RDoc::Parser::Ruby now ignores non-constant-named singleton classes. Ruby
|
118
|
-
r29140 by Nobuyoshi Nakada. Ruby Bug #3759.
|
119
|
-
* RDoc::Parser::Ruby call args no longer include assignment. Ruby r29141 by
|
120
|
-
Nobuyoshi Nakada. Ruby Bug #3759
|
121
|
-
* Handle $HOME being unset in ri. Ruby r29272 by Nobuyoshi Nakada.
|
122
|
-
* uniq ancestors and modules too. Ruby r29312 by Nobuyoshi Nakada.
|
123
|
-
* RDoc now knows about Encoding by default. Ruby r29356 by Nobuyoshi
|
124
|
-
Nakada.
|
125
|
-
* ri now defaults to the backspace formatter when piped. Use RI environment
|
126
|
-
variable or options to override. Ruby r28455 by Yusuke Endoh.
|
127
|
-
* __send__ and friends no longer get their underscores removed. Patch by
|
128
|
-
Thierry Lambert.
|
129
|
-
* The C parser now makes new public when promoting initialize.
|
130
|
-
* Fix crash in #markup_code for TkUnknownChar.
|
131
|
-
* Fix crash in RDoc::Parser::C when aliasing methods with Regexp special
|
132
|
-
characters.
|
133
|
-
* Fix crash when various operators are used as a name as in
|
134
|
-
<tt>alias * compose</tt>.
|
135
|
-
* Fix warning with some dynamic use of <tt>attr_*</tt>
|
136
|
-
* Methods added to true, false and nil are now documented.
|
137
|
-
* Remove warning for methods defined on globals.
|
138
|
-
|
139
|
-
=== 2.5.11 / 2010-08-20
|
140
|
-
|
141
|
-
* Minor Enhancements
|
142
|
-
* Alias comments are now discovered by the C parser. Reported by Jeremy
|
143
|
-
Evans.
|
144
|
-
* Removed --all option which is unused in RDoc. Use the nodoc or
|
145
|
-
stopdoc/startdoc directives to suppress documentation instead.
|
146
|
-
|
147
|
-
=== 2.5.10 / 2010-08-17
|
148
|
-
|
149
|
-
* Minor Enhancements
|
150
|
-
* Support rb_singleton_class(). Reported by Jeremy Evans.
|
151
|
-
* Support rb_define_private_method() on rb_singleton_class(). Reported by
|
152
|
-
Jeremy Evans.
|
153
|
-
|
154
|
-
* Bug Fixes
|
155
|
-
* Treat non-ASCII RDoc files as text. Bug #28391 by Kouhei Sutou.
|
156
|
-
* Fix potential test failures due to ivar collision. Bug #28390 by Kouhei
|
157
|
-
Sutou.
|
158
|
-
* Added duck-typed #aref for RDoc::Attr to RDoc::AnyMethod. Bug #28375 by
|
159
|
-
Erik Hollensbe
|
160
|
-
* Fixed method references in HTML output when show_hash is false.
|
161
|
-
* Fixed comments with '.' in call-seq in C sources. Reported by Jeremy
|
162
|
-
Evans.
|
163
|
-
* RDoc now understands singleton aliases. Reported by Jeremy Evans.
|
164
|
-
|
165
|
-
=== 2.5.9 / 2010-07-06
|
166
|
-
|
167
|
-
* Bug Fixes
|
168
|
-
* Look up pager correctly.
|
169
|
-
* Fixed handling of bullets in verbatim sections. Partial patch by
|
170
|
-
Juha-Jarmo Heinonen.
|
171
|
-
|
172
|
-
=== 2.5.8 / 2010-04-27
|
173
|
-
|
174
|
-
*NOTE*:
|
175
|
-
|
176
|
-
RDoc 2.5 did not save method parameters, so you should upgrade your rdoc-data
|
177
|
-
gem to a version >= 2.5.3.
|
178
|
-
|
179
|
-
To have ri data for core and stdlib you'll need to:
|
180
|
-
|
181
|
-
gem install rdoc-data
|
182
|
-
|
183
|
-
then run:
|
184
|
-
|
185
|
-
rdoc-data --install
|
186
|
-
|
187
|
-
To have ri data for you gems you'll also need to run:
|
188
|
-
|
189
|
-
gem rdoc --all --overwrite
|
190
|
-
|
191
|
-
If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
192
|
-
|
193
|
-
* Bug Fixes
|
194
|
-
* ri no longer complains about nonexistent pagers.
|
195
|
-
* Fixed failing test
|
196
|
-
|
197
|
-
=== 2.5.7 / 2010-04-22
|
198
|
-
|
199
|
-
* Minor Enhancements
|
200
|
-
* Unrecognized RDoc directives can now be registered by a plugin for
|
201
|
-
handling. See RDoc::Markup::PreProcess.
|
202
|
-
* Added RDoc::Markup::Raw to allow other markup engines to dump raw content
|
203
|
-
into RDoc.
|
204
|
-
* Bug Fixes
|
205
|
-
* rdoc -p no longer means --pipe if files are also given.
|
206
|
-
* RDoc now knows about BasicObject by default. Ruby Bug #1318 by Ambrus Zsbán
|
207
|
-
|
208
|
-
=== 2.5.6 / 2010-04-22
|
209
|
-
|
210
|
-
* Minor Enhancements
|
211
|
-
* Unrecognized RDoc directives are added as metadata to the object they get
|
212
|
-
attached to.
|
213
|
-
|
214
|
-
##
|
215
|
-
# :my_new_directive: my cool value
|
216
|
-
|
217
|
-
Results in a 'my_new_directive' metadata key with value 'my cool value' on
|
218
|
-
the RDoc::CodeObject it is for
|
219
|
-
* Bug Fixes
|
220
|
-
* RDoc no longer prints out "invalid options:" when there were no invalid
|
221
|
-
options.
|
222
|
-
* Fixed link size on Darkfish file pages
|
223
|
-
|
224
|
-
=== 2.5.5 / 2010-04-19
|
225
|
-
|
226
|
-
* 1 Minor Enhancement
|
227
|
-
* Use #binread in RDoc::Markup::PreProcess. Patch from ruby trunk.
|
228
|
-
* 3 Bug Fixes
|
229
|
-
* Fixed indentation of method-description lists in Darkfish. Bug #28081 by
|
230
|
-
Theresa Dwinnell.
|
231
|
-
* Fixed loading RDoc::AnyMethod aliases to no longer infinitely loop. Bug
|
232
|
-
#28107 by Sven Riedel
|
233
|
-
* Fixed handling of ignored invalid options to continue after the invalid
|
234
|
-
option.
|
235
|
-
|
236
|
-
=== 2.5.4 / 2010-04-18
|
237
|
-
|
238
|
-
* 2 Minor Enhancements
|
239
|
-
* Methods will now be cross-referenced when preceeded with ::. Ruby Bug
|
240
|
-
#3169 by Marc-Andre Lafortune.
|
241
|
-
* Methods now have human readable fragment identifiers for HTML output.
|
242
|
-
(#method-i-gsub vs #M000005). Ruby Bug #3023 by Marc-Andre Lafortune.
|
243
|
-
* 1 Bug Fixes
|
244
|
-
* RDoc::Parser::Ruby now handles <code>while begin a; b end # ...</code>.
|
245
|
-
Ruby Bug #3160 by Yusuke Endoh.
|
246
|
-
|
247
|
-
=== 2.5.3 / 2010-04-10
|
248
|
-
|
249
|
-
* 1 Minor Enhancement
|
250
|
-
* RDoc::Parser::Simple and the include directive remove coding: comment from
|
251
|
-
first line
|
252
|
-
* 2 Bug Fixes
|
253
|
-
* Fixed loading of created.rid when regenerating documentation. Ruby bug
|
254
|
-
#3121 by Yusuke Endoh.
|
255
|
-
* Compare times as Integers as created.rid doesn't store fractional times.
|
256
|
-
|
257
|
-
=== 2.5.2 / 2010-04-09
|
258
|
-
|
259
|
-
* 1 Minor Enhancement
|
260
|
-
* Imported various changes by Nobu from ruby trunk.
|
261
|
-
* 2 Bug Fixes
|
262
|
-
* RDoc parses files without extensions as text files again.
|
263
|
-
* RDoc::Parser::Ruby parses %{ strings correctly again.
|
264
|
-
|
265
|
-
=== 2.5.1 / 2010-04-06
|
266
|
-
|
267
|
-
* 1 Minor Enhancement
|
268
|
-
* RDoc::Parser::C now supports the include directive for classes and
|
269
|
-
modules.
|
270
|
-
* 6 Bug Fixes
|
271
|
-
* RDoc::AnyMethod params now get saved in ri data.
|
272
|
-
* ri now displays method arguments correctly.
|
273
|
-
* RDoc::Markup::Parser allows no space between = and header text like rdoc
|
274
|
-
2.4 and earlier.
|
275
|
-
* RDoc::Parser::C's "in" directive now looks in the current directory.
|
276
|
-
* RDoc::Task's rerdoc task no longer deletes the doc directory twice.
|
277
|
-
* rdoc --force-update now works correctly. Patch by Nobu Nokada
|
278
|
-
|
279
|
-
=== 2.5 / 2010-03-31
|
280
|
-
|
281
|
-
* 9 Major Enhancements
|
282
|
-
* Darkfish now has a "Home" button
|
283
|
-
* ri no longer displays the value of a constant. There's no easy way to
|
284
|
-
make them presentable. Use irb or ruby -e instead. Ruby Bug #549.
|
285
|
-
* New ri data format now uses Marshal and pre-builds caches
|
286
|
-
* No support for old ri data format, too hard to maintain
|
287
|
-
* To upgrade your core ri documentation, install the rdoc-data gem and run
|
288
|
-
rdoc-data
|
289
|
-
* RDoc now displays how well you've documented your library
|
290
|
-
* New recursive-descent parser for RDoc::Markup. See RDoc::Markup::Parser
|
291
|
-
* Updated ruby_lex and ruby_token
|
292
|
-
* Removed threading support, RDoc is not thread-safe
|
293
|
-
* Removed many unsupported options to rdoc
|
294
|
-
* Future versions of RDoc will not support Ruby 1.8.6. Bugs filed for
|
295
|
-
1.8.6-only issues will be (largely) rejected.
|
296
|
-
|
297
|
-
* 17 Minor Enhancements
|
298
|
-
* Source Parsing
|
299
|
-
* RDoc now supports module aliasing via constant assignment.
|
300
|
-
* RDoc now tracks superclasses correctly. Fixes File < IO for core docs.
|
301
|
-
* RDoc now ignores methods inside methods.
|
302
|
-
* RDoc now ignores Marshal and other binray files.
|
303
|
-
* Removed "Skipping require of dynamic string" warning.
|
304
|
-
* C parser now handles Document-method better. Bug #27329.
|
305
|
-
* API enhancements for writing parsers like the Ruby parser, see
|
306
|
-
RDoc::Parser::RubyTools
|
307
|
-
* ri
|
308
|
-
* Uses pager over less and more for Debian. Ruby Bug #1171.
|
309
|
-
* ri will use the RI_PAGER environment variable to find a pager.
|
310
|
-
* ri data generator now supports SIGINFO (^T)
|
311
|
-
* When rdoc is in debug mode, ^C now prints a backtrace
|
312
|
-
* RDoc::Markup::AttributeManager no longer uses global state.
|
313
|
-
* RDoc::RDoc no longer passes around options. Patch #27167.
|
314
|
-
* Darkfish won't generate a file if its template is missing. Patch #25857.
|
315
|
-
* Improved some wording for the RDoc main page. Patch #27264, #27268.
|
316
|
-
* Removed diagram generation support (to return in the future).
|
317
|
-
* Removed external support for RDoc::Task.
|
318
|
-
|
319
|
-
* 12 Bug Fixes
|
320
|
-
* The :attr: directives now use the name given to create an attribute. See
|
321
|
-
RDoc::Parser::Ruby#parse_meta_attr.
|
322
|
-
* Fix crossrefs on paths with '-'. Ruby Bug #883.
|
323
|
-
* Fix ruby parser for alias with = in the name. Bug #27522.
|
324
|
-
* Images are no longer executable. Bug #27156.
|
325
|
-
* --op is no longer overridden by --ri. Bug #27054.
|
326
|
-
* :method: now works when at the end of a class. Bug #26910.
|
327
|
-
* Preserve elipsis from call-seq in Darkfish. Patch #26974.
|
328
|
-
* Emacs-style <tt>coding:</tt> is handled properly. Patch #27388.
|
329
|
-
* RDoc::RubyLex now parses UTF-8 identifiers. Bug #26946, #26947.
|
330
|
-
* Fixed namespace lookup rules. Bug #26161.
|
331
|
-
* Worked around bug in Selenium where they hide a .jar in a .txt file.
|
332
|
-
Filed Selenium bug #27789.
|
333
|
-
* Alias comments are no longer hidden. Reported by Adam Avilla.
|
334
|
-
|
335
|
-
=== 2.4.3 / 2009-04-01
|
336
|
-
|
337
|
-
* 2 Bug Fixes
|
338
|
-
* Corrected patch for file links
|
339
|
-
* Corrected display of file popup
|
340
|
-
|
341
|
-
=== 2.4.2 / 2009-03-25
|
342
|
-
|
343
|
-
* 2 Minor Enhancements
|
344
|
-
* Added --pipe for turning RDoc on stdin into HTML
|
345
|
-
* Added rdoc/task.rb containing a replacement for rake/rdoctask.rb. Use
|
346
|
-
RDoc::Task now instead of Rake::RDocTask.
|
347
|
-
|
348
|
-
* 10 Bug Fixes
|
349
|
-
* Writing the ri cache file to the proper directory. Bug #24459 by Lars
|
350
|
-
Christensen.
|
351
|
-
* Possible fix for Dir::[] and Pathname interaction on 1.9. Bug #24650 by
|
352
|
-
tiburon.
|
353
|
-
* Fixed scanning constants for if/end, etc. pairs. Bug #24609 by Ryan
|
354
|
-
Davis.
|
355
|
-
* Fixed private methods in the C parser. Bug #24599 by Aaron Patterson.
|
356
|
-
* Fixed display of markup on RDoc main page. Bug #24168 by rhubarb.
|
357
|
-
* Fixed display of \\ character in documentation proceeding words.
|
358
|
-
Bug #22112 by James Gray. See RDoc for details.
|
359
|
-
* Fixed parsing and display of arg params for some corner cases. Bug #21113
|
360
|
-
by Csiszár Attila.
|
361
|
-
* Fixed links in Files box. Patch #24403 by Eric Wong.
|
362
|
-
* Toplevel methods now appear in Object. Bug #22677 by Ryan Davis.
|
363
|
-
* Added back --promiscuous which didn't do anything you cared about. Why
|
364
|
-
did you enable it? Nobody looked at that page! Oh, it warns, too.
|
365
|
-
|
366
|
-
=== 2.4.1 / 2009-02-26
|
367
|
-
|
368
|
-
* 1 Minor Enhancements
|
369
|
-
* Added :attr:, :attr_reader:, :attr_writer:, :attr_accessor: directives.
|
370
|
-
Replaces --accessor. See RDoc::Parser::Ruby for details.
|
371
|
-
|
372
|
-
* 3 Bug Fixes
|
373
|
-
* Don't complain when exiting normally. Bug by Matt Neuburg.
|
374
|
-
* Restore --inline-source that warns
|
375
|
-
* Fixed links to files in Darkfish output
|
376
|
-
|
377
|
-
=== 2.4.0 / 2009-02-24
|
378
|
-
|
379
|
-
* 9 Minor Enhancements
|
380
|
-
* `ri -f html` is now XHTML-happy
|
381
|
-
* Clarified RDoc::Markup link syntax. Bug #23517 by Eric Armstrong.
|
382
|
-
* Number of threads to parse with is now configurable
|
383
|
-
* Darkfish can now use alternate templates from $LOAD_PATH via -T
|
384
|
-
* Removed F95 parser in favor of the rdoc-f95 gem
|
385
|
-
* Moved HTML and XML generators to unmaintained
|
386
|
-
* No gem will be provided as it's too difficult to make them work
|
387
|
-
* Removed options --one-file, --style=, --inline-source, --promiscuous,
|
388
|
-
--op-name
|
389
|
-
* Removed support for --accessor, use regular documentation or
|
390
|
-
the method directive instead. See RDoc::Parser::Ruby
|
391
|
-
* Removed --ri-system as it is unused by Ruby's makefiles
|
392
|
-
* Added method list to index.html
|
393
|
-
|
394
|
-
* 6 Bug Fixes
|
395
|
-
* nodoc'd classes no longer appear in the index. Bug #23751 by Clifford
|
396
|
-
Heath.
|
397
|
-
* Fix 1.9 compatibility issues. Bug #23815 by paddor.
|
398
|
-
* Darkfish now respects --charset
|
399
|
-
* RDoc no longer attempts to be lazy when building HTML. This is a
|
400
|
-
workaround. Bug #23893 by Stefano Crocco.
|
401
|
-
* RDoc doesn't crash with def (blah).foo() end
|
402
|
-
* RDoc doesn't crash with #define functions
|
403
|
-
|
404
|
-
=== 2.3.0 / 2009-01-28
|
405
|
-
|
406
|
-
* 3 Major Enhancements
|
407
|
-
* Michael Granger's Darkfish generator is now the default for HTML output
|
408
|
-
* Various rdoc generation speedups by Hongli Lai. Patches #22555, #22556,
|
409
|
-
#22557, #22562, #22565.
|
410
|
-
* rdoc/discover.rb files are loaded automatically from installed gems
|
411
|
-
|
412
|
-
* 8 Minor Enhancements
|
413
|
-
* Added a space after the commas in ri class method lists. RubyForge
|
414
|
-
enhancement #22182.
|
415
|
-
* Improved ri --interactive
|
416
|
-
* Generators can now override generated file locations
|
417
|
-
* Moved unmaintained CHM generator to it's own package
|
418
|
-
* Moved unmaintained extra HTML templates to their own package
|
419
|
-
* Removed experimental texinfo generator
|
420
|
-
* Converted to minitest
|
421
|
-
* Known classes and modules list outputs once per line now for grep
|
422
|
-
|
423
|
-
* 11 Bug Fixes
|
424
|
-
* Fix missing superclass in ri output
|
425
|
-
* Fix an RDoc crash when told to parse an empty file
|
426
|
-
* Ignore nonexistent files instead of crashing
|
427
|
-
* .txt and .rdoc files are always considered text. Patch #22897 by Aaron
|
428
|
-
Patterson.
|
429
|
-
* When merging ri data with a nonexistant directory, RDoc no longer crashes
|
430
|
-
* Fix visibility of methods in XML output. Issue by Yehuda Katz.
|
431
|
-
* Fixed relative link generation
|
432
|
-
* Fix crash, RDoc now ignores comments above local variable assignments in
|
433
|
-
modules
|
434
|
-
* RDoc now only accepts adjacent comments for rb_define_module and
|
435
|
-
rb_define_class
|
436
|
-
* C file RDoc is no longer included in token stream
|
437
|
-
* Scan all gem paths to match gem name for ri output
|
438
|
-
|
439
|
-
=== 2.2.1 / 2008-09-24
|
440
|
-
This version provides some minor fixes and enhancements to 2.2.0 intended
|
441
|
-
to polish RDoc for Ruby 1.9.1.
|
442
|
-
|
443
|
-
* 3 Minor Enhancements
|
444
|
-
* Support for parsing RDoc from SWIG. Ruby patch #10742 by Gonzalo
|
445
|
-
Garramuno, #13993 by Steven Jenkins.
|
446
|
-
* Simple support for Perl POD documentation. Patch by Hugh Sasse.
|
447
|
-
* Changed the default character set of RDoc's output from iso-8859-1 to
|
448
|
-
utf-8.
|
449
|
-
|
450
|
-
* 9 Bug Fixes
|
451
|
-
* Explicitly set the html template's text color, so that the generated
|
452
|
-
documentation will display correctly on browsers with custom text and
|
453
|
-
background color settings (patch by Luther Thompson).
|
454
|
-
* Ensure that RDoc correctly will associate an alias and a method, even
|
455
|
-
if it encounters the alias first because the alias lives in a different
|
456
|
-
file.
|
457
|
-
* Fix the parsing of multiline constants (patch by Chris Alfeld and
|
458
|
-
Joel VanderWerf)
|
459
|
-
* Make --exclude usuable. Ruby patch #11671 by Trans.
|
460
|
-
* Detect inline C functions. Ruby Bug #11993 by Florian Frank.
|
461
|
-
* Fix an issue in which RDoc might not document a class'
|
462
|
-
superclass correctly if the class was defined in multiple files and
|
463
|
-
depending on the order in which RDoc processed the files. This should
|
464
|
-
ensure that the child class -> parent class relationship is correct in
|
465
|
-
ri documentation, allowing ri to lookup inherited methods (i.e., File.read).
|
466
|
-
* Stop ri from crashing when it looks for a completely bogus method (i.e.,
|
467
|
-
File#reada). Now, ri exits with a helpful error message.
|
468
|
-
* Fixed missing display of constant values in ri.
|
469
|
-
* Fixed display of constants in ri's html output.
|
470
|
-
|
471
|
-
=== 2.2.0 / 2008-09-19
|
472
|
-
This version includes some significant enhancements to ri. See RI.txt for
|
473
|
-
documentation about ri.
|
474
|
-
|
475
|
-
* 5 Major Enhancements
|
476
|
-
* More extensive unit tests (special thanks to Chris Lowis for contributing
|
477
|
-
a test).
|
478
|
-
* Made ri twice as fast for the most common use case of displaying
|
479
|
-
information for a class or a fully-qualified method
|
480
|
-
(i.e., ri Array#flatten, after ri has created a cache the first time that
|
481
|
-
it runs).
|
482
|
-
* Made ri many times faster when searching for an unqualified method (i.e.,
|
483
|
-
ri read, again after the first such search has populated ri's cache)
|
484
|
-
* Changed ri to do regular expression searches for unqualified methods;
|
485
|
-
now, a regular expression for a method can be passed to ri on the
|
486
|
-
command-line.
|
487
|
-
* Added an interactive mode to ri (patch by Daniel Choi). Now, when ri
|
488
|
-
is given a -i argument, it will allow the user to disambiguate
|
489
|
-
unqualified methods if more than one is present and also will allow a
|
490
|
-
user to get information for a class' method.
|
491
|
-
|
492
|
-
* 8 Minor Enhancements
|
493
|
-
* RDoc now adds the package title to the web pages that it generates
|
494
|
-
for files and classes/modules, which helps them appear better in
|
495
|
-
search engine results.
|
496
|
-
* RDoc now automatically generates cross-reference links for classes and
|
497
|
-
methods specified relative to the global namespace (i.e., ::A::B::C#method).
|
498
|
-
* All built-in templates now output valid, strict XHTML.
|
499
|
-
* The documentation is slightly better organized (the markup details were
|
500
|
-
merged into the RDoc module's documentation).
|
501
|
-
* Improved rdoc's HTML generation speed by about 20% (on Windows, the
|
502
|
-
boost seems larger).
|
503
|
-
* Provided an ri command-line option to control its caching behavior.
|
504
|
-
* Improved RDoc's documentation. Added RI.txt to document ri.
|
505
|
-
* Allow HTML templates distributed as gems to be loaded with the -T option,
|
506
|
-
just like the standard templates in rdoc/generator/html (so an HTML
|
507
|
-
template lib/new_template.rb in a gem can be used with rdoc -T new_template)
|
508
|
-
|
509
|
-
* 25 Bug fixes:
|
510
|
-
* Fixed prototype detection in C parser. Can process ruby 1.8 C files
|
511
|
-
again.
|
512
|
-
* Fixed the main page for frameless template. Patch by Marcin Raczkowski.
|
513
|
-
* Fixed the main page for frame templates. Now, if no main page is
|
514
|
-
specified, RDoc will default to the README.
|
515
|
-
* Fixed missing stylesheet in generated chm. Patch by Gordon Thiesfeld.
|
516
|
-
* Fixed the parsing of module names starting with '::'. Patch by
|
517
|
-
Giuseppe Bilotta.
|
518
|
-
* Fixed a case where RDoc first would encounter Foo::Bar and then would
|
519
|
-
encounter class Foo. Previously, RDoc erroneously would have considered
|
520
|
-
that both a Foo class and a Foo module existed.
|
521
|
-
* Fix a clase where RDoc would not generate correct cross-reference links
|
522
|
-
to a class contained within a module of the same name (i.e. RDoc::RDoc)
|
523
|
-
* Prevented RDoc from trying to parse binary files, which would produce
|
524
|
-
garbage output.
|
525
|
-
* RDoc now correctly converts ' characters to apostrophes, opening single
|
526
|
-
quotes, and closing single quotes in most cases (smart single quotes).
|
527
|
-
* RDoc now correctly converts " characters to opening double quotes and
|
528
|
-
and closing double quotes in most cases (smart double quotes).
|
529
|
-
* (c) correctly is converted into the copyright symbol.
|
530
|
-
* '&' characters in text now correctly are translated to HTML character codes.
|
531
|
-
* Fixed missing stylesheet in generated chm. Patch by Gordon Thiesfeld.
|
532
|
-
* Fixed broken method links in the built-in templates.
|
533
|
-
* RDoc properly links to files and classes in the one page HTML template.
|
534
|
-
* The kilmer and hefss templates properly syntax highlight when inlining
|
535
|
-
source code.
|
536
|
-
* The kilmer and hefss template class pages properly display methods again.
|
537
|
-
* Fixed broken class, file, and method links in the frameless template.
|
538
|
-
* Fixed the clipping of source code in the html and frameless templates when
|
539
|
-
the source code cannot fit into the window; a scrollbar now will allow
|
540
|
-
all of the source code to be viewed.
|
541
|
-
* Fixed the missing constant descriptions in the html and frameless
|
542
|
-
templates.
|
543
|
-
* Fixed the ri command-line options that customize the directories to be
|
544
|
-
searched for documentation.
|
545
|
-
* Fixed the XML generator. Patch by Anthony Durity.
|
546
|
-
* Stopped the XML template from generating invalid XML due to malformed
|
547
|
-
embedded ruby.
|
548
|
-
* Adding missing information about a class' constants to the XML template.
|
549
|
-
* Fixed the horizontal rule markup (---) so that it correctly adds a
|
550
|
-
horizontal rule rather than suppressing all text that follows.
|
551
|
-
|
552
|
-
=== 2.1.0 / 2008-07-20
|
553
|
-
|
554
|
-
* 3 Major Enhancements:
|
555
|
-
* RDoc now knows about meta-programmed methods, see RDoc::Parser::Ruby
|
556
|
-
* Reorganized parsers under RDoc::Parser base class
|
557
|
-
* ri now walks the ancestors of a class looking for a method e.g. ri
|
558
|
-
File#read displays documentation for IO#read (may require regeneration of
|
559
|
-
ri data)
|
560
|
-
* 5 Minor Enhancements:
|
561
|
-
* Allow links to files
|
562
|
-
* Default options now taken from RDOCOPT environment variable
|
563
|
-
* Class method documentation can be found at toplevel now (def X.foo)
|
564
|
-
* Allow HTML templates distributed as gems to be loaded with the -T option,
|
565
|
-
just like the standard templates in rdoc/generator/html (so an HTML
|
566
|
-
template lib/new_template.rb in a gem can be used with rdoc -T new_template)
|
567
|
-
* `rdoc -v` prints out files, classes, modules and methods as it goes
|
568
|
-
* 11 Bug Fixes:
|
569
|
-
* `ri Foo.bar` now looks for class methods also
|
570
|
-
* Sections work in the default template again
|
571
|
-
* Doesn't warn about :foo:: list item being an unrecognized directive
|
572
|
-
* RDoc no longer converts characters inside tt tags
|
573
|
-
* Fixed "unitialized constant RDoc::Markup::ToHtml::HTML"
|
574
|
-
* Fixed generation of relative links
|
575
|
-
* Fixed various diagram generation issues
|
576
|
-
* Fixed templates broken by switch to erb
|
577
|
-
* Fixed issue with <!-- --> style comments
|
578
|
-
* Lowercase words are no longer rdoc'd as methods without leading #, as
|
579
|
-
described in the documentation
|
580
|
-
* RDoc now correctly sets superclasses if they were originally unknown
|
581
|
-
|
582
|
-
=== 2.0.0 / 2008-04-10
|
583
|
-
|
584
|
-
* 3 Major Enhancements:
|
585
|
-
* Renamespaced everything RDoc under the RDoc module.
|
586
|
-
* New `ri` implementation.
|
587
|
-
* Reads from a cache in ~/.ri/ for enhanced speed.
|
588
|
-
* RubyGems aware, only searches latest gem versions.
|
589
|
-
* Now up to over 100 tests and 200 assertions.
|
590
|
-
* 4 Minor Enhancements:
|
591
|
-
* Switched to an ERb-based TemplatePage, see RDoc::TemplatePage.
|
592
|
-
* Class/module ri now displays attribute and constant comments.
|
593
|
-
* Cross-references can be disabled with a leading \.
|
594
|
-
* Relaxed parsing for some RDoc inline markup.
|
data/LICENSE.txt
DELETED
@@ -1,57 +0,0 @@
|
|
1
|
-
RDoc is copyrighted free software.
|
2
|
-
|
3
|
-
You can redistribute it and/or modify it under either the terms of the GPL
|
4
|
-
version 2 (see the file GPL), or the conditions below:
|
5
|
-
|
6
|
-
1. You may make and give away verbatim copies of the source form of the
|
7
|
-
software without restriction, provided that you duplicate all of the
|
8
|
-
original copyright notices and associated disclaimers.
|
9
|
-
|
10
|
-
2. You may modify your copy of the software in any way, provided that
|
11
|
-
you do at least ONE of the following:
|
12
|
-
|
13
|
-
a) place your modifications in the Public Domain or otherwise
|
14
|
-
make them Freely Available, such as by posting said
|
15
|
-
modifications to Usenet or an equivalent medium, or by allowing
|
16
|
-
the author to include your modifications in the software.
|
17
|
-
|
18
|
-
b) use the modified software only within your corporation or
|
19
|
-
organization.
|
20
|
-
|
21
|
-
c) give non-standard binaries non-standard names, with
|
22
|
-
instructions on where to get the original software distribution.
|
23
|
-
|
24
|
-
d) make other distribution arrangements with the author.
|
25
|
-
|
26
|
-
3. You may distribute the software in object code or binary form,
|
27
|
-
provided that you do at least ONE of the following:
|
28
|
-
|
29
|
-
a) distribute the binaries and library files of the software,
|
30
|
-
together with instructions (in the manual page or equivalent)
|
31
|
-
on where to get the original distribution.
|
32
|
-
|
33
|
-
b) accompany the distribution with the machine-readable source of
|
34
|
-
the software.
|
35
|
-
|
36
|
-
c) give non-standard binaries non-standard names, with
|
37
|
-
instructions on where to get the original software distribution.
|
38
|
-
|
39
|
-
d) make other distribution arrangements with the author.
|
40
|
-
|
41
|
-
4. You may modify and include the part of the software into any other
|
42
|
-
software (possibly commercial). But some files in the distribution
|
43
|
-
are not written by the author, so that they are not under these terms.
|
44
|
-
|
45
|
-
For the list of those files and their copying conditions, see the
|
46
|
-
file LEGAL.
|
47
|
-
|
48
|
-
5. The scripts and library files supplied as input to or produced as
|
49
|
-
output from the software do not automatically fall under the
|
50
|
-
copyright of the software, but belong to whomever generated them,
|
51
|
-
and may be sold commercially, and may be aggregated with this
|
52
|
-
software.
|
53
|
-
|
54
|
-
6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
|
55
|
-
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
|
56
|
-
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
57
|
-
PURPOSE.
|