rdoc 4.2.1 → 6.3.1
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 +5 -5
- data/CONTRIBUTING.rdoc +8 -7
- data/Gemfile +12 -0
- data/History.rdoc +48 -4
- data/LEGAL.rdoc +2 -2
- data/README.rdoc +5 -5
- data/Rakefile +73 -155
- data/bin/console +7 -0
- data/bin/setup +6 -0
- data/{bin → exe}/rdoc +0 -0
- data/{bin → exe}/ri +0 -0
- data/lib/rdoc/alias.rb +1 -0
- data/lib/rdoc/anon_class.rb +1 -0
- data/lib/rdoc/any_method.rb +59 -14
- data/lib/rdoc/attr.rb +1 -0
- data/lib/rdoc/class_module.rb +5 -2
- data/lib/rdoc/code_object.rb +3 -11
- data/lib/rdoc/code_objects.rb +1 -0
- data/lib/rdoc/comment.rb +32 -11
- data/lib/rdoc/constant.rb +3 -2
- data/lib/rdoc/context/section.rb +7 -13
- data/lib/rdoc/context.rb +78 -23
- data/lib/rdoc/cross_reference.rb +33 -14
- data/lib/rdoc/encoding.rb +92 -55
- data/lib/rdoc/erb_partial.rb +2 -1
- data/lib/rdoc/erbio.rb +8 -3
- data/lib/rdoc/extend.rb +1 -0
- data/lib/rdoc/generator/darkfish.rb +62 -32
- data/lib/rdoc/generator/json_index.rb +8 -5
- data/lib/rdoc/generator/markup.rb +3 -12
- 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 +4 -3
- data/lib/rdoc/generator/ri.rb +1 -0
- data/lib/rdoc/generator/template/darkfish/_footer.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +11 -8
- data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +7 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +7 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +6 -6
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +4 -4
- data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +4 -4
- data/lib/rdoc/generator/template/darkfish/class.rhtml +45 -47
- data/lib/rdoc/generator/template/darkfish/css/fonts.css +6 -6
- data/lib/rdoc/generator/template/darkfish/css/rdoc.css +55 -6
- data/lib/rdoc/generator/template/darkfish/index.rhtml +3 -4
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +23 -100
- data/lib/rdoc/generator/template/darkfish/js/search.js +32 -31
- data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +15 -16
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +16 -16
- data/lib/rdoc/generator/template/json_index/js/navigation.js +4 -41
- data/lib/rdoc/generator/template/json_index/js/searcher.js +7 -6
- data/lib/rdoc/generator.rb +1 -1
- data/lib/rdoc/ghost_method.rb +1 -0
- data/lib/rdoc/i18n/locale.rb +2 -1
- data/lib/rdoc/i18n/text.rb +5 -4
- data/lib/rdoc/i18n.rb +3 -2
- data/lib/rdoc/include.rb +1 -0
- data/lib/rdoc/known_classes.rb +1 -0
- data/lib/rdoc/markdown/entities.rb +1 -0
- data/lib/rdoc/markdown/{literals_1_9.kpeg → literals.kpeg} +1 -0
- data/lib/rdoc/markdown/{literals_1_9.rb → literals.rb} +1 -4
- data/lib/rdoc/markdown.kpeg +94 -51
- data/lib/rdoc/markdown.rb +1171 -619
- data/lib/rdoc/markup/attr_changer.rb +1 -0
- data/lib/rdoc/markup/attr_span.rb +9 -2
- data/lib/rdoc/markup/attribute_manager.rb +115 -49
- data/lib/rdoc/markup/attributes.rb +7 -6
- data/lib/rdoc/markup/blank_line.rb +1 -0
- data/lib/rdoc/markup/block_quote.rb +1 -0
- data/lib/rdoc/markup/document.rb +1 -0
- data/lib/rdoc/markup/formatter.rb +25 -23
- data/lib/rdoc/markup/hard_break.rb +1 -0
- data/lib/rdoc/markup/heading.rb +4 -3
- data/lib/rdoc/markup/include.rb +1 -0
- data/lib/rdoc/markup/indented_paragraph.rb +1 -0
- data/lib/rdoc/markup/list.rb +1 -0
- data/lib/rdoc/markup/list_item.rb +1 -0
- data/lib/rdoc/markup/paragraph.rb +1 -0
- data/lib/rdoc/markup/parser.rb +78 -61
- data/lib/rdoc/markup/pre_process.rb +12 -9
- data/lib/rdoc/markup/raw.rb +1 -0
- data/lib/rdoc/markup/regexp_handling.rb +41 -0
- data/lib/rdoc/markup/rule.rb +1 -0
- data/lib/rdoc/markup/to_ansi.rb +1 -0
- data/lib/rdoc/markup/to_bs.rb +4 -5
- data/lib/rdoc/markup/to_html.rb +71 -25
- data/lib/rdoc/markup/to_html_crossref.rb +41 -25
- data/lib/rdoc/markup/to_html_snippet.rb +10 -9
- data/lib/rdoc/markup/to_joined_paragraph.rb +7 -31
- data/lib/rdoc/markup/to_label.rb +10 -9
- data/lib/rdoc/markup/to_markdown.rb +9 -8
- data/lib/rdoc/markup/to_rdoc.rb +35 -6
- data/lib/rdoc/markup/to_table_of_contents.rb +2 -0
- data/lib/rdoc/markup/to_test.rb +1 -0
- data/lib/rdoc/markup/to_tt_only.rb +3 -2
- data/lib/rdoc/markup/verbatim.rb +1 -0
- data/lib/rdoc/markup.rb +14 -16
- data/lib/rdoc/meta_method.rb +1 -0
- data/lib/rdoc/method_attr.rb +2 -1
- data/lib/rdoc/mixin.rb +1 -0
- data/lib/rdoc/normal_class.rb +3 -2
- data/lib/rdoc/normal_module.rb +1 -0
- data/lib/rdoc/options.rb +92 -58
- data/lib/rdoc/parser/c.rb +219 -223
- data/lib/rdoc/parser/changelog.rb +155 -18
- data/lib/rdoc/parser/markdown.rb +1 -0
- data/lib/rdoc/parser/rd.rb +1 -0
- data/lib/rdoc/parser/ripper_state_lex.rb +590 -0
- data/lib/rdoc/parser/ruby.rb +635 -468
- data/lib/rdoc/parser/ruby_tools.rb +33 -33
- data/lib/rdoc/parser/simple.rb +3 -3
- data/lib/rdoc/parser/text.rb +1 -0
- data/lib/rdoc/parser.rb +17 -50
- data/lib/rdoc/rd/block_parser.rb +66 -65
- data/lib/rdoc/rd/block_parser.ry +3 -3
- data/lib/rdoc/rd/inline.rb +5 -4
- data/lib/rdoc/rd/inline_parser.rb +52 -51
- data/lib/rdoc/rd/inline_parser.ry +1 -1
- data/lib/rdoc/rd.rb +1 -0
- data/lib/rdoc/rdoc.rb +68 -63
- data/lib/rdoc/require.rb +1 -0
- data/lib/rdoc/ri/driver.rb +133 -58
- data/lib/rdoc/ri/formatter.rb +1 -0
- data/lib/rdoc/ri/paths.rb +4 -20
- data/lib/rdoc/ri/store.rb +1 -0
- data/lib/rdoc/ri/task.rb +71 -0
- data/lib/rdoc/ri.rb +1 -0
- data/lib/rdoc/rubygems_hook.rb +5 -12
- data/lib/rdoc/servlet.rb +24 -14
- data/lib/rdoc/single_class.rb +1 -0
- data/lib/rdoc/stats/normal.rb +20 -21
- data/lib/rdoc/stats/quiet.rb +1 -0
- data/lib/rdoc/stats/verbose.rb +1 -0
- data/lib/rdoc/stats.rb +1 -0
- data/lib/rdoc/store.rb +41 -41
- data/lib/rdoc/task.rb +2 -3
- data/lib/rdoc/text.rb +19 -38
- data/lib/rdoc/token_stream.rb +56 -32
- data/lib/rdoc/tom_doc.rb +17 -11
- data/lib/rdoc/top_level.rb +9 -2
- data/lib/rdoc/version.rb +8 -0
- data/lib/rdoc.rb +24 -10
- data/man/ri.1 +247 -0
- data/rdoc.gemspec +248 -0
- metadata +43 -236
- data/.autotest +0 -24
- data/.document +0 -5
- data/Manifest.txt +0 -306
- data/lib/gauntlet_rdoc.rb +0 -84
- data/lib/rdoc/generator/template/darkfish/js/jquery.js +0 -4
- data/lib/rdoc/markdown/literals_1_8.kpeg +0 -18
- data/lib/rdoc/markdown/literals_1_8.rb +0 -416
- data/lib/rdoc/markup/formatter_test_case.rb +0 -767
- data/lib/rdoc/markup/inline.rb +0 -1
- data/lib/rdoc/markup/special.rb +0 -40
- data/lib/rdoc/markup/text_formatter_test_case.rb +0 -114
- data/lib/rdoc/ruby_lex.rb +0 -1377
- data/lib/rdoc/ruby_token.rb +0 -460
- data/lib/rdoc/test_case.rb +0 -217
- data/test/MarkdownTest_1.0.3/Amps and angle encoding.text +0 -21
- data/test/MarkdownTest_1.0.3/Auto links.text +0 -13
- data/test/MarkdownTest_1.0.3/Backslash escapes.text +0 -120
- data/test/MarkdownTest_1.0.3/Blockquotes with code blocks.text +0 -11
- data/test/MarkdownTest_1.0.3/Code Blocks.text +0 -14
- data/test/MarkdownTest_1.0.3/Code Spans.text +0 -6
- data/test/MarkdownTest_1.0.3/Hard-wrapped paragraphs with list-like lines.text +0 -8
- data/test/MarkdownTest_1.0.3/Horizontal rules.text +0 -67
- data/test/MarkdownTest_1.0.3/Inline HTML (Advanced).text +0 -15
- data/test/MarkdownTest_1.0.3/Inline HTML (Simple).text +0 -69
- data/test/MarkdownTest_1.0.3/Inline HTML comments.text +0 -13
- data/test/MarkdownTest_1.0.3/Links, inline style.text +0 -12
- data/test/MarkdownTest_1.0.3/Links, reference style.text +0 -71
- data/test/MarkdownTest_1.0.3/Links, shortcut references.text +0 -20
- data/test/MarkdownTest_1.0.3/Literal quotes in titles.text +0 -7
- data/test/MarkdownTest_1.0.3/Markdown Documentation - Basics.text +0 -306
- data/test/MarkdownTest_1.0.3/Markdown Documentation - Syntax.text +0 -888
- data/test/MarkdownTest_1.0.3/Nested blockquotes.text +0 -5
- data/test/MarkdownTest_1.0.3/Ordered and unordered lists.text +0 -131
- data/test/MarkdownTest_1.0.3/Strong and em together.text +0 -7
- data/test/MarkdownTest_1.0.3/Tabs.text +0 -21
- data/test/MarkdownTest_1.0.3/Tidyness.text +0 -5
- data/test/README +0 -1
- data/test/binary.dat +0 -0
- data/test/hidden.zip.txt +0 -1
- data/test/test.ja.largedoc +0 -3
- data/test/test.ja.rdoc +0 -10
- data/test/test.ja.txt +0 -8
- data/test/test.txt +0 -1
- data/test/test_rdoc_alias.rb +0 -13
- data/test/test_rdoc_any_method.rb +0 -460
- data/test/test_rdoc_attr.rb +0 -190
- data/test/test_rdoc_class_module.rb +0 -1492
- data/test/test_rdoc_code_object.rb +0 -450
- data/test/test_rdoc_comment.rb +0 -504
- data/test/test_rdoc_constant.rb +0 -181
- data/test/test_rdoc_context.rb +0 -901
- data/test/test_rdoc_context_section.rb +0 -130
- data/test/test_rdoc_cross_reference.rb +0 -192
- data/test/test_rdoc_encoding.rb +0 -227
- data/test/test_rdoc_extend.rb +0 -94
- data/test/test_rdoc_generator_darkfish.rb +0 -229
- data/test/test_rdoc_generator_json_index.rb +0 -324
- data/test/test_rdoc_generator_markup.rb +0 -59
- data/test/test_rdoc_generator_pot.rb +0 -91
- data/test/test_rdoc_generator_pot_po.rb +0 -51
- data/test/test_rdoc_generator_pot_po_entry.rb +0 -139
- data/test/test_rdoc_generator_ri.rb +0 -78
- data/test/test_rdoc_i18n_locale.rb +0 -73
- data/test/test_rdoc_i18n_text.rb +0 -123
- data/test/test_rdoc_include.rb +0 -108
- data/test/test_rdoc_markdown.rb +0 -980
- data/test/test_rdoc_markdown_test.rb +0 -1884
- data/test/test_rdoc_markup.rb +0 -95
- data/test/test_rdoc_markup_attribute_manager.rb +0 -364
- data/test/test_rdoc_markup_attributes.rb +0 -39
- data/test/test_rdoc_markup_document.rb +0 -207
- data/test/test_rdoc_markup_formatter.rb +0 -175
- data/test/test_rdoc_markup_hard_break.rb +0 -31
- data/test/test_rdoc_markup_heading.rb +0 -29
- data/test/test_rdoc_markup_include.rb +0 -19
- data/test/test_rdoc_markup_indented_paragraph.rb +0 -53
- data/test/test_rdoc_markup_paragraph.rb +0 -32
- data/test/test_rdoc_markup_parser.rb +0 -1680
- data/test/test_rdoc_markup_pre_process.rb +0 -473
- data/test/test_rdoc_markup_raw.rb +0 -22
- data/test/test_rdoc_markup_to_ansi.rb +0 -369
- data/test/test_rdoc_markup_to_bs.rb +0 -366
- data/test/test_rdoc_markup_to_html.rb +0 -662
- data/test/test_rdoc_markup_to_html_crossref.rb +0 -225
- data/test/test_rdoc_markup_to_html_snippet.rb +0 -711
- data/test/test_rdoc_markup_to_joined_paragraph.rb +0 -32
- data/test/test_rdoc_markup_to_label.rb +0 -112
- data/test/test_rdoc_markup_to_markdown.rb +0 -389
- data/test/test_rdoc_markup_to_rdoc.rb +0 -377
- data/test/test_rdoc_markup_to_table_of_contents.rb +0 -126
- data/test/test_rdoc_markup_to_tt_only.rb +0 -246
- data/test/test_rdoc_markup_verbatim.rb +0 -29
- data/test/test_rdoc_method_attr.rb +0 -193
- data/test/test_rdoc_normal_class.rb +0 -47
- data/test/test_rdoc_normal_module.rb +0 -42
- data/test/test_rdoc_options.rb +0 -766
- data/test/test_rdoc_parser.rb +0 -327
- data/test/test_rdoc_parser_c.rb +0 -1896
- data/test/test_rdoc_parser_changelog.rb +0 -315
- data/test/test_rdoc_parser_markdown.rb +0 -61
- data/test/test_rdoc_parser_rd.rb +0 -55
- data/test/test_rdoc_parser_ruby.rb +0 -3322
- data/test/test_rdoc_parser_simple.rb +0 -115
- data/test/test_rdoc_rd.rb +0 -30
- data/test/test_rdoc_rd_block_parser.rb +0 -535
- data/test/test_rdoc_rd_inline.rb +0 -63
- data/test/test_rdoc_rd_inline_parser.rb +0 -177
- data/test/test_rdoc_rdoc.rb +0 -455
- data/test/test_rdoc_require.rb +0 -25
- data/test/test_rdoc_ri_driver.rb +0 -1436
- data/test/test_rdoc_ri_paths.rb +0 -155
- data/test/test_rdoc_ruby_lex.rb +0 -421
- data/test/test_rdoc_ruby_token.rb +0 -19
- data/test/test_rdoc_rubygems_hook.rb +0 -251
- data/test/test_rdoc_servlet.rb +0 -534
- data/test/test_rdoc_single_class.rb +0 -20
- data/test/test_rdoc_stats.rb +0 -722
- data/test/test_rdoc_store.rb +0 -993
- data/test/test_rdoc_task.rb +0 -173
- data/test/test_rdoc_text.rb +0 -557
- data/test/test_rdoc_token_stream.rb +0 -42
- data/test/test_rdoc_tom_doc.rb +0 -520
- data/test/test_rdoc_top_level.rb +0 -287
- data/test/xref_data.rb +0 -76
- data/test/xref_test_case.rb +0 -67
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 327e6414793206350f148388b0df495ff2c748c1d4bb129ef320a442e4084619
|
4
|
+
data.tar.gz: 44c884a1eb18506c90af82fefa6f7686973ab32e1ceb42c6616b0ffbf88ac868
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8691cde93b42f6c4ff77f6212e40c5c15c408b1953e58cf14f17cef142970ff79564bf7fe12b7f072067267fd67ad62920241e54e7a6d592487545bd19a82311
|
7
|
+
data.tar.gz: 3adbda517d389982d0d67ccd92478d0b0912c156c2988a26089715ff77e998025d6f2d8eafd44cdbd66daa2c647bd2201d1c0f57c5731bac19c45aea3014ae4c
|
data/CONTRIBUTING.rdoc
CHANGED
@@ -8,7 +8,7 @@ classes for each feature.
|
|
8
8
|
== Bugs
|
9
9
|
|
10
10
|
If you think you found a bug, file a ticket on the {issues
|
11
|
-
tracker}[https://github.com/
|
11
|
+
tracker}[https://github.com/ruby/rdoc/issues] on github.
|
12
12
|
|
13
13
|
If your bug involves an error RDoc produced please include a sample file that
|
14
14
|
illustrates the problem or link to the repository or gem that is associated
|
@@ -17,14 +17,16 @@ with the bug.
|
|
17
17
|
Please include steps to reproduce the issue. Here are some examples of good
|
18
18
|
issues:
|
19
19
|
|
20
|
-
* https://github.com/
|
21
|
-
* https://github.com/
|
20
|
+
* https://github.com/ruby/rdoc/issues/55
|
21
|
+
* https://github.com/ruby/rdoc/issues/61
|
22
22
|
|
23
23
|
== Developer Quick Start
|
24
24
|
|
25
|
-
RDoc uses
|
25
|
+
RDoc uses bundler for development. To get ready to work on RDoc run:
|
26
26
|
|
27
|
-
$ gem install
|
27
|
+
$ gem install bundler
|
28
|
+
[...]
|
29
|
+
$ bundle install
|
28
30
|
[...]
|
29
31
|
$ rake
|
30
32
|
[...]
|
@@ -33,7 +35,7 @@ This will install all the necessary dependencies for development with rake,
|
|
33
35
|
generate documentation and run the tests for the first time.
|
34
36
|
|
35
37
|
If the tests don't pass on the first run check the {Travis CI page for
|
36
|
-
RDoc}[https://travis-ci.org/
|
38
|
+
RDoc}[https://travis-ci.org/ruby/rdoc] to see if there are any known failures
|
37
39
|
(there shouldn't be).
|
38
40
|
|
39
41
|
You can now use `rake` and `autotest` to run the tests.
|
@@ -216,4 +218,3 @@ To register the parser with rdoc, add the markup type's name and class to the
|
|
216
218
|
RDoc::Text::MARKUP_FORMAT hash like:
|
217
219
|
|
218
220
|
RDoc::Text::MARKUP_FORMAT['rdoc'] = RDoc::Markup
|
219
|
-
|
data/Gemfile
ADDED
data/History.rdoc
CHANGED
@@ -1,7 +1,51 @@
|
|
1
|
-
===
|
1
|
+
=== 5.1.0 / 2017-02-24
|
2
2
|
|
3
3
|
* Bug fixes
|
4
|
-
*
|
4
|
+
* Fix an issue that rdoc fails when running on Windows with RUBYOPT=-U.
|
5
|
+
PR #430 by Toshihiko Ichida
|
6
|
+
|
7
|
+
* Minor enhancements
|
8
|
+
* Parse ruby 2.1 <visibility> def. PR #436 by Akira Matsuda.
|
9
|
+
* Suppress warnings in eval. PR #440 by Nobuyoshi Nakada.
|
10
|
+
|
11
|
+
=== 5.0.0 / 2016-11-05
|
12
|
+
|
13
|
+
* Major enhancements
|
14
|
+
* Cleanup deprecated code targeted Ruby 1.8
|
15
|
+
|
16
|
+
* Bug fixes
|
17
|
+
* Ensure badge data is included in result of JsonIndex template.
|
18
|
+
* Ensure items in the nil section are displayed in HTML output. Issue #399
|
19
|
+
by Daniel Svensson.
|
20
|
+
* Parse rb_intern_const correctly in C. PR #381 by Sho Hashimoto.
|
21
|
+
* Fix broken assets caused by #335 when serving ri. PR #360 by Alex Wood.
|
22
|
+
* Don't try to parse svg files. Issue #350 by Sigurd Svela.
|
23
|
+
|
24
|
+
* Minor enhancements
|
25
|
+
* Improve class name expansion/resolution in ri. PR #400 by NARUSE, Yui
|
26
|
+
* Improve performance of document generation. PR #397 by Yusuke Endoh.
|
27
|
+
|
28
|
+
=== 4.3.0 / 2016-11-04
|
29
|
+
|
30
|
+
* Minor enhancements
|
31
|
+
* Removed json dependency for Ruby 2.4.0
|
32
|
+
* End to support Ruby 1.8.x
|
33
|
+
|
34
|
+
=== 4.2.2 / 2016-02-09
|
35
|
+
|
36
|
+
* Bug fixes
|
37
|
+
* Include lib/rdoc/generator/pot/* in built gem
|
38
|
+
|
39
|
+
|
40
|
+
=== 4.2.1 / 2015-12-22
|
41
|
+
|
42
|
+
* Bug fixes
|
43
|
+
* Fixed infinite loop with CR #339 by @nobu
|
44
|
+
* Allow rdoc run with --disable-gems #340 by @luizluca
|
45
|
+
* Don't store full path in GZipped js files #341 by @voxik
|
46
|
+
* Fix relative path names for drive letters #367 by @nobu
|
47
|
+
* Fix for valid syntax `class C end` parsing #368 by @nobu
|
48
|
+
|
5
49
|
|
6
50
|
=== 4.2.0 / 2014-12-06
|
7
51
|
|
@@ -33,7 +77,7 @@
|
|
33
77
|
* Bug fixes
|
34
78
|
* Fixed HTML labels for cross-browser compatibility. This breaks existing
|
35
79
|
links but enables cross-browser compatibility. Pull request #330 by Jens
|
36
|
-
|
80
|
+
Will.
|
37
81
|
* RDoc handles ASCII-incompatible encodings now. An encoding hint may need
|
38
82
|
to be added to the file for RDoc to produce correct output, though.
|
39
83
|
Issue #288 by Manuel Meurer.
|
@@ -677,7 +721,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
677
721
|
|
678
722
|
* Major enhancements
|
679
723
|
* RDoc HTML output has been improved:
|
680
|
-
* The search from Володя Колесников's (Vladimir Kolesnikov)
|
724
|
+
* The search from Володя Колесников's (Vladimir Kolesnikov) SDoc has been
|
681
725
|
integrated.
|
682
726
|
|
683
727
|
The search index generation is a reusable component through
|
data/LEGAL.rdoc
CHANGED
@@ -14,7 +14,7 @@ Darkfish::
|
|
14
14
|
* lib/rdoc/generator/template/darkfish/*
|
15
15
|
* lib/rdoc/generator/template/darkfish/images
|
16
16
|
|
17
|
-
|
17
|
+
SDoc::
|
18
18
|
Portions of SDoc by (Володя Колесников) Vladimir Kolesnikov are included
|
19
19
|
under the MIT license as RDoc::Generator::JsonIndex. See
|
20
20
|
lib/rdoc/generator/json_index.rb for license information.
|
@@ -23,7 +23,7 @@ Sdoc::
|
|
23
23
|
* lib/rdoc/generator/template/json_index/*
|
24
24
|
* The +#search_index+ methods on RDoc::CodeObject subclasses were derived
|
25
25
|
from sdoc.
|
26
|
-
* RDoc::ClassModule#document_self_or_methods comes from
|
26
|
+
* RDoc::ClassModule#document_self_or_methods comes from SDoc.
|
27
27
|
|
28
28
|
peg-markdown::
|
29
29
|
RDoc's Markdown support is derived from peg-markdown by John MacFarlane. It
|
data/README.rdoc
CHANGED
@@ -1,9 +1,9 @@
|
|
1
1
|
= \RDoc - Ruby Documentation System
|
2
2
|
|
3
|
-
home :: https://github.com/
|
4
|
-
rdoc ::
|
5
|
-
bugs :: https://github.com/
|
6
|
-
code quality :: {<img src="https://codeclimate.com/
|
3
|
+
home :: https://github.com/ruby/rdoc
|
4
|
+
rdoc :: https://ruby.github.io/rdoc
|
5
|
+
bugs :: https://github.com/ruby/rdoc/issues
|
6
|
+
code quality :: {<img src="https://codeclimate.com/github/ruby/rdoc/badges/gpa.svg" alt="Code Climate">}[https://codeclimate.com/github/ruby/rdoc]
|
7
7
|
|
8
8
|
== Description
|
9
9
|
|
@@ -46,7 +46,7 @@ contain just Markup-style markup (with or without leading '#' comment
|
|
46
46
|
markers). If directory names are passed to RDoc, they are scanned
|
47
47
|
recursively for C and Ruby source files only.
|
48
48
|
|
49
|
-
To generate documentation using +rake+ see RDoc::Task[
|
49
|
+
To generate documentation using +rake+ see RDoc::Task[https://ruby.github.io/rdoc/RDocTask.html].
|
50
50
|
|
51
51
|
To generate documentation programmatically:
|
52
52
|
|
data/Rakefile
CHANGED
@@ -1,183 +1,101 @@
|
|
1
1
|
$:.unshift File.expand_path 'lib'
|
2
|
-
require 'rdoc'
|
3
|
-
require '
|
4
|
-
|
5
|
-
ENV['BENCHMARK'] = 'yes'
|
2
|
+
require 'rdoc/task'
|
3
|
+
require 'bundler/gem_tasks'
|
4
|
+
require 'rake/testtask'
|
6
5
|
|
7
6
|
task :docs => :generate
|
8
|
-
task :test => :
|
7
|
+
task :test => [:normal_test, :rubygems_test]
|
9
8
|
|
10
9
|
PARSER_FILES = %w[
|
11
|
-
lib/rdoc/rd/block_parser.
|
12
|
-
lib/rdoc/rd/inline_parser.
|
13
|
-
lib/rdoc/markdown.
|
14
|
-
lib/rdoc/markdown/
|
15
|
-
lib/rdoc/markdown/literals_1_9.rb
|
10
|
+
lib/rdoc/rd/block_parser.ry
|
11
|
+
lib/rdoc/rd/inline_parser.ry
|
12
|
+
lib/rdoc/markdown.kpeg
|
13
|
+
lib/rdoc/markdown/literals.kpeg
|
16
14
|
]
|
17
15
|
|
18
|
-
Hoe.plugin :git
|
19
|
-
Hoe.plugin :kpeg
|
20
|
-
Hoe.plugin :minitest
|
21
|
-
Hoe.plugin :travis
|
22
|
-
|
23
16
|
$rdoc_rakefile = true
|
24
17
|
|
25
|
-
|
26
|
-
developer 'Eric Hodel', 'drbrain@segment7.net'
|
27
|
-
developer 'Dave Thomas', ''
|
28
|
-
developer 'Phil Hagelberg', 'technomancy@gmail.com'
|
29
|
-
developer 'Tony Strauss', 'tony.strauss@designingpatterns.com'
|
30
|
-
|
31
|
-
self.rsync_args = '-avz'
|
32
|
-
rdoc_locations << 'docs.seattlerb.org:/data/www/docs.seattlerb.org/rdoc/'
|
33
|
-
rdoc_locations << 'drbrain@rubyforge.org:/var/www/gforge-projects/rdoc/'
|
34
|
-
|
35
|
-
spec_extras[:post_install_message] = <<-MESSAGE
|
36
|
-
Depending on your version of ruby, you may need to install ruby rdoc/ri data:
|
37
|
-
|
38
|
-
<= 1.8.6 : unsupported
|
39
|
-
= 1.8.7 : gem install rdoc-data; rdoc-data --install
|
40
|
-
= 1.9.1 : gem install rdoc-data; rdoc-data --install
|
41
|
-
>= 1.9.2 : nothing to do! Yay!
|
42
|
-
MESSAGE
|
43
|
-
|
44
|
-
self.licenses << 'Ruby'
|
45
|
-
self.readme_file = 'README.rdoc'
|
46
|
-
self.history_file = 'History.rdoc'
|
47
|
-
self.testlib = :minitest
|
48
|
-
self.extra_rdoc_files += %w[
|
49
|
-
CVE-2013-0256.rdoc
|
50
|
-
CONTRIBUTING.rdoc
|
51
|
-
ExampleMarkdown.md
|
52
|
-
ExampleRDoc.rdoc
|
53
|
-
History.rdoc
|
54
|
-
LEGAL.rdoc
|
55
|
-
LICENSE.rdoc
|
56
|
-
README.rdoc
|
57
|
-
RI.rdoc
|
58
|
-
TODO.rdoc
|
59
|
-
]
|
60
|
-
|
61
|
-
self.clean_globs += PARSER_FILES
|
62
|
-
self.kpeg_flags = '-fsv' if self.respond_to? :kpeg_flags= # no plugin
|
63
|
-
|
64
|
-
require_ruby_version '>= 1.8.7'
|
65
|
-
extra_deps << ['json', '~> 1.4']
|
66
|
-
extra_dev_deps << ['racc', '~> 1.4', '> 1.4.10']
|
67
|
-
extra_dev_deps << ['minitest', '~> 4']
|
68
|
-
|
69
|
-
extra_rdoc_files << 'Rakefile'
|
70
|
-
spec_extras['required_rubygems_version'] = '>= 1.3'
|
71
|
-
spec_extras['homepage'] = 'http://docs.seattlerb.org/rdoc'
|
72
|
-
end
|
73
|
-
|
74
|
-
hoe.test_prelude = 'gem "minitest", "~> 4.0"'
|
18
|
+
task :default => :test
|
75
19
|
|
76
|
-
|
77
|
-
|
20
|
+
RDoc::Task.new do |doc|
|
21
|
+
doc.main = 'README.rdoc'
|
22
|
+
doc.title = "rdoc #{RDoc::VERSION} Documentation"
|
23
|
+
doc.rdoc_dir = 'html'
|
24
|
+
doc.rdoc_files = FileList.new %w[lib/**/*.rb *.rdoc] - PARSER_FILES
|
78
25
|
end
|
79
26
|
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
27
|
+
task ghpages: :rdoc do
|
28
|
+
`git checkout gh-pages`
|
29
|
+
require "fileutils"
|
30
|
+
FileUtils.rm_rf "/tmp/html"
|
31
|
+
FileUtils.mv "html", "/tmp"
|
32
|
+
FileUtils.rm_rf "*"
|
33
|
+
FileUtils.cp_r Dir.glob("/tmp/html/*"), "."
|
84
34
|
end
|
85
35
|
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
rake "newb"
|
92
|
-
end
|
36
|
+
Rake::TestTask.new(:normal_test) do |t|
|
37
|
+
t.libs << "test/rdoc"
|
38
|
+
t.verbose = true
|
39
|
+
t.deps = :generate
|
40
|
+
t.test_files = FileList["test/**/test_*.rb"].exclude("test/rdoc/test_rdoc_rubygems_hook.rb")
|
93
41
|
end
|
94
42
|
|
95
|
-
Rake::
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
options = RDoc::Options.new
|
101
|
-
options.title = "rdoc #{RDoc::VERSION} Documentation"
|
102
|
-
options.op_dir = 'doc'
|
103
|
-
options.main_page = 'README.rdoc'
|
104
|
-
options.files = hoe.spec.extra_rdoc_files + %w[lib]
|
105
|
-
options.setup_generator 'darkfish'
|
106
|
-
|
107
|
-
RDoc::RDoc.new.document options
|
108
|
-
end
|
109
|
-
|
110
|
-
# requires ruby 1.8 and ruby 1.8 to build
|
111
|
-
hoe.clean_globs -= PARSER_FILES.grep(/literals_/)
|
112
|
-
|
113
|
-
task :generate => :isolate
|
114
|
-
task :generate => PARSER_FILES
|
115
|
-
task :check_manifest => :generate
|
116
|
-
|
117
|
-
rule '.rb' => '.ry' do |t|
|
118
|
-
racc = Gem.bin_path 'racc', 'racc'
|
119
|
-
|
120
|
-
ruby "-rubygems #{racc} -l -o #{t.name} #{t.source}"
|
43
|
+
Rake::TestTask.new(:rubygems_test) do |t|
|
44
|
+
t.libs << "test/rdoc"
|
45
|
+
t.verbose = true
|
46
|
+
t.deps = :generate
|
47
|
+
t.pattern = "test/rdoc/test_rdoc_rubygems_hook.rb"
|
121
48
|
end
|
122
49
|
|
123
|
-
path = "pkg/#{
|
50
|
+
path = "pkg/#{Bundler::GemHelper.gemspec.full_name}"
|
124
51
|
|
125
52
|
package_parser_files = PARSER_FILES.map do |parser_file|
|
126
|
-
|
127
|
-
|
128
|
-
package_parser_file
|
129
|
-
|
53
|
+
name = File.basename(parser_file, File.extname(parser_file))
|
54
|
+
_path = File.dirname(parser_file)
|
55
|
+
package_parser_file = "#{path}/#{name}.rb"
|
56
|
+
parsed_file = "#{_path}/#{name}.rb"
|
130
57
|
|
131
|
-
|
58
|
+
file package_parser_file => parsed_file # ensure copy runs before racc
|
132
59
|
|
133
|
-
|
134
|
-
#
|
135
|
-
# git/git.rubini.us/code # Rubinius git HEAD checkout
|
136
|
-
# svn/ruby/trunk # ruby subversion HEAD checkout
|
137
|
-
# svn/rdoc/trunk # RDoc subversion HEAD checkout
|
138
|
-
#
|
139
|
-
# If you don't have this directory structure, set RUBY_PATH and/or
|
140
|
-
# RUBINIUS_PATH.
|
141
|
-
|
142
|
-
diff_options = "-urpN --exclude '*svn*' --exclude '*swp' --exclude '*rbc'"
|
143
|
-
rsync_options = "-avP --exclude '*svn*' --exclude '*swp' --exclude '*rbc' --exclude '*.rej' --exclude '*.orig' --exclude '*.kpeg' --exclude '*.ry' --exclude 'literals_1_8.rb' --exclude 'gauntlet_rdoc.rb'"
|
144
|
-
|
145
|
-
rubinius_dir = ENV['RUBINIUS_PATH'] || '../../../git/git.rubini.us/code'
|
146
|
-
ruby_dir = ENV['RUBY_PATH'] || '../../svn/ruby/trunk'
|
147
|
-
|
148
|
-
desc "Updates Ruby HEAD with the currently checked-out copy of RDoc."
|
149
|
-
task :update_ruby do
|
150
|
-
sh "rsync #{rsync_options} bin/rdoc #{ruby_dir}/bin/rdoc"
|
151
|
-
sh "rsync #{rsync_options} bin/ri #{ruby_dir}/bin/ri"
|
152
|
-
sh "rsync #{rsync_options} lib/ #{ruby_dir}/lib"
|
153
|
-
sh "rsync #{rsync_options} test/ #{ruby_dir}/test/rdoc"
|
60
|
+
package_parser_file
|
154
61
|
end
|
155
62
|
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
63
|
+
parsed_files = PARSER_FILES.map do |parser_file|
|
64
|
+
ext = File.extname(parser_file)
|
65
|
+
parsed_file = "#{parser_file.chomp(ext)}.rb"
|
66
|
+
|
67
|
+
file parsed_file => parser_file do |t|
|
68
|
+
puts "Generating #{parsed_file}..."
|
69
|
+
case ext
|
70
|
+
when '.ry' # need racc
|
71
|
+
racc = Gem.bin_path 'racc', 'racc'
|
72
|
+
rb_file = parser_file.gsub(/\.ry\z/, ".rb")
|
73
|
+
ruby "#{racc} -l -o #{rb_file} #{parser_file}"
|
74
|
+
open(rb_file, 'r+') do |f|
|
75
|
+
newtext = "# frozen_string_literal: true\n#{f.read}"
|
76
|
+
f.rewind
|
77
|
+
f.write newtext
|
78
|
+
end
|
79
|
+
when '.kpeg' # need kpeg
|
80
|
+
kpeg = Gem.bin_path 'kpeg', 'kpeg'
|
81
|
+
rb_file = parser_file.gsub(/\.kpeg\z/, ".rb")
|
82
|
+
ruby "#{kpeg} -fsv -o #{rb_file} #{parser_file}"
|
83
|
+
end
|
84
|
+
end
|
166
85
|
|
167
|
-
|
168
|
-
task :update_rubinius do
|
169
|
-
sh "rsync #{rsync_options} bin/rdoc #{rubinius_dir}/lib/bin/rdoc.rb"
|
170
|
-
sh "rsync #{rsync_options} bin/ri #{rubinius_dir}/lib/bin/ri.rb"
|
171
|
-
sh "rsync #{rsync_options} lib/ #{rubinius_dir}/lib"
|
172
|
-
sh "rsync #{rsync_options} test/ #{rubinius_dir}/test/rdoc"
|
86
|
+
parsed_file
|
173
87
|
end
|
174
88
|
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
89
|
+
task "#{path}.gem" => package_parser_files
|
90
|
+
desc "Generate all files used racc and kpeg"
|
91
|
+
task :generate => parsed_files
|
92
|
+
|
93
|
+
begin
|
94
|
+
require 'rubocop/rake_task'
|
95
|
+
rescue LoadError
|
96
|
+
else
|
97
|
+
RuboCop::RakeTask.new(:rubocop) do |t|
|
98
|
+
t.options = [*parsed_files]
|
99
|
+
end
|
100
|
+
task :build => [:generate, "rubocop:auto_correct"]
|
182
101
|
end
|
183
|
-
|
data/bin/console
ADDED
data/bin/setup
ADDED
data/{bin → exe}/rdoc
RENAMED
File without changes
|
data/{bin → exe}/ri
RENAMED
File without changes
|
data/lib/rdoc/alias.rb
CHANGED
data/lib/rdoc/anon_class.rb
CHANGED
data/lib/rdoc/any_method.rb
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
##
|
2
3
|
# AnyMethod is the base class for objects representing methods
|
3
4
|
|
@@ -25,12 +26,6 @@ class RDoc::AnyMethod < RDoc::MethodAttr
|
|
25
26
|
|
26
27
|
attr_accessor :c_function
|
27
28
|
|
28
|
-
##
|
29
|
-
# Different ways to call this method
|
30
|
-
|
31
|
-
attr_reader :call_seq
|
32
|
-
|
33
|
-
##
|
34
29
|
# Parameters for this method
|
35
30
|
|
36
31
|
attr_accessor :params
|
@@ -92,6 +87,19 @@ class RDoc::AnyMethod < RDoc::MethodAttr
|
|
92
87
|
end
|
93
88
|
end
|
94
89
|
|
90
|
+
##
|
91
|
+
# Different ways to call this method
|
92
|
+
|
93
|
+
def call_seq
|
94
|
+
unless call_seq = _call_seq
|
95
|
+
call_seq = is_alias_for._call_seq if is_alias_for
|
96
|
+
end
|
97
|
+
|
98
|
+
return unless call_seq
|
99
|
+
|
100
|
+
deduplicate_call_seq(call_seq)
|
101
|
+
end
|
102
|
+
|
95
103
|
##
|
96
104
|
# Sets the different ways you can call this method. If an empty +call_seq+
|
97
105
|
# is given nil is assumed.
|
@@ -243,9 +251,9 @@ class RDoc::AnyMethod < RDoc::MethodAttr
|
|
243
251
|
if @block_params then
|
244
252
|
# If this method has explicit block parameters, remove any explicit
|
245
253
|
# &block
|
246
|
-
params.sub
|
254
|
+
params = params.sub(/,?\s*&\w+/, '')
|
247
255
|
else
|
248
|
-
params.sub
|
256
|
+
params = params.sub(/\&(\w+)/, '\1')
|
249
257
|
end
|
250
258
|
|
251
259
|
params = params.gsub(/\s+/, '').split(',').reject(&:empty?)
|
@@ -264,7 +272,7 @@ class RDoc::AnyMethod < RDoc::MethodAttr
|
|
264
272
|
params = params.sub(/(\|[^|]+\|)\s*\.\.\.\s*(end|\})/, '\1 \2')
|
265
273
|
elsif @params then
|
266
274
|
params = @params.gsub(/\s*\#.*/, '')
|
267
|
-
params = params.
|
275
|
+
params = params.tr_s("\n ", " ")
|
268
276
|
params = "(#{params})" unless params[0] == ?(
|
269
277
|
else
|
270
278
|
params = ''
|
@@ -273,12 +281,11 @@ class RDoc::AnyMethod < RDoc::MethodAttr
|
|
273
281
|
if @block_params then
|
274
282
|
# If this method has explicit block parameters, remove any explicit
|
275
283
|
# &block
|
276
|
-
params.sub
|
284
|
+
params = params.sub(/,?\s*&\w+/, '')
|
277
285
|
|
278
|
-
block = @block_params.
|
279
|
-
block = block.tr("\n", " ").squeeze(" ")
|
286
|
+
block = @block_params.tr_s("\n ", " ")
|
280
287
|
if block[0] == ?(
|
281
|
-
block.sub
|
288
|
+
block = block.sub(/^\(/, '').sub(/\)/, '')
|
282
289
|
end
|
283
290
|
params << " { |#{block}| ... }"
|
284
291
|
end
|
@@ -312,5 +319,43 @@ class RDoc::AnyMethod < RDoc::MethodAttr
|
|
312
319
|
@superclass_method
|
313
320
|
end
|
314
321
|
|
315
|
-
|
322
|
+
protected
|
323
|
+
|
324
|
+
##
|
325
|
+
# call_seq without deduplication and alias lookup.
|
326
|
+
|
327
|
+
def _call_seq
|
328
|
+
@call_seq if defined?(@call_seq) && @call_seq
|
329
|
+
end
|
330
|
+
|
331
|
+
private
|
332
|
+
|
333
|
+
##
|
334
|
+
# call_seq with alias examples information removed, if this
|
335
|
+
# method is an alias method.
|
336
|
+
|
337
|
+
def deduplicate_call_seq(call_seq)
|
338
|
+
return call_seq unless is_alias_for || !aliases.empty?
|
339
|
+
|
340
|
+
method_name = self.name
|
341
|
+
method_name = method_name[0, 1] if method_name =~ /\A\[/
|
316
342
|
|
343
|
+
entries = call_seq.split "\n"
|
344
|
+
|
345
|
+
ignore = aliases.map(&:name)
|
346
|
+
if is_alias_for
|
347
|
+
ignore << is_alias_for.name
|
348
|
+
ignore.concat is_alias_for.aliases.map(&:name)
|
349
|
+
end
|
350
|
+
ignore.map! { |n| n =~ /\A\[/ ? n[0, 1] : n}
|
351
|
+
ignore.delete(method_name)
|
352
|
+
ignore = Regexp.union(ignore)
|
353
|
+
|
354
|
+
matching = entries.reject do |entry|
|
355
|
+
entry =~ /^\w*\.?#{ignore}/ or
|
356
|
+
entry =~ /\s#{ignore}\s/
|
357
|
+
end
|
358
|
+
|
359
|
+
matching.join "\n"
|
360
|
+
end
|
361
|
+
end
|
data/lib/rdoc/attr.rb
CHANGED
data/lib/rdoc/class_module.rb
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
##
|
2
3
|
# ClassModule is the base class for objects representing either a class or a
|
3
4
|
# module.
|
@@ -135,7 +136,9 @@ class RDoc::ClassModule < RDoc::Context
|
|
135
136
|
normalize_comment comment
|
136
137
|
end
|
137
138
|
|
138
|
-
|
139
|
+
if location.parser == RDoc::Parser::C
|
140
|
+
@comment_location.delete_if { |(_, l)| l == location }
|
141
|
+
end
|
139
142
|
|
140
143
|
@comment_location << [comment, location]
|
141
144
|
|
@@ -207,7 +210,7 @@ class RDoc::ClassModule < RDoc::Context
|
|
207
210
|
normalize_comment comment
|
208
211
|
end
|
209
212
|
|
210
|
-
comment = "#{@comment}\n---\n#{comment}" unless @comment.empty?
|
213
|
+
comment = "#{@comment.to_s}\n---\n#{comment.to_s}" unless @comment.empty?
|
211
214
|
|
212
215
|
super comment
|
213
216
|
end
|
data/lib/rdoc/code_object.rb
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
##
|
2
3
|
# Base class for the RDoc code tree.
|
3
4
|
#
|
@@ -68,13 +69,6 @@ class RDoc::CodeObject
|
|
68
69
|
|
69
70
|
attr_reader :metadata
|
70
71
|
|
71
|
-
##
|
72
|
-
# Offset in #file where this CodeObject was defined
|
73
|
-
#--
|
74
|
-
# TODO character or byte?
|
75
|
-
|
76
|
-
attr_accessor :offset
|
77
|
-
|
78
72
|
##
|
79
73
|
# Sets the parent CodeObject
|
80
74
|
|
@@ -149,9 +143,8 @@ class RDoc::CodeObject
|
|
149
143
|
else
|
150
144
|
# HACK correct fix is to have #initialize create @comment
|
151
145
|
# with the correct encoding
|
152
|
-
if String === @comment and
|
153
|
-
|
154
|
-
@comment.force_encoding comment.encoding
|
146
|
+
if String === @comment and @comment.empty? then
|
147
|
+
@comment = RDoc::Encoding.change_encoding @comment, comment.encoding
|
155
148
|
end
|
156
149
|
@comment
|
157
150
|
end
|
@@ -426,4 +419,3 @@ class RDoc::CodeObject
|
|
426
419
|
end
|
427
420
|
|
428
421
|
end
|
429
|
-
|
data/lib/rdoc/code_objects.rb
CHANGED