rdoc 4.0.1 → 4.1.0.preview.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.

Files changed (140) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data.tar.gz.sig +0 -0
  4. data/.autotest +1 -3
  5. data/{DEVELOPERS.rdoc → CONTRIBUTING.rdoc} +28 -3
  6. data/ExampleMarkdown.md +37 -0
  7. data/ExampleRDoc.rdoc +208 -0
  8. data/History.rdoc +81 -0
  9. data/Manifest.txt +11 -2
  10. data/README.rdoc +5 -5
  11. data/Rakefile +34 -4
  12. data/lib/rdoc.rb +4 -3
  13. data/lib/rdoc/any_method.rb +48 -4
  14. data/lib/rdoc/class_module.rb +16 -2
  15. data/lib/rdoc/code_object.rb +85 -24
  16. data/lib/rdoc/comment.rb +0 -3
  17. data/lib/rdoc/constant.rb +9 -1
  18. data/lib/rdoc/context.rb +20 -2
  19. data/lib/rdoc/cross_reference.rb +1 -1
  20. data/lib/rdoc/extend.rb +4 -112
  21. data/lib/rdoc/generator/darkfish.rb +46 -7
  22. data/lib/rdoc/generator/template/darkfish/_footer.rhtml +4 -4
  23. data/lib/rdoc/generator/template/darkfish/_head.rhtml +14 -8
  24. data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +4 -3
  25. data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +3 -3
  26. data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +3 -4
  27. data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +4 -3
  28. data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +3 -4
  29. data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +3 -3
  30. data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +4 -4
  31. data/lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml +9 -5
  32. data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +5 -5
  33. data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +4 -3
  34. data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +12 -7
  35. data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +5 -4
  36. data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +6 -7
  37. data/lib/rdoc/generator/template/darkfish/class.rhtml +36 -41
  38. data/lib/rdoc/generator/template/darkfish/fonts.css +167 -0
  39. data/lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf +0 -0
  40. data/lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf +0 -0
  41. data/lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf +0 -0
  42. data/lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf +0 -0
  43. data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf +0 -0
  44. data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf +0 -0
  45. data/lib/rdoc/generator/template/darkfish/images/add.png +0 -0
  46. data/lib/rdoc/generator/template/darkfish/images/arrow_up.png +0 -0
  47. data/lib/rdoc/generator/template/darkfish/images/delete.png +0 -0
  48. data/lib/rdoc/generator/template/darkfish/images/tag_blue.png +0 -0
  49. data/lib/rdoc/generator/template/darkfish/index.rhtml +11 -7
  50. data/lib/rdoc/generator/template/darkfish/js/darkfish.js +0 -15
  51. data/lib/rdoc/generator/template/darkfish/js/search.js +12 -4
  52. data/lib/rdoc/generator/template/darkfish/page.rhtml +9 -9
  53. data/lib/rdoc/generator/template/darkfish/rdoc.css +226 -241
  54. data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +5 -5
  55. data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +13 -6
  56. data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +17 -14
  57. data/lib/rdoc/include.rb +4 -114
  58. data/lib/rdoc/known_classes.rb +1 -0
  59. data/lib/rdoc/markdown.kpeg +126 -117
  60. data/lib/rdoc/markdown.rb +404 -389
  61. data/lib/rdoc/markdown/literals_1_8.kpeg +1 -1
  62. data/lib/rdoc/markdown/literals_1_8.rb +15 -12
  63. data/lib/rdoc/markdown/literals_1_9.kpeg +1 -1
  64. data/lib/rdoc/markdown/literals_1_9.rb +15 -12
  65. data/lib/rdoc/markup.rb +10 -13
  66. data/lib/rdoc/markup/attribute_manager.rb +3 -2
  67. data/lib/rdoc/markup/formatter.rb +3 -3
  68. data/lib/rdoc/markup/heading.rb +13 -0
  69. data/lib/rdoc/markup/parser.rb +10 -3
  70. data/lib/rdoc/markup/pre_process.rb +1 -1
  71. data/lib/rdoc/markup/to_html.rb +46 -31
  72. data/lib/rdoc/markup/to_html_crossref.rb +3 -0
  73. data/lib/rdoc/markup/to_joined_paragraph.rb +1 -1
  74. data/lib/rdoc/markup/to_markdown.rb +7 -5
  75. data/lib/rdoc/markup/verbatim.rb +1 -1
  76. data/lib/rdoc/method_attr.rb +13 -1
  77. data/lib/rdoc/mixin.rb +120 -0
  78. data/lib/rdoc/normal_class.rb +4 -0
  79. data/lib/rdoc/normal_module.rb +4 -0
  80. data/lib/rdoc/options.rb +42 -8
  81. data/lib/rdoc/parser.rb +4 -2
  82. data/lib/rdoc/parser/c.rb +13 -7
  83. data/lib/rdoc/parser/ruby.rb +683 -480
  84. data/lib/rdoc/rdoc.rb +4 -3
  85. data/lib/rdoc/ri/driver.rb +174 -103
  86. data/lib/rdoc/ri/paths.rb +6 -6
  87. data/lib/rdoc/ruby_lex.rb +125 -102
  88. data/lib/rdoc/ruby_token.rb +41 -40
  89. data/lib/rdoc/servlet.rb +16 -6
  90. data/lib/rdoc/stats.rb +61 -48
  91. data/lib/rdoc/store.rb +5 -3
  92. data/lib/rdoc/test_case.rb +39 -0
  93. data/lib/rdoc/tom_doc.rb +28 -4
  94. data/lib/rdoc/top_level.rb +2 -2
  95. data/test/test_rdoc_any_method.rb +104 -1
  96. data/test/test_rdoc_class_module.rb +9 -15
  97. data/test/test_rdoc_code_object.rb +133 -8
  98. data/test/test_rdoc_context.rb +17 -0
  99. data/test/test_rdoc_context_section.rb +0 -7
  100. data/test/test_rdoc_cross_reference.rb +4 -3
  101. data/test/test_rdoc_generator_darkfish.rb +61 -19
  102. data/test/test_rdoc_generator_json_index.rb +0 -11
  103. data/test/test_rdoc_generator_ri.rb +0 -8
  104. data/test/test_rdoc_markdown.rb +15 -12
  105. data/test/test_rdoc_markdown_test.rb +0 -7
  106. data/test/test_rdoc_markup_attribute_manager.rb +121 -0
  107. data/test/test_rdoc_markup_document.rb +0 -7
  108. data/test/test_rdoc_markup_formatter.rb +29 -3
  109. data/test/test_rdoc_markup_heading.rb +9 -0
  110. data/test/test_rdoc_markup_parser.rb +0 -7
  111. data/test/test_rdoc_markup_pre_process.rb +15 -3
  112. data/test/test_rdoc_markup_raw.rb +0 -7
  113. data/test/test_rdoc_markup_to_html.rb +50 -8
  114. data/test/test_rdoc_markup_to_html_crossref.rb +7 -0
  115. data/test/test_rdoc_markup_to_html_snippet.rb +4 -4
  116. data/test/test_rdoc_markup_to_markdown.rb +6 -0
  117. data/test/test_rdoc_method_attr.rb +8 -0
  118. data/test/test_rdoc_normal_class.rb +5 -0
  119. data/test/test_rdoc_normal_module.rb +5 -0
  120. data/test/test_rdoc_options.rb +61 -22
  121. data/test/test_rdoc_parser.rb +10 -0
  122. data/test/test_rdoc_parser_c.rb +17 -5
  123. data/test/test_rdoc_parser_changelog.rb +0 -7
  124. data/test/test_rdoc_parser_rd.rb +0 -7
  125. data/test/test_rdoc_parser_ruby.rb +305 -28
  126. data/test/test_rdoc_rd_block_parser.rb +0 -8
  127. data/test/test_rdoc_rd_inline_parser.rb +0 -1
  128. data/test/test_rdoc_rdoc.rb +27 -1
  129. data/test/test_rdoc_ri_driver.rb +19 -7
  130. data/test/test_rdoc_ruby_lex.rb +116 -9
  131. data/test/test_rdoc_rubygems_hook.rb +1 -1
  132. data/test/test_rdoc_servlet.rb +44 -6
  133. data/test/test_rdoc_stats.rb +161 -141
  134. data/test/test_rdoc_store.rb +11 -19
  135. data/test/test_rdoc_text.rb +0 -7
  136. data/test/test_rdoc_tom_doc.rb +44 -16
  137. data/test/xref_test_case.rb +2 -0
  138. metadata +28 -27
  139. metadata.gz.sig +0 -0
  140. data/test/test_attribute_manager.rb +0 -120
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 25425cbd40fc0fb6688babd542c72e35da9c1af1
4
- data.tar.gz: ce7517ea48d04c18235cb6b6555167247bc3c380
3
+ metadata.gz: 63a8392d312b7021635d3ca1f8b767fdeb703578
4
+ data.tar.gz: 9d8b4adcb0c60f3157d6b9fb41cdcfc4c8912ef1
5
5
  SHA512:
6
- metadata.gz: 0931f21823f76e532d0a0628a66435a73968b9a4287077f758ed3a3863fd7dc3ef585fcc9d2042166aacf3299693aeb884e5509b924c7eafb362514e22ca3ca0
7
- data.tar.gz: f4edd9434deb4657edf3da618757eb70339eb661288ee513b43f341b63ab372e5b6add88795f3d39f09e5a3cad5d13326c3c4073a5e25474c27c0c78fd74ea46
6
+ metadata.gz: fbe17dd9ed231a22d9252f70d7f057cded0a482d7a2ca1fcd1423e22b2aa74613fb95253df0d362f38af8cd1747e477106cddaf0de85a48074c1e472e9a7d605
7
+ data.tar.gz: ee95d4887bff5955cc1fb3a976833871045dd0e5ece158124ff8cf8428a2e681f3c2cb58896b5e20461d933c55751f3a5d62d8362fb3aca517818201248c76d0
Binary file
data.tar.gz.sig CHANGED
Binary file
data/.autotest CHANGED
@@ -1,13 +1,11 @@
1
1
  require 'autotest/restart'
2
2
 
3
3
  Autotest.add_hook :run_command do |at|
4
- at.unit_diff = 'cat'
5
-
6
4
  system "#{Gem.ruby} -rubygems #{Gem.bin_path 'rake', 'rake'} generate"
7
5
  end
8
6
 
9
7
  Autotest.add_hook :initialize do |at|
10
- at.testlib = 'minitest/autorun'
8
+ at.testlib = ''
11
9
  at.add_exception '.git'
12
10
 
13
11
  def at.path_to_classname s
@@ -10,13 +10,38 @@ classes for each feature.
10
10
  If you think you found a bug, file a ticket on the {issues
11
11
  tracker}[https://github.com/rdoc/rdoc/issues] on github.
12
12
 
13
- To get your bug fixed as fast as possible please include a sample file that
14
- illustrates the problem or link to a repository and include steps to reproduce
15
- the issue. Here are some examples of good issues:
13
+ If your bug involves an error RDoc produced please include a sample file that
14
+ illustrates the problem or link to the repository or gem that is associated
15
+ with the bug.
16
+
17
+ Please include steps to reproduce the issue. Here are some examples of good
18
+ issues:
16
19
 
17
20
  * https://github.com/rdoc/rdoc/issues/55
18
21
  * https://github.com/rdoc/rdoc/issues/61
19
22
 
23
+ == Developer Quick Start
24
+
25
+ RDoc uses hoe for development. To get ready to work on RDoc run:
26
+
27
+ $ gem install hoe
28
+ [...]
29
+ $ rake
30
+ [...]
31
+
32
+ This will install all the necessary dependencies for development with rake,
33
+ generate documentation and run the tests for the first time.
34
+
35
+ If the tests don't pass on the first run check the {Travis CI page for
36
+ RDoc}[https://travis-ci.org/rdoc/rdoc] to see if there are any known failures
37
+ (there shouldn't be).
38
+
39
+ You can now use `rake` and `autotest` to run the tests.
40
+
41
+ Note: the `rake` command must be used first before running any tests, because
42
+ its used to generate various parsers implemented in RDoc. Also `rake clean` is
43
+ helpful to delete these generated files.
44
+
20
45
  == Glossary
21
46
 
22
47
  Here are definitions for some common terms in the RDoc documentation. The
@@ -0,0 +1,37 @@
1
+ This document contains example output to show RDoc styling. This file was
2
+ created from a Markdown file.
3
+
4
+ For the following styles, see ExampleRDoc.rdoc for style examples:
5
+
6
+ * Headings
7
+ * Paragraphs
8
+ * Code blocks (verbatim sections)
9
+ * Definition lists
10
+ * Ordered lists
11
+ * Unordered lists
12
+
13
+ These items all use the same styles as RDoc format files.
14
+
15
+ ## Footnotes
16
+
17
+ Footnotes are rendered at the bottom of the documentation section[^1]. For
18
+ pages this will be at the bottom of the page. For method documentation this
19
+ will be at the end of the current method.
20
+
21
+ [^1]: Here is the footnote content. As you can see it is at the bottom of the
22
+ page.
23
+
24
+ ## Blockquotes
25
+
26
+ Here is how a blockquote looks.
27
+
28
+ > We finished our first sensor sweep of the neutral zone. Now, how the hell do
29
+ > we defeat an enemy that knows us better than we know ourselves? and attack
30
+ > the Romulans.
31
+ >
32
+ > > Sorry, Data. I guess it's better to be lucky than good. The unexpected is
33
+ > > our normal routine. Could someone survive inside a transporter buffer for
34
+ > > 75 years?
35
+
36
+ This text is from [Riker Ipsum](http://rikeripsum.com)
37
+
@@ -0,0 +1,208 @@
1
+ This document contains example output to show RDoc styling. This file was
2
+ created from a RDoc Markup file.
3
+
4
+ == Headings
5
+
6
+ You should not use headings beyond level 3, it is a sign of poor organization
7
+ of your code or documentation. It also becomes difficult for the user to
8
+ figure out what you are attempting to explain to them as they have to track
9
+ the multiple layers of nesting.
10
+
11
+ = Heading level 1
12
+
13
+ Above is a level one heading.
14
+
15
+ These paragraphs are filler that exist so you can see how the heading
16
+ interacts with paragraphs before and after the heading. As you can see each
17
+ different heading has a different amount of margin above and below.
18
+
19
+ This should be sufficient to give you a proper picture of how it will appear in
20
+ your documentation.
21
+
22
+ == Heading level 2
23
+
24
+ Above is a level two heading.
25
+
26
+ These paragraphs are filler that exist so you can see how the heading
27
+ interacts with paragraphs before and after the heading. As you can see each
28
+ different heading has a different amount of margin above and below.
29
+
30
+ This should be sufficient to give you a proper picture of how it will appear in
31
+ your documentation.
32
+
33
+ === Heading level 3
34
+
35
+ Above is a level three heading.
36
+
37
+ These paragraphs are filler that exist so you can see how the heading
38
+ interacts with paragraphs before and after the heading. As you can see each
39
+ different heading has a different amount of margin above and below.
40
+
41
+ This should be sufficient to give you a proper picture of how it will appear in
42
+ your documentation.
43
+
44
+ ==== Heading level 4
45
+
46
+ Above is a level four heading.
47
+
48
+ These paragraphs are filler that exist so you can see how the heading
49
+ interacts with paragraphs before and after the heading. As you can see each
50
+ different heading has a different amount of margin above and below.
51
+
52
+ This should be sufficient to give you a proper picture of how it will appear in
53
+ your documentation.
54
+
55
+ ===== Heading level 5
56
+
57
+ Above is a level five heading.
58
+
59
+ These paragraphs are filler that exist so you can see how the heading
60
+ interacts with paragraphs before and after the heading. As you can see each
61
+ different heading has a different amount of margin above and below.
62
+
63
+ This should be sufficient to give you a proper picture of how it will appear in
64
+ your documentation.
65
+
66
+ ====== Heading level 6
67
+
68
+ Above is a level six heading.
69
+
70
+ These paragraphs are filler that exist so you can see how the heading
71
+ interacts with paragraphs before and after the heading. As you can see each
72
+ different heading has a different amount of margin above and below.
73
+
74
+ This should be sufficient to give you a proper picture of how it will appear in
75
+ your documentation.
76
+
77
+ == Paragraphs
78
+
79
+ This is how a paragraph looks. Since it is difficult to generate good content
80
+ for paragraphs I have chosen to use {Riker Ipsum}[http://rikeripsum.com] for
81
+ nonsense filler content. In the previous sentence you can see how a link is
82
+ formatted.
83
+
84
+ Here is an example of *bold* and _emphasis_ styling. Try not to combine the
85
+ two or use them too often. Here is an example of <code>inline verbatim
86
+ text</code>. That should be enough of a taste of inline markup in paragraphs.
87
+ The Riker Ipsum filler follows:
88
+
89
+ Shields up! Rrrrred alert! Well, I'll say this for him - he's sure of himself.
90
+ and attack the Romulans. Worf, It's better than music. It's jazz. This should
91
+ be interesting. When has justice ever been as simple as a rule book? Flair is
92
+ what marks the difference between artistry and mere competence.
93
+
94
+ Sorry, Data. I think you've let your personal feelings cloud your judgement. We
95
+ finished our first sensor sweep of the neutral zone. Yes, absolutely, I do
96
+ indeed concur, wholeheartedly! Mr. Worf, you do remember how to fire phasers? A
97
+ lot of things can change in twelve years, Admiral. Your shields were failing,
98
+ sir.
99
+
100
+ == Verbatim sections
101
+
102
+ A verbatim section typically contains source code or example output. This is
103
+ how verbatim blocks of code looks:
104
+
105
+ def local responder
106
+ responder.ping do |value|
107
+ return value
108
+ end
109
+ end
110
+
111
+ def ping uri
112
+ @uri = uri
113
+ @remote = DRb::DRbObject.new_with_uri @uri
114
+
115
+ @remote.ping do |value|
116
+ return value
117
+ end
118
+ end
119
+
120
+ This is a paragraph following the verbatim block so you can see how leading and trailing paragraphs interact with it.
121
+
122
+ == Unordered lists
123
+
124
+ Here is an unordered list. As you can see it uses non-numeral markers for each list item:
125
+
126
+ * This is the top-most item in the list.
127
+ * This is a second item in the list.
128
+
129
+ Unlike the first item, this item has more than one paragraph so you can see
130
+ how they interact.
131
+ * This is a third item in the list. Like the item before it, this item has a
132
+ second paragraph.
133
+
134
+ Here is the second paragraph in the list item.
135
+ * A final list item.
136
+
137
+ == Ordered lists
138
+
139
+ Here is an ordered list. As you can see it uses numeral markers for each list
140
+ item:
141
+
142
+ 1. This is the first item in the list.
143
+ 1. This is the second item in the list.
144
+
145
+ Unlike the first item, this item has more than one paragraph so you can see
146
+ how they interact.
147
+ 1. This is the third item in the list. Like the item before it, this item has
148
+ a second paragraph.
149
+
150
+ Here is the second paragraph in the third list item.
151
+ 1. The fourth and final list item.
152
+
153
+ == Definition lists
154
+
155
+ === "Note" list
156
+
157
+ The "note" syntax can be used to create a definition list:
158
+
159
+ note::
160
+ description
161
+
162
+ Here is such a definition list:
163
+
164
+ cat::
165
+ A cat is a small mammal that is commonly kept as a pet.
166
+
167
+ dog::
168
+ A dog is a mammal that is also kept as a pet. A dog may range in size from
169
+ smaller than a cat to larger than a human.
170
+
171
+ Typically dogs are easier to train to respond to commands than cats.
172
+
173
+ rabbit::
174
+ Rabbits are also mammals, but are infrequently kept as pets. Most rabbits
175
+ are wild.
176
+
177
+ === "Label" list
178
+
179
+ The "label" syntax can be used to create a definition list:
180
+
181
+ [label]
182
+ description
183
+
184
+ Here is such a definition list:
185
+
186
+ [cat]
187
+ A cat is a small mammal that is commonly kept as a pet.
188
+
189
+ [dog]
190
+ A dog is a mammal that is also kept as a pet. A dog may range in size from
191
+ smaller than a cat to larger than a human.
192
+
193
+ Typically dogs are easier to train to respond to commands than cats.
194
+
195
+ [rabbit]
196
+ Rabbits are also mammals, but are infrequently kept as pets. Most rabbits
197
+ are wild.
198
+
199
+ == Rule
200
+
201
+ A rule is a horizontal divider between two paragraphs. Following this
202
+ paragraph is a rule.
203
+
204
+ ---
205
+
206
+ In historic versions of RDoc you could control the height of the rule in HTML
207
+ output. This is no longer true as HTML 5 does not support this.
208
+
@@ -1,3 +1,84 @@
1
+ === 4.1.0.preview.3 / 2012-12-02
2
+
3
+ * Minor enhancements
4
+ * RDoc can now link to [], []=, << and >> methods. Pull request #202 by
5
+ Jeremy Evans, Bug # 191 by by Zachary Scott.
6
+ * Added RDoc::Options#output_decoration which controls header labels for
7
+ HTML output. Pull Request #199 by Zachary Scott.
8
+ * Added --template-stylesheets options to RDoc to allow specification of
9
+ alternate stylesheets. Pull request #205 by Zachary Scott.
10
+ * Improved performance of the Markdown and RD parsers. Pull request #217 by
11
+ Ryan Davis.
12
+ * <code>rdoc -v</code> now prints the version instead of enabling verbose
13
+ mode. Pull request #201 by Lee Jarvis.
14
+ * Running <code>rake newb</code> now automatically installs development
15
+ dependencies if the parser files haven't been built. Pull request #235 by
16
+ Kouhei Sutou.
17
+ * Moved old DEVELOPERS file to CONTRIBUTING to match github conventions.
18
+ * TomDoc output now has a "Returns" heading. Issue #234 by Brian Henderson
19
+ * Metaprogrammed methods can now use the :args: directive in addition to the
20
+ :call-seq: durective. Issue #236 by Mike Moore.
21
+ * Sections can be linked to using "@" like labels. If a section and a label
22
+ have the same name the section will be preferred. Issue #233 by Brian
23
+ Henderson.
24
+ * Files that come with a template are hard-linked to save space. Issue #186
25
+ by Vít Ondruch.
26
+
27
+ * Bug fixes
28
+ * Restored behavior of --no-pager alias -T. Pull request #223 by ruafozy.
29
+ * Fixed extra whitespace output in the rdoc coverage report. Bug #210 by
30
+ Ryan Davis.
31
+ * RDoc no longer documents its timestamp file when run on an empty
32
+ directory. Bug #212 by Rainer Keller
33
+ * HTML escape method names in the table of contents. Bug #219 by Akinori
34
+ MUSHA.
35
+ * Character literals <code>?h</code> now create a new token type to prevent
36
+ loss of the "?" in output. Bug #220 by Vipul A M.
37
+ * When looking up a method that does not exist, ri escapes the regular
38
+ expression for fallback searches. Bug #227 by Aaron Patterson.
39
+ * The ri generator now writes the class method data after +module_function+.
40
+ Bug #222 by Zachary Scott, Ruby bug #8225 by David Unric.
41
+ * ri now handles missing ri data files. Bug #222 by Zachary Scott, Ruby bug
42
+ #8225 by David Unric.
43
+ * Added TomDoc to the supported markup formats section of rdoc --help.
44
+ Bug #214 by Ryan Davis.
45
+ * Fixed documented? check for classes which indicated incorrect 100%
46
+ coverage. Bug #211 by Ryan Davis.
47
+ * RDoc ignores constants discovered in passing in class and method bodies.
48
+ Bug #209 by Ryan Davis.
49
+ * An :enddoc: at the top level stops all further parsing. Bug #213 by Ryan
50
+ Davis.
51
+ * Improved handling of multiline call-seq. Bug #207 by Erik Hollensbe.
52
+ * Fixed text that is missing whitespace for TomDoc. Bug #248 by Noel Cower.
53
+ * The RDoc methods now store the method they are aliased to. Bug #206 by
54
+ Jeremy Stephens.
55
+ * Fixed parsing of multiple methods on the same line. Bug #221 by derula.
56
+ * Fixed missing support for images in markdown. Bug #241, pull request #242
57
+ by Zachary Scott.
58
+ * The markdown image fix also added support for images via an rdoc-image:
59
+ scheme. See RDoc::Markup@Links for details. Issue #93 by Tim Pease.
60
+ * Ignore empty call-seq for methods. Improved deduplication of C methods
61
+ sharing the same C function. This allows the method heading to show
62
+ up correctly for String#== and #===. Bug #244 by Neurogami.
63
+ * RDoc no longer adds "http://" to urls without a scheme. Bug #208 by
64
+ Zachary Scott.
65
+ * Improved the error message in the RDoc server when ri data is missing.
66
+ Bug #243, Pull Request #249 by Tadas Tamošauskas.
67
+ * Support ruby 2.0 hash syntax for keywords. Bug #256 by diogocsc.
68
+ * Prevent \\<tag> from escaping the tag in RDoc markup. (\<tag> still
69
+ escapes the tag.) Bug #251 by Pablo Bianciotto.
70
+ * Fixed lexing of escaped characters in strings which could cause
71
+ duplication of the final characters in source code view. Bug #252 by Mike
72
+ Stok.
73
+ * Disallow invalid tab widths for -w option. Bug reported by Charles
74
+ Hixson.
75
+ * rb_file_const() now adds constants to File::Constants when used outside
76
+ file.c. Fixes missing File::Constants::FNM_* constants in ruby.
77
+ * Fixed handling of :markup: when the file parser is unknown. Issue #262 by
78
+ Brian Henderson, pull request #269 by Rein Henrichs.
79
+ * Regexp options are no longer stripped in HTML output. Bug #259 by Zachary
80
+ Scott, Pull request #265 by Rein Henrichs
81
+
1
82
  === 4.0.1 / 2013-03-27
2
83
 
3
84
  * Bug fixes
@@ -1,7 +1,9 @@
1
1
  .autotest
2
2
  .document
3
+ CONTRIBUTING.rdoc
3
4
  CVE-2013-0256.rdoc
4
- DEVELOPERS.rdoc
5
+ ExampleMarkdown.md
6
+ ExampleRDoc.rdoc
5
7
  History.rdoc
6
8
  LEGAL.rdoc
7
9
  LICENSE.rdoc
@@ -52,6 +54,13 @@ lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
52
54
  lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
53
55
  lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml
54
56
  lib/rdoc/generator/template/darkfish/class.rhtml
57
+ lib/rdoc/generator/template/darkfish/fonts.css
58
+ lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf
59
+ lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf
60
+ lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf
61
+ lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf
62
+ lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf
63
+ lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf
55
64
  lib/rdoc/generator/template/darkfish/images/add.png
56
65
  lib/rdoc/generator/template/darkfish/images/arrow_up.png
57
66
  lib/rdoc/generator/template/darkfish/images/brick.png
@@ -138,6 +147,7 @@ lib/rdoc/markup/to_tt_only.rb
138
147
  lib/rdoc/markup/verbatim.rb
139
148
  lib/rdoc/meta_method.rb
140
149
  lib/rdoc/method_attr.rb
150
+ lib/rdoc/mixin.rb
141
151
  lib/rdoc/normal_class.rb
142
152
  lib/rdoc/normal_module.rb
143
153
  lib/rdoc/options.rb
@@ -208,7 +218,6 @@ test/test.ja.largedoc
208
218
  test/test.ja.rdoc
209
219
  test/test.ja.txt
210
220
  test/test.txt
211
- test/test_attribute_manager.rb
212
221
  test/test_rdoc_alias.rb
213
222
  test/test_rdoc_any_method.rb
214
223
  test/test_rdoc_attr.rb
@@ -3,7 +3,7 @@
3
3
  home :: https://github.com/rdoc/rdoc
4
4
  rdoc :: http://docs.seattlerb.org/rdoc
5
5
  bugs :: https://github.com/rdoc/rdoc/issues
6
- code quality :: {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/rdoc/rdoc]
6
+ code quality :: {<img src="https://codeclimate.com/badge.png" alt="code climate">}[https://codeclimate.com/github/rdoc/rdoc]
7
7
 
8
8
  == Description
9
9
 
@@ -108,10 +108,10 @@ names in the documentation coverage report.
108
108
 
109
109
  == Bugs
110
110
 
111
- See DEVELOPERS@Bugs for information on filing a bug report. It's OK to file a
112
- bug report for anything you're having a problem with. If you can't figure out
113
- how to make RDoc produce the output you like that is probably a documentation
114
- bug.
111
+ See CONTRIBUTING@Bugs for information on filing a bug report. It's OK to file
112
+ a bug report for anything you're having a problem with. If you can't figure
113
+ out how to make RDoc produce the output you like that is probably a
114
+ documentation bug.
115
115
 
116
116
  == License
117
117