rdoc 3.12.2 → 4.0.0.preview2

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.

Files changed (200) hide show
  1. checksums.yaml +6 -6
  2. checksums.yaml.gz.sig +0 -0
  3. data.tar.gz.sig +0 -0
  4. data/.autotest +3 -2
  5. data/DEVELOPERS.rdoc +53 -0
  6. data/History.rdoc +159 -25
  7. data/LEGAL.rdoc +12 -0
  8. data/Manifest.txt +56 -3
  9. data/README.rdoc +87 -19
  10. data/Rakefile +11 -2
  11. data/TODO.rdoc +20 -13
  12. data/bin/rdoc +4 -0
  13. data/lib/gauntlet_rdoc.rb +1 -1
  14. data/lib/rdoc.rb +32 -71
  15. data/lib/rdoc/any_method.rb +75 -21
  16. data/lib/rdoc/attr.rb +49 -10
  17. data/lib/rdoc/class_module.rb +182 -32
  18. data/lib/rdoc/code_object.rb +54 -12
  19. data/lib/rdoc/comment.rb +8 -1
  20. data/lib/rdoc/constant.rb +100 -6
  21. data/lib/rdoc/context.rb +93 -41
  22. data/lib/rdoc/context/section.rb +143 -28
  23. data/lib/rdoc/cross_reference.rb +58 -50
  24. data/lib/rdoc/encoding.rb +34 -29
  25. data/lib/rdoc/erb_partial.rb +18 -0
  26. data/lib/rdoc/extend.rb +117 -0
  27. data/lib/rdoc/generator.rb +11 -6
  28. data/lib/rdoc/generator/darkfish.rb +250 -62
  29. data/lib/rdoc/generator/json_index.rb +20 -12
  30. data/lib/rdoc/generator/markup.rb +10 -12
  31. data/lib/rdoc/generator/ri.rb +7 -60
  32. data/lib/rdoc/generator/template/darkfish/_head.rhtml +7 -7
  33. data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +16 -0
  34. data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +1 -1
  35. data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +14 -0
  36. data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +1 -1
  37. data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +13 -0
  38. data/lib/rdoc/generator/template/darkfish/class.rhtml +15 -1
  39. data/lib/rdoc/generator/template/darkfish/images/arrow_up.png +0 -0
  40. data/lib/rdoc/generator/template/darkfish/index.rhtml +3 -3
  41. data/lib/rdoc/generator/template/darkfish/js/darkfish.js +7 -9
  42. data/lib/rdoc/generator/template/darkfish/page.rhtml +2 -0
  43. data/lib/rdoc/generator/template/darkfish/rdoc.css +31 -0
  44. data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +18 -0
  45. data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +37 -0
  46. data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +3 -3
  47. data/lib/rdoc/include.rb +12 -3
  48. data/lib/rdoc/markdown.kpeg +1186 -0
  49. data/lib/rdoc/markdown.rb +16336 -0
  50. data/lib/rdoc/markdown/entities.rb +2128 -0
  51. data/lib/rdoc/markdown/literals_1_8.kpeg +18 -0
  52. data/lib/rdoc/markdown/literals_1_8.rb +454 -0
  53. data/lib/rdoc/markdown/literals_1_9.kpeg +22 -0
  54. data/lib/rdoc/markdown/literals_1_9.rb +417 -0
  55. data/lib/rdoc/markup.rb +69 -10
  56. data/lib/rdoc/markup/attr_changer.rb +2 -5
  57. data/lib/rdoc/markup/attribute_manager.rb +23 -14
  58. data/lib/rdoc/markup/attributes.rb +70 -0
  59. data/lib/rdoc/markup/block_quote.rb +14 -0
  60. data/lib/rdoc/markup/document.rb +20 -4
  61. data/lib/rdoc/markup/formatter.rb +17 -6
  62. data/lib/rdoc/markup/formatter_test_case.rb +93 -24
  63. data/lib/rdoc/markup/hard_break.rb +31 -0
  64. data/lib/rdoc/markup/heading.rb +1 -1
  65. data/lib/rdoc/markup/indented_paragraph.rb +14 -0
  66. data/lib/rdoc/markup/list.rb +23 -4
  67. data/lib/rdoc/markup/list_item.rb +17 -4
  68. data/lib/rdoc/markup/paragraph.rb +14 -0
  69. data/lib/rdoc/markup/parser.rb +107 -60
  70. data/lib/rdoc/markup/raw.rb +4 -4
  71. data/lib/rdoc/markup/special.rb +3 -3
  72. data/lib/rdoc/markup/to_ansi.rb +7 -1
  73. data/lib/rdoc/markup/to_html.rb +42 -14
  74. data/lib/rdoc/markup/to_html_crossref.rb +10 -9
  75. data/lib/rdoc/markup/to_html_snippet.rb +20 -4
  76. data/lib/rdoc/markup/to_joined_paragraph.rb +68 -0
  77. data/lib/rdoc/markup/to_label.rb +20 -1
  78. data/lib/rdoc/markup/to_markdown.rb +134 -0
  79. data/lib/rdoc/markup/to_rdoc.rb +36 -5
  80. data/lib/rdoc/markup/to_table_of_contents.rb +6 -1
  81. data/lib/rdoc/markup/to_tt_only.rb +11 -2
  82. data/lib/rdoc/markup/verbatim.rb +19 -0
  83. data/lib/rdoc/method_attr.rb +33 -19
  84. data/lib/rdoc/normal_class.rb +26 -7
  85. data/lib/rdoc/normal_module.rb +10 -5
  86. data/lib/rdoc/options.rb +95 -21
  87. data/lib/rdoc/parser.rb +6 -2
  88. data/lib/rdoc/parser/c.rb +212 -97
  89. data/lib/rdoc/parser/markdown.rb +23 -0
  90. data/lib/rdoc/parser/ruby.rb +115 -35
  91. data/lib/rdoc/parser/ruby_tools.rb +8 -3
  92. data/lib/rdoc/rd.rb +8 -4
  93. data/lib/rdoc/rd/block_parser.rb +1 -1
  94. data/lib/rdoc/rd/block_parser.ry +1 -1
  95. data/lib/rdoc/rdoc.rb +45 -21
  96. data/lib/rdoc/ri/driver.rb +322 -76
  97. data/lib/rdoc/ri/paths.rb +90 -31
  98. data/lib/rdoc/ri/store.rb +2 -353
  99. data/lib/rdoc/ruby_lex.rb +5 -21
  100. data/lib/rdoc/ruby_token.rb +2 -3
  101. data/lib/rdoc/rubygems_hook.rb +21 -9
  102. data/lib/rdoc/servlet.rb +302 -0
  103. data/lib/rdoc/stats.rb +28 -20
  104. data/lib/rdoc/store.rb +881 -0
  105. data/lib/rdoc/task.rb +2 -1
  106. data/lib/rdoc/test_case.rb +103 -1
  107. data/lib/rdoc/text.rb +5 -4
  108. data/lib/rdoc/tom_doc.rb +17 -16
  109. data/lib/rdoc/top_level.rb +43 -285
  110. data/test/MarkdownTest_1.0.3/Amps and angle encoding.text +21 -0
  111. data/test/MarkdownTest_1.0.3/Auto links.text +13 -0
  112. data/test/MarkdownTest_1.0.3/Backslash escapes.text +120 -0
  113. data/test/MarkdownTest_1.0.3/Blockquotes with code blocks.text +11 -0
  114. data/test/MarkdownTest_1.0.3/Code Blocks.text +14 -0
  115. data/test/MarkdownTest_1.0.3/Code Spans.text +6 -0
  116. data/test/MarkdownTest_1.0.3/Hard-wrapped paragraphs with list-like lines.text +8 -0
  117. data/test/MarkdownTest_1.0.3/Horizontal rules.text +67 -0
  118. data/test/MarkdownTest_1.0.3/Inline HTML (Advanced).text +15 -0
  119. data/test/MarkdownTest_1.0.3/Inline HTML (Simple).text +69 -0
  120. data/test/MarkdownTest_1.0.3/Inline HTML comments.text +13 -0
  121. data/test/MarkdownTest_1.0.3/Links, inline style.text +12 -0
  122. data/test/MarkdownTest_1.0.3/Links, reference style.text +71 -0
  123. data/test/MarkdownTest_1.0.3/Links, shortcut references.text +20 -0
  124. data/test/MarkdownTest_1.0.3/Literal quotes in titles.text +7 -0
  125. data/test/MarkdownTest_1.0.3/Markdown Documentation - Basics.text +306 -0
  126. data/test/MarkdownTest_1.0.3/Markdown Documentation - Syntax.text +888 -0
  127. data/test/MarkdownTest_1.0.3/Nested blockquotes.text +5 -0
  128. data/test/MarkdownTest_1.0.3/Ordered and unordered lists.text +131 -0
  129. data/test/MarkdownTest_1.0.3/Strong and em together.text +7 -0
  130. data/test/MarkdownTest_1.0.3/Tabs.text +21 -0
  131. data/test/MarkdownTest_1.0.3/Tidyness.text +5 -0
  132. data/test/test_attribute_manager.rb +7 -4
  133. data/test/test_rdoc_any_method.rb +84 -13
  134. data/test/test_rdoc_attr.rb +59 -9
  135. data/test/test_rdoc_class_module.rb +670 -73
  136. data/test/test_rdoc_code_object.rb +21 -1
  137. data/test/test_rdoc_comment.rb +1 -1
  138. data/test/test_rdoc_constant.rb +132 -0
  139. data/test/test_rdoc_context.rb +84 -18
  140. data/test/test_rdoc_context_section.rb +99 -15
  141. data/test/test_rdoc_cross_reference.rb +1 -1
  142. data/test/test_rdoc_encoding.rb +17 -1
  143. data/test/test_rdoc_extend.rb +94 -0
  144. data/test/test_rdoc_generator_darkfish.rb +45 -19
  145. data/test/test_rdoc_generator_json_index.rb +27 -7
  146. data/test/test_rdoc_generator_markup.rb +3 -3
  147. data/test/test_rdoc_generator_ri.rb +11 -9
  148. data/test/test_rdoc_include.rb +12 -0
  149. data/test/test_rdoc_markdown.rb +977 -0
  150. data/test/test_rdoc_markdown_test.rb +1891 -0
  151. data/test/test_rdoc_markup.rb +1 -1
  152. data/test/test_rdoc_markup_attribute_manager.rb +2 -2
  153. data/test/test_rdoc_markup_attributes.rb +39 -0
  154. data/test/test_rdoc_markup_document.rb +16 -1
  155. data/test/test_rdoc_markup_formatter.rb +7 -4
  156. data/test/test_rdoc_markup_hard_break.rb +31 -0
  157. data/test/test_rdoc_markup_indented_paragraph.rb +14 -0
  158. data/test/test_rdoc_markup_paragraph.rb +15 -1
  159. data/test/test_rdoc_markup_parser.rb +152 -89
  160. data/test/test_rdoc_markup_to_ansi.rb +23 -2
  161. data/test/test_rdoc_markup_to_bs.rb +24 -0
  162. data/test/test_rdoc_markup_to_html.rb +50 -19
  163. data/test/test_rdoc_markup_to_html_crossref.rb +23 -5
  164. data/test/test_rdoc_markup_to_html_snippet.rb +49 -8
  165. data/test/test_rdoc_markup_to_joined_paragraph.rb +32 -0
  166. data/test/test_rdoc_markup_to_label.rb +63 -1
  167. data/test/test_rdoc_markup_to_markdown.rb +352 -0
  168. data/test/test_rdoc_markup_to_rdoc.rb +22 -2
  169. data/test/test_rdoc_markup_to_table_of_contents.rb +44 -39
  170. data/test/test_rdoc_markup_to_tt_only.rb +20 -0
  171. data/test/test_rdoc_markup_verbatim.rb +13 -0
  172. data/test/test_rdoc_method_attr.rb +5 -0
  173. data/test/test_rdoc_normal_class.rb +24 -5
  174. data/test/test_rdoc_normal_module.rb +1 -1
  175. data/test/test_rdoc_options.rb +21 -6
  176. data/test/test_rdoc_parser.rb +24 -0
  177. data/test/test_rdoc_parser_c.rb +151 -26
  178. data/test/test_rdoc_parser_markdown.rb +55 -0
  179. data/test/test_rdoc_parser_rd.rb +2 -2
  180. data/test/test_rdoc_parser_ruby.rb +468 -109
  181. data/test/test_rdoc_parser_simple.rb +2 -2
  182. data/test/test_rdoc_rd_block_parser.rb +0 -4
  183. data/test/test_rdoc_rdoc.rb +110 -22
  184. data/test/test_rdoc_ri_driver.rb +415 -80
  185. data/test/test_rdoc_ri_paths.rb +122 -13
  186. data/test/test_rdoc_ruby_lex.rb +5 -61
  187. data/test/test_rdoc_ruby_token.rb +19 -0
  188. data/test/test_rdoc_rubygems_hook.rb +64 -43
  189. data/test/test_rdoc_servlet.rb +429 -0
  190. data/test/test_rdoc_stats.rb +83 -24
  191. data/test/{test_rdoc_ri_store.rb → test_rdoc_store.rb} +395 -22
  192. data/test/test_rdoc_task.rb +2 -2
  193. data/test/test_rdoc_text.rb +37 -11
  194. data/test/test_rdoc_tom_doc.rb +59 -62
  195. data/test/test_rdoc_top_level.rb +71 -113
  196. data/test/xref_test_case.rb +7 -9
  197. metadata +122 -39
  198. metadata.gz.sig +0 -0
  199. data/CVE-2013-0256.rdoc +0 -49
  200. data/lib/rdoc/markup/attribute.rb +0 -51
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 3b704b430d22c0010c5bf44dff765cdeff8332cf
4
- data.tar.gz: ed7f5ac64e53d6e684172983e26fb417af9e826c
5
- SHA512:
6
- metadata.gz: 5b3e509ae9b95e66eead63f2f0252f98ec04c3c9779df939ceddad9c0c9d5e71f0e107868fb33fe3e9f445e07a671c1e3de33236952b4fc2e54ca85592dea971
7
- data.tar.gz: 06800292e99ab9b0648acc38922d1034c124a23df8ed31ac22453449ce90b591f5bc9afa5181857492245511eb2ca33d5136e0dee76702785bfc20fa72449b86
2
+ !binary "U0hBMQ==":
3
+ metadata.gz: bd558c2cff419547ec57eda5fe512659e1dd04b4
4
+ data.tar.gz: 1981e42e56784ea75c8bd9b9428e3da5c3ec695b
5
+ !binary "U0hBNTEy":
6
+ metadata.gz: c3cebbb886df27b7ffb2288b958247f84e7b6a286dc0438544012d51d8402e804f84099ea421277c40b26b82f70c5c83d47a72bfe395c183273f885355925f98
7
+ data.tar.gz: be6380482a950fd82393784de7df78027ea3ea70f83d2e863041a9400fd56e84ace8f5a240a1247b7e4c36745b004ea810893e332b54b9aa43d0762691d26314
Binary file
data.tar.gz.sig CHANGED
Binary file
data/.autotest CHANGED
@@ -7,9 +7,10 @@ Autotest.add_hook :run_command do |at|
7
7
  end
8
8
 
9
9
  Autotest.add_hook :initialize do |at|
10
- at.testlib = 'minitest/unit' if at.respond_to? :testlib=
10
+ at.testlib = 'minitest/autorun'
11
+ at.add_exception '.git'
11
12
 
12
- def at.path_to_classname(s)
13
+ def at.path_to_classname s
13
14
  sep = File::SEPARATOR
14
15
  f = s.sub(/^test#{sep}/, '').sub(/\.rb$/, '').split(sep)
15
16
  f = f.map { |path| path.split(/_|(\d+)/).map { |seg| seg.capitalize }.join }
@@ -17,6 +17,46 @@ the issue. Here are some examples of good issues:
17
17
  * https://github.com/rdoc/rdoc/issues/55
18
18
  * https://github.com/rdoc/rdoc/issues/61
19
19
 
20
+ == Glossary
21
+
22
+ Here are definitions for some common terms in the RDoc documentation. The
23
+ list also briefly describes how the components of RDoc interact.
24
+
25
+ parser::
26
+ Parses files and creates a documentation tree from the contents.
27
+
28
+ documentation tree::
29
+ The documentation tree represents files, classes, modules, methods,
30
+ constants, includes, comments and other ruby syntax features as a tree.
31
+ RDoc walks this tree with a generator to create documentation.
32
+
33
+ generator::
34
+ Walks the documentation tree and generates output.
35
+
36
+ RDoc ships with two generators, the Darkfish generator creates HTML and the
37
+ RI generator creates an RI data store.
38
+
39
+ markup parser::
40
+ Parses comments from a file into a generic markup tree.
41
+
42
+ The markup parsers allow RDoc to handle RDoc, TomDoc, rd and Markdown format
43
+ documentation with common formatters.
44
+
45
+ markup tree::
46
+ Each parsed comment has a markup tree that represents common markup items
47
+ such as headings, paragraphs, lists or verbatim text sections for example
48
+ code or output.
49
+
50
+ A generator uses a formatters to walks the tree to create output. Some
51
+ generators use multiple formatters on a markup tree to produce the output.
52
+
53
+ formatter::
54
+ Converts a parsed markup tree into some form other form of markup.
55
+
56
+ Formatters can either produce a one-to-one conversion, such as ToHtml, or
57
+ extract part of the parsed result, such as ToHtmlSnippet which outputs the
58
+ first 100 characters as HTML.
59
+
20
60
  == Plugins
21
61
 
22
62
  When 'rdoc/rdoc' is loaded RDoc looks for 'rdoc/discover' files in your
@@ -139,3 +179,16 @@ JSON-based search index and includes a search engine for use with HTML output.
139
179
  This generator can be used to add searching to any HTML output and is designed
140
180
  to be called from inside an HTML generator.
141
181
 
182
+ == Markup
183
+
184
+ Additional documentation markup formats can be added to RDoc. A markup
185
+ parsing class must respond to \::parse and accept a String argument containing
186
+ the markup format. An RDoc::Document containing documentation items
187
+ (RDoc::Markup::Heading, RDoc::Markup::Paragraph, RDoc::Markup::Verbatim, etc.)
188
+ must be returned.
189
+
190
+ To register the parser with rdoc, add the markup type's name and class to the
191
+ RDoc::Text::MARKUP_FORMAT hash like:
192
+
193
+ RDoc::Text::MARKUP_FORMAT['rdoc'] = RDoc::Markup
194
+
@@ -1,24 +1,158 @@
1
- === 3.12.2 / 2013-02-24
1
+ === 4.0.0.preview2
2
+
3
+ As a preview release, please file bugs for any problems you have with rdoc at
4
+ https://github.com/rdoc/rdoc/issues
5
+
6
+ RDoc 4.0 includes several new features and several breaking changes. The
7
+ changes should not affect users of `rdoc` or `ri`.
8
+
9
+ Notable feature additions are markdown support and an WEBrick servlet that can
10
+ serve HTML from an ri store. (This means that RubyGems 2.0+ no longer needs
11
+ to build HTML documentation when installing gems.)
12
+
13
+ * Breaking changes
14
+ * The default output encoding for RDoc is now UTF-8. Previously RDoc used
15
+ the default external encoding which was determined from your locale.
16
+ Issue #106 by Justin Baker.
17
+ * RDoc::RI::Store is now RDoc::Store so ri data generated by RDoc 4 cannot
18
+ be read by earlier versions of RDoc. RDoc::RI::Store exists as an alias
19
+ of RDoc::Store so ri data from older versions can still be read.
20
+ RDoc::RI::Store will be removed in RDoc 5.
21
+
22
+ Tests that create RDoc::CodeObjects on the fly without wiring them into
23
+ the documentation tree (did not use add_class, add_method, etc.) must be
24
+ updated to use these methods. The documentation tree automatically
25
+ attaches them to the store instance which allows lookups to work
26
+ correctly. Additionally, a new method RDoc::Store#add_file must be used
27
+ instead of RDoc::TopLevel.new. The latter will not be attached to the
28
+ documentation tree.
29
+ * RDoc generators must accept an RDoc::Store and an RDoc::Options in
30
+ initialize. RDoc no longer passes an Array of RDoc::TopLevel objects to
31
+ #generate. Use RDoc::Store#all_files instead.
32
+ * Some markup formatters (RDoc::Markup::To*) now accept an RDoc::Options
33
+ instance as the first argument. Notably, the base class Formatter and
34
+ ToHtml*. (This is not universal due to the difficult at accessing the
35
+ user's options instance deep inside RDoc. A future major release may
36
+ remedy this.)
37
+ * Added new markup nodes and specials that RDoc::Markup::Formatter
38
+ subclasses must handle. If you're using RDoc::Markup::FormatterTestCase
39
+ the new methods you need to add should be readily apparent.
40
+ * Removed RDoc::RI::Paths::SYSDIR and ::SITEDIR. These were hidden
41
+ constants so no breakage is expected. Use RDoc::RI::Paths::system_dir
42
+ and ::site_dir instead.
43
+ * RDoc::RI::Store#modules has been renamed to RDoc::Store#module_names
44
+ to avoid confusion with RDoc::Store#all_modules imported from
45
+ RDoc::TopLevel.
46
+ * RDoc::RDocError has been removed. It was deprecated throughout RDoc 3.
47
+ * ri -f html is no longer supported.
48
+ * Comment definitions in C comments are now only discovered from the first
49
+ line. A colon on a subsequent line won't trigger definition extraction.
50
+ Issue #103, see also
51
+ http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/42942
52
+ * Fixed :stopdoc: for class A::B where A has not been seen. Issue #95 by
53
+ Ryan Davis
54
+ * RDoc::ClassModule#each_ancestor no longer yields itself if there is
55
+ circular ancestry
56
+
57
+ * Major enhancements
58
+ * ri can now show pages (README, etc.)
59
+
60
+ ri rdoc:README
61
+
62
+ Will show the README for the latest version of RDoc. You can specify
63
+ exact gem versions such as "rdoc-4.0:README" or view pages from the
64
+ standard library documentation with "ruby:README".
65
+
66
+ RDoc 3 did not save pages in ri data so you will need to regenerate
67
+ documentation from your gems to use this feature.
68
+ * Added Markdown as a supported format. The markdown format can be set on a
69
+ per-file or per-comment basis with the +:markdown:+ directive like the rd
70
+ and tomdoc formats and on a per-project basis with
71
+ <tt>rdoc --markup markdown --write-options</tt>
72
+ * Removed global state from RDoc. RDoc::Store holds the documentation tree
73
+ and connects the driver to the parsers and generator. This also allows
74
+ documentation parsing and generation for multiple instances, but the rdoc
75
+ command-line tool does not support this.
76
+
77
+ Due to this change RDoc::RDoc.current and RDoc::RDoc.reset no longer
78
+ exist.
79
+
80
+ * Minor enhancements
81
+ * Added --root for building documentation from outside the source dir.
82
+ * Added a table of contents to the sidebar.
83
+ * RDoc markup format merges adjacent labels in a label or note list into a
84
+ single definition list item for output.
85
+ * RDoc now tracks use of extend. Pull request #118 by Michael Granger.
86
+ * RDoc now tracks methods that use super. Pull request #116 by Erik
87
+ Hollensbe.
88
+ * Added methods ::system_dir, ::site_dir, ::home_dir and ::gem_dir to fetch
89
+ the components of RDoc::RI::Paths.path individually.
90
+ * Added support for rb_file_const.
91
+ * RDoc now processes files in sorted order. Issue #71 by Vít Ondruch
92
+ * RDoc now warns with --verbose when methods are duplicated. Issue #71 by
93
+ Vít Ondruch
94
+ * ri will display documentation for all methods in a class if -a is given.
95
+ Issue #57 by casper
96
+ * The RDoc coverage report will report line information for attributes,
97
+ constants and methods missing documentation. Issue #121 by Zachary Scott
98
+ * RDoc now reports a warning for files that are unreadable due to
99
+ permissions problems.
100
+ * RDoc controls documentation generation for RubyGems 2.0+
2
101
 
3
102
  * Bug fixes
103
+ * A word that is directly followed by a multi-word tidy link label no longer
104
+ disappears. (Like <code>text{link}[http://example]</code>)
105
+ * Fixed legacy template support. Pull Request #107 by Justin Baker.
106
+ * An HTML class in a verbatim section no longer triggers ruby parsing.
107
+ Issue #92 by Vijay Dev
108
+ * Improved documentation for setting the default documentation format for
109
+ your ruby project. Issue #94 by Henrik Hodne
110
+ * Fixed handling of LANG in the RDoc::Options tests. Issue #99 by Vít
111
+ Ondruch
112
+ * RDoc no longer quits when given an entry that is not a file or directory.
113
+ Issue #101 by Charles Nutter
4
114
  * Fixed bug in syntax-highlighting that would corrupt regular expressions.
5
115
  Ruby Bug #6488 by Benny Lyne Amorsen.
6
- * Fixed lexing of character syntax (<code>?x</code>). Reported by Xavier
116
+ * "class Object" no longer appears in the coverage report if all its methods
117
+ are documented. This suppresses a false positive for libraries that add
118
+ toplevel methods. Pull Request #128 by Zachary Scott.
119
+ * Fixed test_gen_url test name in TestRDocMarkupToHtml. Pull Request #130
120
+ by Zachary Scott.
121
+ * Comment-defined methods ahead of define_method are now discovered. Issue
122
+ #133 by eclectic923
123
+ * Fixed detection of define_method documentation. Issue #138 by Marvin
124
+ Gülker.
125
+ * Fixed lexing of character syntax (<code>?z</code>). Reported by Xavier
7
126
  Noria.
127
+ * Add license to gem spec. Issue #144 by pivotalcommon
128
+ * Fixed comment selection for classes. Pull request #146 by pioz
129
+ * Fixed parsing of <code>def self.&() end</code>. Issue #148 by Michael
130
+ Lucy
131
+ * Generated RD parser files are now included in the gem. Issue #145 by
132
+ Marvin Gülker
133
+ * Class and module aliases now create new classes to avoid duplicate names
134
+ in the class list. Issue #143 by Richard Schneeman, Rails Issue #2839
135
+ * RDoc::Markup::Parser now correctly matches indentation of lists when
136
+ multibyte characters are used in the list labels. Issue #140 by
137
+ burningTyger
138
+ * Fixed mangling of email addresses that look like labels. Issue #129 by
139
+ Tobias Koch
140
+ * Classes and modules in a C file may now be created in any order. Issue
141
+ #124 by Su Zhang
142
+ * A metaprogrammed method supports the :args: directive. Issue #100
143
+ * A metaprogrammed method supports the :yields: directive.
144
+ * RDoc will now look for directives up to the end of the line. For example,
145
+ class B < A; end # :nodoc:
146
+ will now hide documentation of B. Issue #125 by Zachary Scott
8
147
  * Fixed tokenization of % when it is not followed by a $-string type
9
148
  * Fixed display of __END__ in documentation examples in HTML output
10
149
  * Fixed tokenization of reserved words used as new-style hash keys
11
- * Fixed HEREDOC output for the limited case of a heredoc followed by a line
12
- end. When a HEREDOC is not followed by a line end RDoc is not currently
13
- smart enough to restore the source correctly. Bug #162 by Zachary Scott.
14
-
15
- === 3.12.1 / 2013-02-05
16
-
17
- * Bug fixes
18
- * Fixed an XSS exploit in darkfish.js. This could lead to cookie disclosure
19
- to third parties. See CVE-2013-0256[rdoc-ref:CVE-2013-0256.rdoc] for full
20
- details including a patch you can apply to generated RDoc documentation.
21
- * Ensured that rd parser files are generated before checking the manifest.
150
+ * RDoc now handles class << $gvar by ignoring the body
151
+ * Fixed parsing of class A:: B.
152
+ * Worked around bug in RDoc::RubyLex where tokens won't be reinterpreted
153
+ after unget_tk.
154
+ * Fixed class << ::Foo writing documentation to /Foo.html
155
+ * Fixed class ::A referencing itself from inside its own namespace.
22
156
 
23
157
  === 3.12 / 2011-12-15
24
158
 
@@ -28,10 +162,10 @@
28
162
  * Improved title for HTML output to include <code>--title</code> in the
29
163
  title element.
30
164
  * <code>rdoc --pipe</code> now understands <code>--markup</code>.
31
- * RDoc now supports irc-scheme hyperlinks. Issue #83 by trans.
165
+ * RDoc now supports IRC-scheme hyperlinks. Issue #83 by trans.
32
166
 
33
167
  * Bug fixes
34
- * Fix title on HTML output for pages.
168
+ * Fixed title on HTML output for pages.
35
169
  * Fixed parsing of non-indented HEREDOC.
36
170
  * Fixed parsing of <code>%w[]</code> and other % literals. Issue #84 by
37
171
  Erik Hollensbe
@@ -287,9 +421,9 @@
287
421
  === 3.5.3 / 2010-02-06
288
422
 
289
423
  * Bug fixes
290
- * When including a file lossily force-transcode it to the output encoding
291
- instead of crashing to preserve as much content as possible. Ruby Bug
292
- #4376 by Yui NARUSE.
424
+ * When including a file perform a lossy force-transcoding to the output
425
+ encoding instead of crashing to preserve as much content as possible.
426
+ Ruby Bug #4376 by Yui NARUSE.
293
427
  * Work around inconsistent encoding result from String#sub!, String#gsub!.
294
428
  Related to Ruby Bug #4376.
295
429
  * Work around inconsistent encoding result from String#[]=. Related to Ruby
@@ -626,7 +760,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
626
760
  === 2.5.4 / 2010-04-18
627
761
 
628
762
  * 2 Minor Enhancements
629
- * Methods will now be cross-referenced when preceeded with ::. Ruby Bug
763
+ * Methods will now be cross-referenced when preceded with ::. Ruby Bug
630
764
  #3169 by Marc-Andre Lafortune.
631
765
  * Methods now have human readable fragment identifiers for HTML output.
632
766
  (#method-i-gsub vs #M000005). Ruby Bug #3023 by Marc-Andre Lafortune.
@@ -714,7 +848,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
714
848
  * Images are no longer executable. Bug #27156.
715
849
  * --op is no longer overridden by --ri. Bug #27054.
716
850
  * :method: now works when at the end of a class. Bug #26910.
717
- * Preserve elipsis from call-seq in Darkfish. Patch #26974.
851
+ * Preserve ellipsis from call-seq in Darkfish. Patch #26974.
718
852
  * Emacs-style <tt>coding:</tt> is handled properly. Patch #27388.
719
853
  * RDoc::RubyLex now parses UTF-8 identifiers. Bug #26946, #26947.
720
854
  * Fixed namespace lookup rules. Bug #26161.
@@ -782,8 +916,8 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
782
916
  * Added method list to index.html
783
917
 
784
918
  * 6 Bug Fixes
785
- * nodoc'd classes no longer appear in the index. Bug #23751 by Clifford
786
- Heath.
919
+ * A class marked nodoc no longer appears in the index. Bug #23751 by
920
+ Clifford Heath.
787
921
  * Fix 1.9 compatibility issues. Bug #23815 by paddor.
788
922
  * Darkfish now respects --charset
789
923
  * RDoc no longer attempts to be lazy when building HTML. This is a
@@ -816,7 +950,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
816
950
  * Ignore nonexistent files instead of crashing
817
951
  * .txt and .rdoc files are always considered text. Patch #22897 by Aaron
818
952
  Patterson.
819
- * When merging ri data with a nonexistant directory, RDoc no longer crashes
953
+ * When merging ri data with a nonexistent directory, RDoc no longer crashes
820
954
  * Fix visibility of methods in XML output. Issue by Yehuda Katz.
821
955
  * Fixed relative link generation
822
956
  * Fix crash, RDoc now ignores comments above local variable assignments in
@@ -908,7 +1042,7 @@ documentation about ri.
908
1042
  * Fixed a case where RDoc first would encounter Foo::Bar and then would
909
1043
  encounter class Foo. Previously, RDoc erroneously would have considered
910
1044
  that both a Foo class and a Foo module existed.
911
- * Fix a clase where RDoc would not generate correct cross-reference links
1045
+ * Fix a class where RDoc would not generate correct cross-reference links
912
1046
  to a class contained within a module of the same name (i.e. RDoc::RDoc)
913
1047
  * Prevented RDoc from trying to parse binary files, which would produce
914
1048
  garbage output.
@@ -960,7 +1094,7 @@ documentation about ri.
960
1094
  * Sections work in the default template again
961
1095
  * Doesn't warn about :foo:: list item being an unrecognized directive
962
1096
  * RDoc no longer converts characters inside tt tags
963
- * Fixed "unitialized constant RDoc::Markup::ToHtml::HTML"
1097
+ * Fixed "uninitialized constant RDoc::Markup::ToHtml::HTML"
964
1098
  * Fixed generation of relative links
965
1099
  * Fixed various diagram generation issues
966
1100
  * Fixed templates broken by switch to erb
data/LEGAL.rdoc CHANGED
@@ -25,3 +25,15 @@ Sdoc::
25
25
  from sdoc.
26
26
  * RDoc::ClassModule#document_self_or_methods comes from Sdoc.
27
27
 
28
+ peg-markdown::
29
+ RDoc's Markdown support is derived from peg-markdown by John MacFarlane. It
30
+ is used under the MIT license. See RDoc::Markdown for license details.
31
+
32
+ MarkdownTest::
33
+ test/test_rdoc_markdown_test.rb uses MarkdownTest 1.0.3's source files which
34
+ are included as test/MarkdownTest_1.0.3/*.text which are Copyright (c)
35
+ 2004-2005 John Gruber http://daringfireball.net and is included under the
36
+ same terms as Perl itself.
37
+
38
+ See http://dev.perl.org/licenses/ for the terms of the Perl license.
39
+
@@ -1,6 +1,5 @@
1
1
  .autotest
2
2
  .document
3
- CVE-2013-0256.rdoc
4
3
  DEVELOPERS.rdoc
5
4
  History.rdoc
6
5
  LEGAL.rdoc
@@ -27,7 +26,9 @@ lib/rdoc/context.rb
27
26
  lib/rdoc/context/section.rb
28
27
  lib/rdoc/cross_reference.rb
29
28
  lib/rdoc/encoding.rb
29
+ lib/rdoc/erb_partial.rb
30
30
  lib/rdoc/erbio.rb
31
+ lib/rdoc/extend.rb
31
32
  lib/rdoc/generator.rb
32
33
  lib/rdoc/generator/darkfish.rb
33
34
  lib/rdoc/generator/json_index.rb
@@ -38,16 +39,20 @@ lib/rdoc/generator/template/darkfish/_footer.rhtml
38
39
  lib/rdoc/generator/template/darkfish/_head.rhtml
39
40
  lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml
40
41
  lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml
42
+ lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml
41
43
  lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml
42
44
  lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml
45
+ lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml
43
46
  lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml
44
47
  lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml
45
48
  lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml
46
49
  lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml
47
50
  lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
48
51
  lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
52
+ lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml
49
53
  lib/rdoc/generator/template/darkfish/class.rhtml
50
54
  lib/rdoc/generator/template/darkfish/images/add.png
55
+ lib/rdoc/generator/template/darkfish/images/arrow_up.png
51
56
  lib/rdoc/generator/template/darkfish/images/brick.png
52
57
  lib/rdoc/generator/template/darkfish/images/brick_link.png
53
58
  lib/rdoc/generator/template/darkfish/images/bug.png
@@ -77,21 +82,32 @@ lib/rdoc/generator/template/darkfish/js/jquery.js
77
82
  lib/rdoc/generator/template/darkfish/js/search.js
78
83
  lib/rdoc/generator/template/darkfish/page.rhtml
79
84
  lib/rdoc/generator/template/darkfish/rdoc.css
85
+ lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
86
+ lib/rdoc/generator/template/darkfish/servlet_root.rhtml
80
87
  lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
81
88
  lib/rdoc/generator/template/json_index/js/navigation.js
82
89
  lib/rdoc/generator/template/json_index/js/searcher.js
83
90
  lib/rdoc/ghost_method.rb
84
91
  lib/rdoc/include.rb
85
92
  lib/rdoc/known_classes.rb
93
+ lib/rdoc/markdown.kpeg
94
+ lib/rdoc/markdown.rb
95
+ lib/rdoc/markdown/entities.rb
96
+ lib/rdoc/markdown/literals_1_8.kpeg
97
+ lib/rdoc/markdown/literals_1_8.rb
98
+ lib/rdoc/markdown/literals_1_9.kpeg
99
+ lib/rdoc/markdown/literals_1_9.rb
86
100
  lib/rdoc/markup.rb
87
101
  lib/rdoc/markup/attr_changer.rb
88
102
  lib/rdoc/markup/attr_span.rb
89
- lib/rdoc/markup/attribute.rb
90
103
  lib/rdoc/markup/attribute_manager.rb
104
+ lib/rdoc/markup/attributes.rb
91
105
  lib/rdoc/markup/blank_line.rb
106
+ lib/rdoc/markup/block_quote.rb
92
107
  lib/rdoc/markup/document.rb
93
108
  lib/rdoc/markup/formatter.rb
94
109
  lib/rdoc/markup/formatter_test_case.rb
110
+ lib/rdoc/markup/hard_break.rb
95
111
  lib/rdoc/markup/heading.rb
96
112
  lib/rdoc/markup/include.rb
97
113
  lib/rdoc/markup/indented_paragraph.rb
@@ -110,7 +126,9 @@ lib/rdoc/markup/to_bs.rb
110
126
  lib/rdoc/markup/to_html.rb
111
127
  lib/rdoc/markup/to_html_crossref.rb
112
128
  lib/rdoc/markup/to_html_snippet.rb
129
+ lib/rdoc/markup/to_joined_paragraph.rb
113
130
  lib/rdoc/markup/to_label.rb
131
+ lib/rdoc/markup/to_markdown.rb
114
132
  lib/rdoc/markup/to_rdoc.rb
115
133
  lib/rdoc/markup/to_table_of_contents.rb
116
134
  lib/rdoc/markup/to_test.rb
@@ -123,6 +141,7 @@ lib/rdoc/normal_module.rb
123
141
  lib/rdoc/options.rb
124
142
  lib/rdoc/parser.rb
125
143
  lib/rdoc/parser/c.rb
144
+ lib/rdoc/parser/markdown.rb
126
145
  lib/rdoc/parser/rd.rb
127
146
  lib/rdoc/parser/ruby.rb
128
147
  lib/rdoc/parser/ruby_tools.rb
@@ -144,17 +163,41 @@ lib/rdoc/ri/store.rb
144
163
  lib/rdoc/ruby_lex.rb
145
164
  lib/rdoc/ruby_token.rb
146
165
  lib/rdoc/rubygems_hook.rb
166
+ lib/rdoc/servlet.rb
147
167
  lib/rdoc/single_class.rb
148
168
  lib/rdoc/stats.rb
149
169
  lib/rdoc/stats/normal.rb
150
170
  lib/rdoc/stats/quiet.rb
151
171
  lib/rdoc/stats/verbose.rb
172
+ lib/rdoc/store.rb
152
173
  lib/rdoc/task.rb
153
174
  lib/rdoc/test_case.rb
154
175
  lib/rdoc/text.rb
155
176
  lib/rdoc/token_stream.rb
156
177
  lib/rdoc/tom_doc.rb
157
178
  lib/rdoc/top_level.rb
179
+ test/MarkdownTest_1.0.3/Amps and angle encoding.text
180
+ test/MarkdownTest_1.0.3/Auto links.text
181
+ test/MarkdownTest_1.0.3/Backslash escapes.text
182
+ test/MarkdownTest_1.0.3/Blockquotes with code blocks.text
183
+ test/MarkdownTest_1.0.3/Code Blocks.text
184
+ test/MarkdownTest_1.0.3/Code Spans.text
185
+ test/MarkdownTest_1.0.3/Hard-wrapped paragraphs with list-like lines.text
186
+ test/MarkdownTest_1.0.3/Horizontal rules.text
187
+ test/MarkdownTest_1.0.3/Inline HTML (Advanced).text
188
+ test/MarkdownTest_1.0.3/Inline HTML (Simple).text
189
+ test/MarkdownTest_1.0.3/Inline HTML comments.text
190
+ test/MarkdownTest_1.0.3/Links, inline style.text
191
+ test/MarkdownTest_1.0.3/Links, reference style.text
192
+ test/MarkdownTest_1.0.3/Links, shortcut references.text
193
+ test/MarkdownTest_1.0.3/Literal quotes in titles.text
194
+ test/MarkdownTest_1.0.3/Markdown Documentation - Basics.text
195
+ test/MarkdownTest_1.0.3/Markdown Documentation - Syntax.text
196
+ test/MarkdownTest_1.0.3/Nested blockquotes.text
197
+ test/MarkdownTest_1.0.3/Ordered and unordered lists.text
198
+ test/MarkdownTest_1.0.3/Strong and em together.text
199
+ test/MarkdownTest_1.0.3/Tabs.text
200
+ test/MarkdownTest_1.0.3/Tidyness.text
158
201
  test/README
159
202
  test/binary.dat
160
203
  test/hidden.zip.txt
@@ -174,15 +217,20 @@ test/test_rdoc_context.rb
174
217
  test/test_rdoc_context_section.rb
175
218
  test/test_rdoc_cross_reference.rb
176
219
  test/test_rdoc_encoding.rb
220
+ test/test_rdoc_extend.rb
177
221
  test/test_rdoc_generator_darkfish.rb
178
222
  test/test_rdoc_generator_json_index.rb
179
223
  test/test_rdoc_generator_markup.rb
180
224
  test/test_rdoc_generator_ri.rb
181
225
  test/test_rdoc_include.rb
226
+ test/test_rdoc_markdown.rb
227
+ test/test_rdoc_markdown_test.rb
182
228
  test/test_rdoc_markup.rb
183
229
  test/test_rdoc_markup_attribute_manager.rb
230
+ test/test_rdoc_markup_attributes.rb
184
231
  test/test_rdoc_markup_document.rb
185
232
  test/test_rdoc_markup_formatter.rb
233
+ test/test_rdoc_markup_hard_break.rb
186
234
  test/test_rdoc_markup_heading.rb
187
235
  test/test_rdoc_markup_include.rb
188
236
  test/test_rdoc_markup_indented_paragraph.rb
@@ -195,7 +243,9 @@ test/test_rdoc_markup_to_bs.rb
195
243
  test/test_rdoc_markup_to_html.rb
196
244
  test/test_rdoc_markup_to_html_crossref.rb
197
245
  test/test_rdoc_markup_to_html_snippet.rb
246
+ test/test_rdoc_markup_to_joined_paragraph.rb
198
247
  test/test_rdoc_markup_to_label.rb
248
+ test/test_rdoc_markup_to_markdown.rb
199
249
  test/test_rdoc_markup_to_rdoc.rb
200
250
  test/test_rdoc_markup_to_table_of_contents.rb
201
251
  test/test_rdoc_markup_to_tt_only.rb
@@ -206,6 +256,7 @@ test/test_rdoc_normal_module.rb
206
256
  test/test_rdoc_options.rb
207
257
  test/test_rdoc_parser.rb
208
258
  test/test_rdoc_parser_c.rb
259
+ test/test_rdoc_parser_markdown.rb
209
260
  test/test_rdoc_parser_rd.rb
210
261
  test/test_rdoc_parser_ruby.rb
211
262
  test/test_rdoc_parser_simple.rb
@@ -217,11 +268,13 @@ test/test_rdoc_rdoc.rb
217
268
  test/test_rdoc_require.rb
218
269
  test/test_rdoc_ri_driver.rb
219
270
  test/test_rdoc_ri_paths.rb
220
- test/test_rdoc_ri_store.rb
221
271
  test/test_rdoc_ruby_lex.rb
272
+ test/test_rdoc_ruby_token.rb
222
273
  test/test_rdoc_rubygems_hook.rb
274
+ test/test_rdoc_servlet.rb
223
275
  test/test_rdoc_single_class.rb
224
276
  test/test_rdoc_stats.rb
277
+ test/test_rdoc_store.rb
225
278
  test/test_rdoc_task.rb
226
279
  test/test_rdoc_text.rb
227
280
  test/test_rdoc_token_stream.rb