Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 1623 lines (1435 sloc) 76.172 kb
811c86f @hsbt Fixed infinite loop with CR #339
hsbt authored
1 === 4.2.1
2
3 * Bug fixes
4 * Fixed infinite loop with CR #339
5
dc1b264 @drbrain Update release version and date
drbrain authored
6 === 4.2.0 / 2014-12-06
5bbc509 @drbrain Allow any macro before C method implementation
drbrain authored
7
d079152 @drbrain Add #254 to History
drbrain authored
8 * Major enhancements
9 * RDoc can now produce translation files for use with gettext. See
10 RDoc::Generator::POT for a workflow for creating translations of your
11 documentation. Pull request #254 by Kouhei Sutou.
12
5bbc509 @drbrain Allow any macro before C method implementation
drbrain authored
13 * Minor enhancements
14 * RDoc now allows any single-word macro before a C method implementation.
15 Issue #722 by Hanmac.
4d87513 @drbrain Add #276 to History
drbrain authored
16 * Now :all is a synonym for :private for RDoc::Options#visibility= to match
17 the --all command line option. Pull request #276 by Zachary Scott.
8d0e38c @drbrain Add #285 to History
drbrain authored
18 * Running rake for the first time now installs racc. Pull request #285 by
19 Kouhei Sutou.
da046de @zzak Add #300 to History
zzak authored
20 * Added <code>-h</code> flag to also display help. Issue #300 by Ryan Davis
074a6e8 @drbrain Fix bullet in History.
drbrain authored
21 * search_index.js is now loaded asynchronously for improved performance.
c007cd9 @drbrain Add #319, #322 to History
drbrain authored
22 * Allow +X::Y+ as typewriter text. Issue #319, pull request #322 by Jeremy
23 Evans.
1a46d96 @drbrain Add #332 to History
drbrain authored
24 * Added RDoc::RI::Task for building ri data easily through rake. Pull
25 request #332 by Zachary Scott.
e4eac00 @drbrain Add #334 to History
drbrain authored
26 * A gzipped search index is generated for servers configured to use
27 precompressed files. Pull request #334 by Zachary Scott.
dcb8930 @drbrain Add #335 to History
drbrain authored
28 * CSS files now live under /css relative to the document root. Pull request
29 #335 by Zachary Scott.
7b042c7 @drbrain Add #333 to History
drbrain authored
30 * Improved detection of valid ruby in verbatim sections. Pull request #333
31 by Jeremy Evans.
5bbc509 @drbrain Allow any macro before C method implementation
drbrain authored
32
8155abb @drbrain Correctly transcode ASCII-incompatible files
drbrain authored
33 * Bug fixes
ef88d16 @drbrain Add #330 to History
drbrain authored
34 * Fixed HTML labels for cross-browser compatibility. This breaks existing
35 links but enables cross-browser compatibility. Pull request #330 by Jens
36 Wille.
8155abb @drbrain Correctly transcode ASCII-incompatible files
drbrain authored
37 * RDoc handles ASCII-incompatible encodings now. An encoding hint may need
38 to be added to the file for RDoc to produce correct output, though.
39 Issue #288 by Manuel Meurer.
a544249 @drbrain Fix hovering headings causing page motion
drbrain authored
40 * Fixed height recalculation issues when headings are hovered. Issue #289
41 by Dietmar H. Büto.
fec5508 @drbrain Add #306, #305 to History
drbrain authored
42 * RDoc now ignores its own output directories. Pull Request #306 by
43 Hsing-Hui Hsu, bug #305 by Ryan Davis.
b7980a8 @drbrain Add #307, #308 to History
drbrain authored
44 * Fixed RDoc::Task no longer uselessly builds documentation when generating
45 non-HTML output. Bug #307 by Christina Thompson, pull request #308 by
46 Hsing-Hui Hsu
6839dda @drbrain Add font license summary to LEGAL.rdoc
drbrain authored
47 * Added pointer to font copyright and license information to LEGAL.rdoc.
48 Issue #290 by Christian Hofstaedtler.
379be23 @drbrain Add #287, #284 to History
drbrain authored
49 * Fixed RDoc::Context#<=> for ruby trunk. Issue #284 by Hanmac, pull
50 request #287 by Aaron Patterson
d5ab090 @drbrain Add #286 to History
drbrain authored
51 * Tests no longer create directories inside test/. Pull request #286 by
52 Kouhei Sutou.
0b2c725 @drbrain Add #292 to History
drbrain authored
53 * Fixed documentation example in RDoc::Markup. Pull request #292 by Gregory
54 Brown.
e609210 @zzak Add #297 to History
zzak authored
55 * Applied typo fix to RDoc::Markup. Pull request #297 by @montanalow
ceb7ae0 @drbrain Add #324 to History
drbrain authored
56 * Fixed pretty_print for RDoc::MethodAttr with an alias. Pull request #324
57 by Hsing-Hui Hsu.
84b8a15 @drbrain Add #315, #323 to History
drbrain authored
58 * Fixed lexing of %w"". Issue #315 by Thierry Lambert, pull request #323 by
59 Jeremy Evans.
21b241a @drbrain Add #318 to History
drbrain authored
60 * RDoc::TokenStream now removes nil tokens. Pull request #318 by Calle
61 Erlandsson.
e48c84d @zzak Add History for #328
zzak authored
62 * Fixed footer links to rubyforge and darkfish. Pull request #328 by
63 @blackwinter
55e3c74 @zzak Add #329 to History
zzak authored
64 * Fixed page-top link. Pull request #329 by @blackwinter
c102881 @drbrain Ignore gem load failure during test startup
drbrain authored
65 * Minitest gem activation failures are now ignored during test startup.
66 Issue #313 by Vít Ondruch.
440dba7 @drbrain Add #311 to History
drbrain authored
67 * Fixed error when generating documentation from singleton classes. Issue
68 #311 by Vít Ondruch.
771a445 @drbrain Add #321 to History
drbrain authored
69 * Splat and keyword params can now be detected for documentation
70 completeness. Issue #321 Tom Kadwill.
56fe6eb @drbrain Mark standalone anchors in markdown as raw
drbrain authored
71 * Standalone anchors in markdown documents are no longer escaped. Issue
72 #312 by Scott Thompson.
58eee42 @drbrain Add #327 to History
drbrain authored
73 * Fixed RegExp matching stack overflow on Ruby 1.8.7. Issue #327 by sshao.
8155abb @drbrain Correctly transcode ASCII-incompatible files
drbrain authored
74
8b8d8e0 @zzak Add 8f01e01f0fc9f07700e83aa3641ee7b67afc8913 to History
zzak authored
75 === 4.1.2 / 2014-09-05
76
77 * Bug fixes
78 * Updated vendored jQuery to 1.6.4. Bug ruby/ruby#711 by @neuralme
79
1f7cbff @drbrain Update release date
drbrain authored
80 === 4.1.1 / 2014-01-09
0188265 @drbrain Add #282 to History
drbrain authored
81
82 * Bug fixes
f5a22e8 @drbrain Add #281 to History
drbrain authored
83 * Fixed reporting of undocumented method parameters when including when
84 yield and &block are present. Pull request #281 by Victor Bilyk.
9d0281d @drbrain Fix handling of mixed types of first comment
drbrain authored
85 * Fixed merging of rd-style and hash-style comments at the top of a file.
86 Bug #266 by Zachary Scott.
17dd1fc @drbrain Fix Document-attr in the C parser
drbrain authored
87 * Fixed Document-attr in the C parser. Bug #271 by Hanmac.
0188265 @drbrain Add #282 to History
drbrain authored
88 * Removed duplicated condition in superclass fixup. Pull request #282 by
89 Benoit Daloze.
90
06b3f6a @drbrain Set release date and version
drbrain authored
91 === 4.1.0 / 2013-12-26
cec788e @drbrain Update history for #199
drbrain authored
92
62e256b @drbrain Add Techvision's accessibility review to History
drbrain authored
93 * Notable changes
94 * Improved accessibility of HTML output. Accessibility review was provided
95 by:
96
97 Techvision – http://www.techvision.net.in
98
99 The accessibility consultants in Pune, India
100
101 * The look of RDoc has been updated.
102
cec788e @drbrain Update history for #199
drbrain authored
103 * Minor enhancements
c838b02 @drbrain Update history for #202, #191
drbrain authored
104 * RDoc can now link to [], []=, << and >> methods. Pull request #202 by
105 Jeremy Evans, Bug # 191 by by Zachary Scott.
cec788e @drbrain Update history for #199
drbrain authored
106 * Added RDoc::Options#output_decoration which controls header labels for
b9d85b2 @drbrain Remove extra whitespace in HTML header after #205
drbrain authored
107 HTML output. Pull Request #199 by Zachary Scott.
108 * Added --template-stylesheets options to RDoc to allow specification of
109 alternate stylesheets. Pull request #205 by Zachary Scott.
7e6a733 @drbrain Fix footnotes in the markdown parser after #217
drbrain authored
110 * Improved performance of the Markdown and RD parsers. Pull request #217 by
111 Ryan Davis.
5912e2b @drbrain Update history for #201
drbrain authored
112 * <code>rdoc -v</code> now prints the version instead of enabling verbose
113 mode. Pull request #201 by Lee Jarvis.
21836ab @drbrain Update history for #235
drbrain authored
114 * Running <code>rake newb</code> now automatically installs development
115 dependencies if the parser files haven't been built. Pull request #235 by
116 Kouhei Sutou.
796120d @drbrain Rename DEVELOPERS to CONTRIBUTING
drbrain authored
117 * Moved old DEVELOPERS file to CONTRIBUTING to match github conventions.
45c5047 @drbrain Add "Returns" header for TomDoc output
drbrain authored
118 * TomDoc output now has a "Returns" heading. Issue #234 by Brian Henderson
8cac833 @drbrain Allow :args: with metaprogrammed methods
drbrain authored
119 * Metaprogrammed methods can now use the :args: directive in addition to the
d830669 @zzak Typo in History: s/durective/directive
zzak authored
120 :call-seq: directive. Issue #236 by Mike Moore.
1e9fc63 @drbrain Allow linking to a section using "@"
drbrain authored
121 * Sections can be linked to using "@" like labels. If a section and a label
122 have the same name the section will be preferred. Issue #233 by Brian
123 Henderson.
adb9c72 @drbrain Update history for #186
drbrain authored
124 * Files that come with a template are hard-linked to save space. Issue #186
125 by Vít Ondruch.
cec788e @drbrain Update history for #199
drbrain authored
126
de5cc3e @drbrain Update history for #223
drbrain authored
127 * Bug fixes
8bcb266 @zzak Applied typo fixes by @dvsuresh from ruby/ruby@2c5dcdf
zzak authored
128 * Applied typo fixes by @dvsuresh from ruby/ruby@2c5dcdf
de5cc3e @drbrain Update history for #223
drbrain authored
129 * Restored behavior of --no-pager alias -T. Pull request #223 by ruafozy.
f286efd @drbrain Convert coverage report to a Document
drbrain authored
130 * Fixed extra whitespace output in the rdoc coverage report. Bug #210 by
131 Ryan Davis.
d666470 @drbrain Document nothing in an empty directory
drbrain authored
132 * RDoc no longer documents its timestamp file when run on an empty
133 directory. Bug #212 by Rainer Keller
7110cb3 @drbrain HTML Escape method names in the table of contents
drbrain authored
134 * HTML escape method names in the table of contents. Bug #219 by Akinori
135 MUSHA.
b41e8f0 @drbrain Use a separate token type for character literals
drbrain authored
136 * Character literals <code>?h</code> now create a new token type to prevent
137 loss of the "?" in output. Bug #220 by Vipul A M.
02f40fa @drbrain Escape string when performing ri fallback lookups
drbrain authored
138 * When looking up a method that does not exist, ri escapes the regular
139 expression for fallback searches. Bug #227 by Aaron Patterson.
b84f38e @drbrain Reset full_name after duping a CodeObject
drbrain authored
140 * The ri generator now writes the class method data after +module_function+.
141 Bug #222 by Zachary Scott, Ruby bug #8225 by David Unric.
f72b586 @drbrain Handle missing files in ri
drbrain authored
142 * ri now handles missing ri data files. Bug #222 by Zachary Scott, Ruby bug
143 #8225 by David Unric.
b170bf8 @drbrain Added TomDoc to the banner list of markup formats.
drbrain authored
144 * Added TomDoc to the supported markup formats section of rdoc --help.
145 Bug #214 by Ryan Davis.
be84349 @drbrain Fix ClassModule#documented? to check all comments
drbrain authored
146 * Fixed documented? check for classes which indicated incorrect 100%
147 coverage. Bug #211 by Ryan Davis.
1682ab3 @drbrain Terminate parsing for :enddoc: at top-level
drbrain authored
148 * An :enddoc: at the top level stops all further parsing. Bug #213 by Ryan
149 Davis.
1bd47bf @drbrain Improved handling of multiline call-seq
drbrain authored
150 * Improved handling of multiline call-seq. Bug #207 by Erik Hollensbe.
cc9ac43 @drbrain Add history item for #248
drbrain authored
151 * Fixed text that is missing whitespace for TomDoc. Bug #248 by Noel Cower.
0bf0ddc @drbrain Store a method's is_alias_for in Marshal
drbrain authored
152 * The RDoc methods now store the method they are aliased to. Bug #206 by
153 Jeremy Stephens.
c5a2039 @drbrain Fix parsing of multiple methods on the same line
drbrain authored
154 * Fixed parsing of multiple methods on the same line. Bug #221 by derula.
1485a14 @drbrain Move bug fixes to the correct release
drbrain authored
155 * Fixed missing support for images in markdown. Bug #241, pull request #242
156 by Zachary Scott.
41976f0 @drbrain Note that image links are now supported
drbrain authored
157 * The markdown image fix also added support for images via an rdoc-image:
158 scheme. See RDoc::Markup@Links for details. Issue #93 by Tim Pease.
1485a14 @drbrain Move bug fixes to the correct release
drbrain authored
159 * Ignore empty call-seq for methods. Improved deduplication of C methods
160 sharing the same C function. This allows the method heading to show
161 up correctly for String#== and #===. Bug #244 by Neurogami.
162 * RDoc no longer adds "http://" to urls without a scheme. Bug #208 by
163 Zachary Scott.
164 * Improved the error message in the RDoc server when ri data is missing.
165 Bug #243, Pull Request #249 by Tadas Tamošauskas.
df0a31e @drbrain Support ruby 2.0 hash syntax for keywords
drbrain authored
166 * Support ruby 2.0 hash syntax for keywords. Bug #256 by diogocsc.
c71e7bb @drbrain Prevent \\<tag> from escaping the tag
drbrain authored
167 * Prevent \\<tag> from escaping the tag in RDoc markup. (\<tag> still
168 escapes the tag.) Bug #251 by Pablo Bianciotto.
5ad5df2 @drbrain Fixed lexing of escaped characters in strings
drbrain authored
169 * Fixed lexing of escaped characters in strings which could cause
170 duplication of the final characters in source code view. Bug #252 by Mike
171 Stok.
bb45ec8 @drbrain Disallow invalid tab widths for -w
drbrain authored
172 * Disallow invalid tab widths for -w option. Bug reported by Charles
173 Hixson.
dcfcc54 @drbrain Fix rb_file_const() when used outside file.c
drbrain authored
174 * rb_file_const() now adds constants to File::Constants when used outside
175 file.c. Fixes missing File::Constants::FNM_* constants in ruby.
c442a87 @drbrain Add #262 and #269 to history
drbrain authored
176 * Fixed handling of :markup: when the file parser is unknown. Issue #262 by
177 Brian Henderson, pull request #269 by Rein Henrichs.
178 * Regexp options are no longer stripped in HTML output. Bug #259 by Zachary
179 Scott, Pull request #265 by Rein Henrichs
de5cc3e @drbrain Update history for #223
drbrain authored
180
9fb78b8 @drbrain Set release date
drbrain authored
181 === 4.0.1 / 2013-03-27
3b9338e @drbrain Update History for previous commit
drbrain authored
182
7cfb97a @drbrain Moved doc install complete message from RubyGems
drbrain authored
183 * Bug fixes
ff1db62 @zzak update History.rdoc change log from 437dc75
zzak authored
184 * RDoc::Options parser should rescue from OptionParser::ParseError.
3b9338e @drbrain Update History for previous commit
drbrain authored
185 * Updated example of RDoc::Options to include reopening RDoc::Options.
186 Pointed out by Michael Granger
7cfb97a @drbrain Moved doc install complete message from RubyGems
drbrain authored
187 * Moved RubyGems documentation installed message into RDoc hook. For
188 RubyGems bug #469 by Jeff Sandberg
f4f5b94 @drbrain Raise an Error on a unterminated heredoc
drbrain authored
189 * An Error is now raised when a heredoc is not terminated. Fixes exceptions
190 when processing comment blocks. Reported by darix
3d8dc68 @drbrain Update History for #192
drbrain authored
191 * rdoc --quiet --no-ignore-invalid now exits for invalid options. Pull
192 request #192 by Jeremy Evans
65c9fb0 @drbrain Update history for #184
drbrain authored
193 * RDoc::Parser::C no longer ignores a (METHOD) cast in rb_define_method.
194 Pull request #184 by Carlos Agarie
72ff004 @drbrain Update history for #173
drbrain authored
195 * RDoc::Servlet no longer ignores extra directories from -d. Pull request
196 #173 by Thomas Leitner
729b62a @drbrain Fixed `rdoc --ri-site`
drbrain authored
197 * Fixed `rdoc --ri-site`. Bug #193 by Michal Papis.
ceb81dd @drbrain Do not attempt to read binary files
drbrain authored
198 * RDoc no longer attempts to parse binary files. Bug #189 by postmodern,
199 Bug #190 by Christoffer Lervåg, Bug #195 by Aaron Patterson
71da58e @drbrain RDoc --pipe with markdown output is spec-compliant
drbrain authored
200 * `rdoc --pipe` output now contains <code></code> for markdown compliance.
6b194cc @drbrain Remove modeline before creating file parser
drbrain authored
201 * RDoc no longer leaves emacs-style modelines in .txt, .md or .rd files.
202 Bug #178 by Zachary Scott
17266ad @drbrain Output proper HTML markup for markdown input
drbrain authored
203 * RDoc no longer puts raw markup in HTML output for markdown input. Bug
204 #204 by Erik Hollensbe
6c532d2 @drbrain Remove nodoc items when storing a class or module
drbrain authored
205 * Code objects with nodoc are no longer included in the ri store. Bug #177
206 by Thomas Leitner.
78d5754 @drbrain Create ToHtmlSnippet correctly in Text#snippet
drbrain authored
207 * Text#snippet now creates a RDoc::Markup::ToHtmlSnippet correctly.
b792230 @drbrain Separate C call-seq for "copied" methods
drbrain authored
208 * The C parser now de-duplicates call-seq if the same C function is used for
209 multiple method names. Bug #203 by Pete Higgins
3b9338e @drbrain Update History for previous commit
drbrain authored
210
de29e8d @drbrain Update for 4.0.0 release
drbrain authored
211 === 4.0.0 / 2013-02-24
c434e9c @drbrain Updated History.txt for 4.0.0.preview2 release
drbrain authored
212
213 RDoc 4.0 includes several new features and several breaking changes. The
214 changes should not affect users of `rdoc` or `ri`.
215
216 Notable feature additions are markdown support and an WEBrick servlet that can
217 serve HTML from an ri store. (This means that RubyGems 2.0+ no longer needs
218 to build HTML documentation when installing gems.)
e0c0722 @drbrain The default output encoding is now UTF-8. Fixes #106
drbrain authored
219
1d22e8c @drbrain Comprehensive release notes for 4.0.0.rc.2.1
drbrain authored
220 Changes since RDoc 3.12.1:
221
222 * Breaking changes
223 * The default output encoding for RDoc is now UTF-8. Previously RDoc used
224 the default external encoding which was determined from your locale.
225 Issue #106 by Justin Baker.
226 * RDoc::RI::Store is now RDoc::Store so ri data generated by RDoc 4 cannot
227 be read by earlier versions of RDoc. RDoc::RI::Store exists as an alias
228 of RDoc::Store so ri data from older versions can still be read.
229 RDoc::RI::Store will be removed in RDoc 5.
230
231 Tests that create RDoc::CodeObjects on the fly without wiring them into
232 the documentation tree (did not use add_class, add_method, etc.) must be
233 updated to use these methods. The documentation tree automatically
234 attaches them to the store instance which allows lookups to work
235 correctly. Additionally, a new method RDoc::Store#add_file must be used
236 instead of RDoc::TopLevel.new. The latter will not be attached to the
237 documentation tree.
238 * RDoc generators must accept an RDoc::Store and an RDoc::Options in
239 initialize. RDoc no longer passes an Array of RDoc::TopLevel objects to
240 #generate. Use RDoc::Store#all_files instead.
241 * Some markup formatters (RDoc::Markup::To*) now accept an RDoc::Options
242 instance as the first argument. Notably, the base class Formatter and
243 ToHtml*. (This is not universal due to the difficult at accessing the
244 user's options instance deep inside RDoc. A future major release may
245 remedy this.)
246 * Added new markup nodes and specials that RDoc::Markup::Formatter
247 subclasses must handle. If you're using RDoc::Markup::FormatterTestCase
248 the new methods you need to add should be readily apparent.
249 * Removed RDoc::RI::Paths::SYSDIR and ::SITEDIR. These were hidden
250 constants so no breakage is expected. Use RDoc::RI::Paths::system_dir
251 and ::site_dir instead.
252 * RDoc::RI::Store#modules has been renamed to RDoc::Store#module_names
253 to avoid confusion with RDoc::Store#all_modules imported from
254 RDoc::TopLevel.
255 * RDoc::RDocError has been removed. It was deprecated throughout RDoc 3.
256 * ri -f html is no longer supported.
257 * Comment definitions in C comments are now only discovered from the first
258 line. A colon on a subsequent line won't trigger definition extraction.
259 Issue #103, see also
260 http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/42942
261 * Fixed :stopdoc: for class A::B where A has not been seen. Issue #95 by
262 Ryan Davis
263 * RDoc::ClassModule#each_ancestor no longer yields itself if there is
264 circular ancestry
265
266 * Major enhancements
267 * ri can now show pages (README, etc.)
268
269 ri rdoc:README
270
271 Will show the README for the latest version of RDoc. You can specify
272 exact gem versions such as "rdoc-4.0:README" or view pages from the
273 standard library documentation with "ruby:README".
274
275 RDoc 3 did not save pages in ri data so you will need to regenerate
276 documentation from your gems to use this feature.
277 * Added Markdown as a supported format. The markdown format can be set on a
278 per-file or per-comment basis with the +:markdown:+ directive like the rd
279 and tomdoc formats and on a per-project basis with
280 <tt>rdoc --markup markdown --write-options</tt>
281 * Removed global state from RDoc. RDoc::Store holds the documentation tree
282 and connects the driver to the parsers and generator. This also allows
283 documentation parsing and generation for multiple instances, but the rdoc
284 command-line tool does not support this.
285
286 Due to this change RDoc::RDoc.current and RDoc::RDoc.reset no longer
287 exist.
288
289 * Minor enhancements
290 * Added --page-dir option to give pretty names for a FAQ, guides, or other
291 documentation you write that is not stored in the project root. For
292 example, with the following layout:
293
294 README.txt
295 guides/syntax.txt
296 guides/conversion.txt
297
298 Running `rdoc --page-dir guides` will make the files in "guides" appear to
299 be at the top level of the project. This means they will appear to exist
300 at the top level in HTML output and you can access them with
301 `ri your_gem:syntax` and `ri your_gem:conversion`.
302 * Added --root for building documentation from outside the source dir.
303 * Added current heading and page-top links to HTML headings.
304 * Added a ChangeLog parser. It automatically parses files that begin
305 with 'ChangeLog'
306 * Added a table of contents to the sidebar.
307 * RDoc markup format merges adjacent labels in a label or note list into a
308 single definition list item for output.
309 * RDoc now tracks use of extend. Pull request #118 by Michael Granger.
310 * RDoc now tracks methods that use super. Pull request #116 by Erik
311 Hollensbe.
312 * Added methods ::system_dir, ::site_dir, ::home_dir and ::gem_dir to fetch
313 the components of RDoc::RI::Paths.path individually.
314 * Added support for rb_file_const.
315 * RDoc now processes files in sorted order. Issue #71 by Vít Ondruch
316 * RDoc now warns with --verbose when methods are duplicated. Issue #71 by
317 Vít Ondruch
318 * ri will display documentation for all methods in a class if -a is given.
319 Issue #57 by casper
320 * The RDoc coverage report will report line information for attributes,
321 constants and methods missing documentation. Issue #121 by Zachary Scott
322 * RDoc now reports a warning for files that are unreadable due to
323 permissions problems.
324 * RDoc controls documentation generation for RubyGems 2.0+
325
326 * Bug fixes
327 * Fixed parsing of multibyte files with incomplete characters at byte 1024.
328 Ruby bug #6393 by nobu, patch by Nobuyoshi Nakada and Yui NARUSE.
329 * Fixed rdoc -E. Ruby Bug #6392 and (modified) patch by Nobuyoshi Nakada
330 * Added link handling to Markdown output. Bug #160 by burningTyger.
331 * Fixed HEREDOC output for the limited case of a heredoc followed by a line
332 end. When a HEREDOC is not followed by a line end RDoc is not currently
333 smart enough to restore the source correctly. Bug #162 by Zachary Scott.
334 * Fixed parsing of executables with shebang and encoding comments. Bug #161
335 by Marcus Stollsteimer
336 * RDoc now ignores methods defined on constants instead of creating a fake
337 module. Bug #163 by Zachary Scott.
338 * Fixed ChangeLog parsing for FFI gem. Bug #165 by Zachary Scott.
339 * RDoc now links \#=== methods. Bug #164 by Zachary Scott.
340 * Allow [] following argument names for TomDoc. Bug #167 by Ellis Berner.
341 * Fixed the RDoc servlet for home and site directories. Bug #170 by Thomas
342 Leitner.
343 * Fixed references to methods in the RDoc servlet. Bug #171 by Thomas
344 Leitner.
345 * Fixed debug message when generating the darkfish root page. Pull Request
346 #174 by Thomas Leitner.
347 * Fixed deletion of attribute ri data when a class was loaded then saved.
348 Issue #171 by Thomas Leitner.
349 * Fully qualified names for constants declared from the top level are now
350 attached to their class or module properly.
351 * Fixed table of contents display in HTML output for classes and modules.
352 * Incremental ri builds of C files now work. C variable names from previous
353 runs are now saved between runs.
354 * A word that is directly followed by a multi-word tidy link label no longer
355 disappears. (Like <code>text{link}[http://example]</code>)
356 * Fixed legacy template support. Pull Request #107 by Justin Baker.
357 * An HTML class in a verbatim section no longer triggers ruby parsing.
358 Issue #92 by Vijay Dev
359 * Improved documentation for setting the default documentation format for
360 your ruby project. Issue #94 by Henrik Hodne
361 * Fixed handling of LANG in the RDoc::Options tests. Issue #99 by Vít
362 Ondruch
363 * RDoc no longer quits when given an entry that is not a file or directory.
364 Issue #101 by Charles Nutter
365 * Fixed bug in syntax-highlighting that would corrupt regular expressions.
366 Ruby Bug #6488 by Benny Lyne Amorsen.
367 * "class Object" no longer appears in the coverage report if all its methods
368 are documented. This suppresses a false positive for libraries that add
369 toplevel methods. Pull Request #128 by Zachary Scott.
370 * Fixed test_gen_url test name in TestRDocMarkupToHtml. Pull Request #130
371 by Zachary Scott.
372 * Comment-defined methods ahead of define_method are now discovered. Issue
373 #133 by eclectic923
374 * Fixed detection of define_method documentation. Issue #138 by Marvin
375 Gülker.
376 * Fixed lexing of character syntax (<code>?z</code>). Reported by Xavier
377 Noria.
378 * Add license to gem spec. Issue #144 by pivotalcommon
379 * Fixed comment selection for classes. Pull request #146 by pioz
380 * Fixed parsing of <code>def self.&() end</code>. Issue #148 by Michael
381 Lucy
382 * Generated RD parser files are now included in the gem. Issue #145 by
383 Marvin Gülker
384 * Class and module aliases now create new classes to avoid duplicate names
385 in the class list. Issue #143 by Richard Schneeman, Rails Issue #2839
386 * RDoc::Markup::Parser now correctly matches indentation of lists when
387 multibyte characters are used in the list labels. Issue #140 by
388 burningTyger
389 * Fixed mangling of email addresses that look like labels. Issue #129 by
390 Tobias Koch
391 * Classes and modules in a C file may now be created in any order. Issue
392 #124 by Su Zhang
393 * A metaprogrammed method supports the :args: directive. Issue #100
394 * A metaprogrammed method supports the :yields: directive.
395 * RDoc will now look for directives up to the end of the line. For example,
396 class B < A; end # :nodoc:
397 will now hide documentation of B. Issue #125 by Zachary Scott
398 * Fixed tokenization of % when it is not followed by a $-string type
399 * Fixed display of __END__ in documentation examples in HTML output
400 * Fixed tokenization of reserved words used as new-style hash keys
401 * RDoc now handles class << $gvar by ignoring the body
402 * Fixed parsing of class A:: B.
403 * Worked around bug in RDoc::RubyLex where tokens won't be reinterpreted
404 after unget_tk.
405 * Fixed class << ::Foo writing documentation to /Foo.html
406 * Fixed class ::A referencing itself from inside its own namespace.
407
408 Changes since RDoc 4.0.0.rc.2:
409
e12ca93 @drbrain Set template encoding correctly
drbrain authored
410 * Bug fix
411 * Templates now use the correct encoding when generating pages. Issue #183
412 by Vít Ondruch
413
414 === 4.0.0.rc.2 / 2013-02-05
415
5f15520 @drbrain Added current heading and page-top links to HTML
drbrain authored
416 * Minor enhancements
417 * Added current heading and page-top links to HTML headings.
418
89702e2 @drbrain Added link handling to RDoc output
drbrain authored
419 * Bug fixes
ffa8788 @drbrain Fix CVE-2013-0256, an XSS exploit in RDoc
drbrain authored
420 * Fixed an XSS exploit in darkfish.js. This could lead to cookie disclosure
fa2edea @drbrain Fix CVE number in History
drbrain authored
421 to third parties. See CVE-2013-0256[rdoc-ref:CVE-2013-0256.rdoc] for full
422 details including a patch you can apply to generated RDoc documentation.
6ed04d6 @drbrain Fixed parsing of multibyte files at byte 1024
drbrain authored
423 * Fixed parsing of multibyte files with incomplete characters at byte 1024.
424 Ruby bug #6393 by nobu, patch by Nobuyoshi Nakada and Yui NARUSE.
99b693c @drbrain Fixed rdoc -E
drbrain authored
425 * Fixed rdoc -E. Ruby Bug #6392 and (modified) patch by Nobuyoshi Nakada
89702e2 @drbrain Added link handling to RDoc output
drbrain authored
426 * Added link handling to Markdown output. Bug #160 by burningTyger.
7758064 @drbrain Added limited HEREDOC tokenization
drbrain authored
427 * Fixed HEREDOC output for the limited case of a heredoc followed by a line
428 end. When a HEREDOC is not followed by a line end RDoc is not currently
429 smart enough to restore the source correctly. Bug #162 by Zachary Scott.
bc67b60 @drbrain Parsing executables with #! and encoding: comment
drbrain authored
430 * Fixed parsing of executables with shebang and encoding comments. Bug #161
431 by Marcus Stollsteimer
610b483 @drbrain Ignore methods defined on constants
drbrain authored
432 * RDoc now ignores methods defined on constants instead of creating a fake
433 module. Bug #163 by Zachary Scott.
6dd8d41 @drbrain Fixed parsing of FFI's libffi ChangeLog
drbrain authored
434 * Fixed ChangeLog parsing for FFI gem. Bug #165 by Zachary Scott.
ebc6666 @drbrain RDoc can now link #=== methods
drbrain authored
435 * RDoc now links \#=== methods. Bug #164 by Zachary Scott.
5c0c24a @drbrain Allow [] in arguments for TomDoc
drbrain authored
436 * Allow [] following argument names for TomDoc. Bug #167 by Ellis Berner.
5f5460e @drbrain Fixed servlet for home and site directories
drbrain authored
437 * Fixed the RDoc servlet for home and site directories. Bug #170 by Thomas
438 Leitner.
6b72b1f @drbrain Fixed references to methods in the RDoc servlet
drbrain authored
439 * Fixed references to methods in the RDoc servlet. Bug #171 by Thomas
440 Leitner.
2cf4814 @drbrain Updated history for #174
drbrain authored
441 * Fixed debug message when generating the darkfish root page. Pull Request
442 #174 by Thomas Leitner.
d84e38b @drbrain Don't delete attribute data when re-saving a class
drbrain authored
443 * Fixed deletion of attribute ri data when a class was loaded then saved.
444 Issue #171 by Thomas Leitner.
89702e2 @drbrain Added link handling to RDoc output
drbrain authored
445
446 === 4.0.0.preview2.1 / 2012-12-14
447
9a4d076 @drbrain Fixed table of contents display in HTML
drbrain authored
448 * Minor enhancements
fe89ec5 @drbrain Added --page-dir option to rdoc
drbrain authored
449 * Added --page-dir option to give pretty names for a FAQ, guides, or other
450 documentation you write that is not stored in the project root. For
451 example, with the following layout:
452
453 README.txt
454 guides/syntax.txt
455 guides/conversion.txt
456
457 Running `rdoc --page-dir guides` will make the files in "guides" appear to
458 be at the top level of the project. This means they will appear to exist
459 at the top level in HTML output and you can access them with
460 `ri your_gem:syntax` and `ri your_gem:conversion`.
461
9a4d076 @drbrain Fixed table of contents display in HTML
drbrain authored
462 * Bug fixes
f5951bb @drbrain Attach fully-qualified constants to their modules
drbrain authored
463 * Fully qualified names for constants declared from the top level are now
464 attached to their class or module properly.
9a4d076 @drbrain Fixed table of contents display in HTML
drbrain authored
465 * Fixed table of contents display in HTML output for classes and modules.
61a8f55 @drbrain Incremental ri builds of C files now work
drbrain authored
466 * Incremental ri builds of C files now work. C variable names from previous
467 runs are now saved between runs.
f5951bb @drbrain Attach fully-qualified constants to their modules
drbrain authored
468
469 === 4.0.0.preview2 / 2012-12-01
470
e0c0722 @drbrain The default output encoding is now UTF-8. Fixes #106
drbrain authored
471 * Breaking changes
ba16592 @drbrain Remove global state from RDoc::RDoc
drbrain authored
472 * The default output encoding for RDoc is now UTF-8. Previously RDoc used
473 the default external encoding which was determined from your locale.
474 Issue #106 by Justin Baker.
2d88424 @drbrain Move global parse state to RDoc::Store
drbrain authored
475 * RDoc::RI::Store is now RDoc::Store so ri data generated by RDoc 4 cannot
476 be read by earlier versions of RDoc. RDoc::RI::Store exists as an alias
477 of RDoc::Store so ri data from older versions can still be read.
478 RDoc::RI::Store will be removed in RDoc 5.
479
480 Tests that create RDoc::CodeObjects on the fly without wiring them into
fcc8eba @drbrain Creating a TopLevel no longer changes global state
drbrain authored
481 the documentation tree (did not use add_class, add_method, etc.) must be
482 updated to use these methods. The documentation tree automatically
2d88424 @drbrain Move global parse state to RDoc::Store
drbrain authored
483 attaches them to the store instance which allows lookups to work
fcc8eba @drbrain Creating a TopLevel no longer changes global state
drbrain authored
484 correctly. Additionally, a new method RDoc::Store#add_file must be used
485 instead of RDoc::TopLevel.new. The latter will not be attached to the
486 documentation tree.
487 * RDoc generators must accept an RDoc::Store and an RDoc::Options in
488 initialize. RDoc no longer passes an Array of RDoc::TopLevel objects to
489 #generate. Use RDoc::Store#all_files instead.
ba16592 @drbrain Remove global state from RDoc::RDoc
drbrain authored
490 * Some markup formatters (RDoc::Markup::To*) now accept an RDoc::Options
491 instance as the first argument. Notably, the base class Formatter and
492 ToHtml*. (This is not universal due to the difficult at accessing the
493 user's options instance deep inside RDoc. A future major release may
494 remedy this.)
c434e9c @drbrain Updated History.txt for 4.0.0.preview2 release
drbrain authored
495 * Added new markup nodes and specials that RDoc::Markup::Formatter
496 subclasses must handle. If you're using RDoc::Markup::FormatterTestCase
497 the new methods you need to add should be readily apparent.
8d34bb5 @drbrain Added methods to retrieve portions of the RI path
drbrain authored
498 * Removed RDoc::RI::Paths::SYSDIR and ::SITEDIR. These were hidden
499 constants so no breakage is expected. Use RDoc::RI::Paths::system_dir
500 and ::site_dir instead.
5fa30eb @drbrain Renamed #modules to #module_names on RDoc::Store
drbrain authored
501 * RDoc::RI::Store#modules has been renamed to RDoc::Store#module_names
502 to avoid confusion with RDoc::Store#all_modules imported from
503 RDoc::TopLevel.
640e6d7 @drbrain Updated History for RDoc::RDocError removal
drbrain authored
504 * RDoc::RDocError has been removed. It was deprecated throughout RDoc 3.
ba16592 @drbrain Remove global state from RDoc::RDoc
drbrain authored
505 * ri -f html is no longer supported.
d4c86a4 @drbrain Restricted C constant definitions in comments to the first line. Fixes ...
drbrain authored
506 * Comment definitions in C comments are now only discovered from the first
507 line. A colon on a subsequent line won't trigger definition extraction.
508 Issue #103, see also
509 http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/42942
a98e3cb @drbrain Fixed stopdoc for class A::B. Fixes #95
drbrain authored
510 * Fixed :stopdoc: for class A::B where A has not been seen. Issue #95 by
511 Ryan Davis
27e3c68 @drbrain RDoc::ClassModule#each_ancestor no longer yields itself
drbrain authored
512 * RDoc::ClassModule#each_ancestor no longer yields itself if there is
513 circular ancestry
ba16592 @drbrain Remove global state from RDoc::RDoc
drbrain authored
514
515 * Major enhancements
338cccd @drbrain ri can now display pages
drbrain authored
516 * ri can now show pages (README, etc.)
517
518 ri rdoc:README
519
520 Will show the README for the latest version of RDoc. You can specify
521 exact gem versions such as "rdoc-4.0:README" or view pages from the
522 standard library documentation with "ruby:README".
523
524 RDoc 3 did not save pages in ri data so you will need to regenerate
525 documentation from your gems to use this feature.
c434e9c @drbrain Updated History.txt for 4.0.0.preview2 release
drbrain authored
526 * Added Markdown as a supported format. The markdown format can be set on a
527 per-file or per-comment basis with the +:markdown:+ directive like the rd
528 and tomdoc formats and on a per-project basis with
529 <tt>rdoc --markup markdown --write-options</tt>
ba16592 @drbrain Remove global state from RDoc::RDoc
drbrain authored
530 * Removed global state from RDoc. RDoc::Store holds the documentation tree
531 and connects the driver to the parsers and generator. This also allows
338cccd @drbrain ri can now display pages
drbrain authored
532 documentation parsing and generation for multiple instances, but the rdoc
533 command-line tool does not support this.
ba16592 @drbrain Remove global state from RDoc::RDoc
drbrain authored
534
535 Due to this change RDoc::RDoc.current and RDoc::RDoc.reset no longer
536 exist.
9f469d4 @drbrain Added a table of contents for the top comment of the current page to the...
drbrain authored
537
538 * Minor enhancements
9565793 @drbrain Added --root for building documentation outside the source dir
drbrain authored
539 * Added --root for building documentation from outside the source dir.
471e0c7 @drbrain Added a ChangeLog parser
drbrain authored
540 * Added a ChangeLog parser. It automatically parses files that begin
541 with 'ChangeLog'
9f469d4 @drbrain Added a table of contents for the top comment of the current page to the...
drbrain authored
542 * Added a table of contents to the sidebar.
c2667de @drbrain RDoc markup format now supports multi-label definition lists
drbrain authored
543 * RDoc markup format merges adjacent labels in a label or note list into a
544 single definition list item for output.
d2e857d @drbrain Minor updates for #118
drbrain authored
545 * RDoc now tracks use of extend. Pull request #118 by Michael Granger.
1b2a871 @drbrain Parse :method: comments ahead of define_method
drbrain authored
546 * RDoc now tracks methods that use super. Pull request #116 by Erik
d2e857d @drbrain Minor updates for #118
drbrain authored
547 Hollensbe.
8d34bb5 @drbrain Added methods to retrieve portions of the RI path
drbrain authored
548 * Added methods ::system_dir, ::site_dir, ::home_dir and ::gem_dir to fetch
549 the components of RDoc::RI::Paths.path individually.
4b76cba @drbrain Added support for rb_file_const() to the C parser
drbrain authored
550 * Added support for rb_file_const.
8d5b471 @drbrain Process files in sorted order. Issue #71
drbrain authored
551 * RDoc now processes files in sorted order. Issue #71 by Vít Ondruch
d3fafc7 @drbrain Warn with --verbose when duplicate methods are encountered. Issue #71
drbrain authored
552 * RDoc now warns with --verbose when methods are duplicated. Issue #71 by
553 Vít Ondruch
375a5b2 @drbrain Show method documentation for a class with ri -a
drbrain authored
554 * ri will display documentation for all methods in a class if -a is given.
555 Issue #57 by casper
0f3d128 @drbrain Report missing coverage line for attributes, constants, methods
drbrain authored
556 * The RDoc coverage report will report line information for attributes,
557 constants and methods missing documentation. Issue #121 by Zachary Scott
7faf4cd @drbrain Warn and ignore unreadable files
drbrain authored
558 * RDoc now reports a warning for files that are unreadable due to
559 permissions problems.
c434e9c @drbrain Updated History.txt for 4.0.0.preview2 release
drbrain authored
560 * RDoc controls documentation generation for RubyGems 2.0+
9f469d4 @drbrain Added a table of contents for the top comment of the current page to the...
drbrain authored
561
37492e0 @drbrain Text immediately before a multiword tidylink no longer disappears
drbrain authored
562 * Bug fixes
563 * A word that is directly followed by a multi-word tidy link label no longer
564 disappears. (Like <code>text{link}[http://example]</code>)
4d5b343 @drbrain Added History entry for #107
drbrain authored
565 * Fixed legacy template support. Pull Request #107 by Justin Baker.
83ff512 @drbrain An HTML class no longer triggers ruby parseability. Fixes #92
drbrain authored
566 * An HTML class in a verbatim section no longer triggers ruby parsing.
567 Issue #92 by Vijay Dev
ab90abd @drbrain Fixed TestRDocOptions#test_encode_with to use Encoding.default_external ...
drbrain authored
568 * Improved documentation for setting the default documentation format for
569 your ruby project. Issue #94 by Henrik Hodne
570 * Fixed handling of LANG in the RDoc::Options tests. Issue #99 by Vít
571 Ondruch
2e0026e @drbrain Fixed handling of unknown file types such as FIFOs in RDoc::RDoc#normali...
drbrain authored
572 * RDoc no longer quits when given an entry that is not a file or directory.
573 Issue #101 by Charles Nutter
0d72fc0 @drbrain Fixed syntax highlighting of regular expressions
drbrain authored
574 * Fixed bug in syntax-highlighting that would corrupt regular expressions.
575 Ruby Bug #6488 by Benny Lyne Amorsen.
6c25e14 @drbrain Updated History for #128
drbrain authored
576 * "class Object" no longer appears in the coverage report if all its methods
577 are documented. This suppresses a false positive for libraries that add
578 toplevel methods. Pull Request #128 by Zachary Scott.
15f9876 @drbrain Updated History for #130
drbrain authored
579 * Fixed test_gen_url test name in TestRDocMarkupToHtml. Pull Request #130
580 by Zachary Scott.
1b2a871 @drbrain Parse :method: comments ahead of define_method
drbrain authored
581 * Comment-defined methods ahead of define_method are now discovered. Issue
582 #133 by eclectic923
f7e2f18 @drbrain Fixed detection of define_method documentation.
drbrain authored
583 * Fixed detection of define_method documentation. Issue #138 by Marvin
584 Gülker.
585 * Fixed lexing of character syntax (<code>?z</code>). Reported by Xavier
0c2a543 @drbrain Fixed lexing of character syntax like ?z
drbrain authored
586 Noria.
6e3679d @zzak Add license to gem spec #144
zzak authored
587 * Add license to gem spec. Issue #144 by pivotalcommon
857b9ee @drbrain Updated History for #146
drbrain authored
588 * Fixed comment selection for classes. Pull request #146 by pioz
8b25c18 @drbrain Fixed parsing of `def self.&() end`. Fixes #148
drbrain authored
589 * Fixed parsing of <code>def self.&() end</code>. Issue #148 by Michael
590 Lucy
c5ac18b @drbrain Added #145 to the history
drbrain authored
591 * Generated RD parser files are now included in the gem. Issue #145 by
592 Marvin Gülker
ca02643 @drbrain RDoc::Context#add_module_alias now duplicates aliased classes. Fixes #1...
drbrain authored
593 * Class and module aliases now create new classes to avoid duplicate names
594 in the class list. Issue #143 by Richard Schneeman, Rails Issue #2839
93be7de @drbrain Use character offsets when tokenizing RDoc markup.
drbrain authored
595 * RDoc::Markup::Parser now correctly matches indentation of lists when
596 multibyte characters are used in the list labels. Issue #140 by
597 burningTyger
84d5727 @drbrain Fixed mangling of email addresses. Fixes #140
drbrain authored
598 * Fixed mangling of email addresses that look like labels. Issue #129 by
599 Tobias Koch
a71b6c7 @drbrain Classes or modules may appear in C files in any order. Fixes #124
drbrain authored
600 * Classes and modules in a C file may now be created in any order. Issue
601 #124 by Su Zhang
711eb3c @drbrain Metaprogrammed methods support :yield:
drbrain authored
602 * A metaprogrammed method supports the :args: directive. Issue #100
603 * A metaprogrammed method supports the :yields: directive.
03e961d @drbrain Directives are now found up to the end-of-line.
drbrain authored
604 * RDoc will now look for directives up to the end of the line. For example,
605 class B < A; end # :nodoc:
606 will now hide documentation of B. Issue #125 by Zachary Scott
711eb3c @drbrain Metaprogrammed methods support :yield:
drbrain authored
607 * Fixed tokenization of % when it is not followed by a $-string type
608 * Fixed display of __END__ in documentation examples in HTML output
609 * Fixed tokenization of reserved words used as new-style hash keys
c3bfcf3 @drbrain Handle class << $gvar by ignoring the body
drbrain authored
610 * RDoc now handles class << $gvar by ignoring the body
ce2c63b @drbrain Fixed parsing of `class A:: B`
drbrain authored
611 * Fixed parsing of class A:: B.
ef96a73 @drbrain Worked around bug in RubyLex
drbrain authored
612 * Worked around bug in RDoc::RubyLex where tokens won't be reinterpreted
613 after unget_tk.
7194da2 @drbrain Remove :: when parsing singleton classes defined elsewhere
drbrain authored
614 * Fixed class << ::Foo writing documentation to /Foo.html
8d39a7a @drbrain Fixed class ::A referencing itself inside its own namespace
drbrain authored
615 * Fixed class ::A referencing itself from inside its own namespace.
37492e0 @drbrain Text immediately before a multiword tidylink no longer disappears
drbrain authored
616
7ac4477 @drbrain Added 3.12.2 release to History
drbrain authored
617 === 3.12.2 / 2013-02-24
618
619 * Bug fixes
620 * Fixed bug in syntax-highlighting that would corrupt regular expressions.
621 Ruby Bug #6488 by Benny Lyne Amorsen.
622 * Fixed lexing of character syntax (<code>?x</code>). Reported by Xavier
623 Noria.
624 * Fixed tokenization of % when it is not followed by a $-string type
625 * Fixed display of __END__ in documentation examples in HTML output
626 * Fixed tokenization of reserved words used as new-style hash keys
627 * Fixed HEREDOC output for the limited case of a heredoc followed by a line
628 end. When a HEREDOC is not followed by a line end RDoc is not currently
629 smart enough to restore the source correctly. Bug #162 by Zachary Scott.
630
1d22e8c @drbrain Comprehensive release notes for 4.0.0.rc.2.1
drbrain authored
631 === 3.12.1 / 2013-02-05
632
633 * Bug fixes
634 * Fixed an XSS exploit in darkfish.js. This could lead to cookie disclosure
635 to third parties. See CVE-2013-0256[rdoc-ref:CVE-2013-0256.rdoc] for full
636 details including a patch you can apply to generated RDoc documentation.
637 * Ensured that rd parser files are generated before checking the manifest.
638
54409a9 @drbrain Set version
drbrain authored
639 === 3.12 / 2011-12-15
b3fc4cb @drbrain Fix title on HTML output for pages
drbrain authored
640
46e94dd @drbrain Add title from options to the title element
drbrain authored
641 * Minor enhancements
9c201e1 @drbrain Mention DEVELOPERS in History
drbrain authored
642 * Added DEVELOPERS document which contains an overview of how RDoc works and
643 how to add new features to RDoc.
46e94dd @drbrain Add title from options to the title element
drbrain authored
644 * Improved title for HTML output to include <code>--title</code> in the
645 title element.
be45312 @drbrain rdoc --pipe now respects --markup
drbrain authored
646 * <code>rdoc --pipe</code> now understands <code>--markup</code>.
51820d5 @drbrain Fixed various typos discovered by rdoc-spellcheck
drbrain authored
647 * RDoc now supports IRC-scheme hyperlinks. Issue #83 by trans.
46e94dd @drbrain Add title from options to the title element
drbrain authored
648
b3fc4cb @drbrain Fix title on HTML output for pages
drbrain authored
649 * Bug fixes
37492e0 @drbrain Text immediately before a multiword tidylink no longer disappears
drbrain authored
650 * Fixed title on HTML output for pages.
528974a @drbrain Fix parsing bug in non-indented HEREDOCs
drbrain authored
651 * Fixed parsing of non-indented HEREDOC.
9bbea55 @drbrain Only replace the last arrow in call-seq output. Fixes Issue #85
drbrain authored
652 * Fixed parsing of <code>%w[]</code> and other % literals. Issue #84 by
653 Erik Hollensbe
654 * Fixed arrow replacement in HTML output munging the spaceship operator.
655 Issue #85 by eclectic923.
c50f187 @drbrain Blacklist ERB sequences in verbatim blocks as ruby-parseable in HTML out...
drbrain authored
656 * Verbatim sections with ERB that match the ruby code whitelist are no
657 longer syntax-highlighted. Issue #86 by eclectic923
218ae68 @drbrain Update History. Issue #87
drbrain authored
658 * Line endings on windows are normalized immediately after reading with
659 binmode. Issue #87 by Usa Nakamura
4d9ac59 @drbrain Adjust comment parsing in comment values to find comments anywhere in th...
drbrain authored
660 * RDoc better understands directives for comments. Comment directives can
661 now be found anywhere in multi-line comments. Issue #90 by Ryan Davis
f281bc0 @drbrain Tidy links show the label again. Issue #88
drbrain authored
662 * Tidy links to methods show the label again. Issue #88 by Simon Chiang
6c1c0d4 @drbrain RDoc::Parser::C#find_class_comment can now find a comment immediatly bef...
drbrain authored
663 * RDoc::Parser::C can now find comments directly above
664 +rb_define_class_under+. Issue #89 by Enrico
ab35bc5 @drbrain Show labels and notes that are missing bodies for rdoc, ansi, bs formatt...
drbrain authored
665 * In rdoc, backspace and ansi formatters, labels and notes without bodies
666 are now shown.
667 * In rdoc, backspace and ansi formatters, whitespace between label or note
668 and the colon is now stripped.
b3fc4cb @drbrain Fix title on HTML output for pages
drbrain authored
669
54409a9 @drbrain Set version
drbrain authored
670 === 3.11 / 2011-10-17
4a8b7be @drbrain Exclude TAGS files that may have been included in gems from parsing. Is...
drbrain authored
671
672 * Bug fixes
673 * Avoid parsing TAGS files included in gems. Issue #81 by Santiago
674 Pastorino.
675
676 === 3.10 / 2011-10-08
ae69bbb @drbrain Add RDoc::Parser::RD to parse .rd files
drbrain authored
677
678 * Major enhancements
ec4de39 @drbrain Copy listed files into the output dir using --copy-files
drbrain authored
679 * RDoc HTML output has been improved:
3628e19 @drbrain Add LEGAL.rdoc with references to licenses in other files. Issue #78
drbrain authored
680 * The search from Володя Колесников's (Vladimir Kolesnikov) Sdoc has been
681 integrated.
e3050f0 @drbrain Integrated search from sdoc
drbrain authored
682
683 The search index generation is a reusable component through
684 RDoc::Generator::JsonIndex
9dbe607 @drbrain Stop linking to file info pages as they have no useful information
drbrain authored
685 * The table of contents is now a separate page and now shows links to
9a104ab @drbrain Fix missed conversion from label to aref
drbrain authored
686 headings and sections inside a page or class.
9dbe607 @drbrain Stop linking to file info pages as they have no useful information
drbrain authored
687 * Class pages no longer show the namespace and no longer have file info
688 pages.
ec4de39 @drbrain Copy listed files into the output dir using --copy-files
drbrain authored
689 * HTML output is HTML 5.
690 * Static files can be copied into RDoc using --copy-files
691 * RDoc supports additional documentation formats:
0318fae @drbrain Update TomDoc support to 1.0.0-rc1
drbrain authored
692 * TomDoc 1.0.0-rc1
f7e6488 @drbrain Update history for TomDoc
drbrain authored
693 * RD format
694
0318fae @drbrain Update TomDoc support to 1.0.0-rc1
drbrain authored
695 The default markup can be set via the <tt>--markup</tt> option.
722abfd @drbrain Added --markup command line option to set default format.
drbrain authored
696
f7e6488 @drbrain Update history for TomDoc
drbrain authored
697 The format of documentation in a particular file can be specified by the
eda0ff1 @drbrain Use only :markup: for both determining the parser (Ruby, RD) and the com...
drbrain authored
698 +:markup:+ directive. If the +:markup:+ directive is in the first comment
f7e6488 @drbrain Update history for TomDoc
drbrain authored
699 it is used as the default for the entire file. For other comments it
700 overrides the default markup format.
ae69bbb @drbrain Add RDoc::Parser::RD to parse .rd files
drbrain authored
701
586813d @drbrain RDoc::Task can now set the comment markup through #markup
drbrain authored
702 The markup format can be set for rake tasks using RDoc::Task#markup
23fc244 @drbrain Add --write-options to `rdoc` to save the author's preferences
drbrain authored
703 * RDoc can save and load an options file.
704
705 To create an options file that defaults to using TomDoc markup run:
706
707 rdoc --markup tomdoc --write-options
708
709 This will create a .rdoc_options file. Check it in to your VCS and
710 package it with your gem. RDoc will automatically load this file and
711 combine it with the user's options.
712
713 Some options are not saved. See RDoc::Options@Saved+Options for full
714 details.
586813d @drbrain RDoc::Task can now set the comment markup through #markup
drbrain authored
715
ae69bbb @drbrain Add RDoc::Parser::RD to parse .rd files
drbrain authored
716 * Minor enhancements
cd8af04 @drbrain Mention autoload in RDoc
drbrain authored
717 * RDoc autoloads everything. You only need to require 'rdoc' now.
8ac635b @drbrain Add ids to heading elements
drbrain authored
718 * HTML headings now have ids matching their titles.
719
720 = Hello!
721
722 Is rendered as
723
724 <h1 id="label-Hello%21">Hello!</h1>
649cbde @drbrain Namespace label ids under the associated method
drbrain authored
725
160ae63 @drbrain Use @ instead of % for cross-reference label links. Add "at" between la...
drbrain authored
726 * Labels for classes or methods can be linked-to by adding an <tt>@</tt>
47eeb15 @drbrain Add linking to headings with %heading
drbrain authored
727 following the class or method reference. For example,
160ae63 @drbrain Use @ instead of % for cross-reference label links. Add "at" between la...
drbrain authored
728 <tt>RDoc::Markup@Links</tt>
47eeb15 @drbrain Add linking to headings with %heading
drbrain authored
729
160ae63 @drbrain Use @ instead of % for cross-reference label links. Add "at" between la...
drbrain authored
730 See RDoc::Markup@Links for further details.
297cd5a @drbrain Added RDoc::MethodAttr#output_name to reduce the occurances of SomeClass...
drbrain authored
731 * For HTML output RDoc uses +SomeClass.method_name+ and
732 +SomeClass#method_name+ for remote methods and attributes and
733 +::method_name+ and +#method_name+ for local methods.
0a8902f @drbrain Added syntax highlighting for verbatim sections that (probably) contain ...
drbrain authored
734 * RDoc makes an effort to syntax-highlight ruby code in verbatim sections.
735 See RDoc::Markup@Paragraphs+and+Verbatim
ae69bbb @drbrain Add RDoc::Parser::RD to parse .rd files
drbrain authored
736 * Added RDoc::TopLevel#text? and RDoc::Parser::Text to indicate a
737 parsed file contains no ruby constructs.
02c5f82 @drbrain Loosened TIDYLINK regular expression
drbrain authored
738 * Added <tt>rdoc-label</tt> link scheme which allows bidirectional links.
fe9f121 @drbrain Fix commit miss on History and documentation of rdoc-label
drbrain authored
739 See RDoc::Markup for details.
8089df4 @drbrain Update History for Issue #60, add name for Issue #63
drbrain authored
740 * Image paths at HTTPS URLs will now be turned into +<img>+ tags. Pull
741 Request #60 by James Mead
eae7abe @drbrain Add RDoc::Comment to encapsulate comment-handling functionality
drbrain authored
742 * Added RDoc::Comment which encapsulates comment-handling functionality.
8b3c861 @drbrain Add RDoc::Markup::PreProcess#post_process.
drbrain authored
743 * Added RDoc::Markup::PreProcess::post_process to allow arbitrary comment
744 munging.
722abfd @drbrain Added --markup command line option to set default format.
drbrain authored
745 * RDoc::RDoc::current is set for the entire RDoc run.
d1d3ac4 @drbrain Split rdoc/markup/inline into its component classes
drbrain authored
746 * Split rdoc/markup/inline into individual files for its component classes.
0a8902f @drbrain Added syntax highlighting for verbatim sections that (probably) contain ...
drbrain authored
747 * Moved token stream HTML markup out of RDoc::AnyMethod#markup_code into
748 RDoc::TokenStream::to_html
19c9223 @drbrain Moved Top link for sections out of the h2 for better semantic meaning
drbrain authored
749 * "Top" link in section headers is no longer inside the heading element.
6261486 @drbrain Avoid printing more warnings when run without --verbose. For Rails issu...
drbrain authored
750 * RDoc avoids printing some warnings unless run with `rdoc --verbose`. For
751 Rails issue #1646.
63f798a @drbrain Add experimental feature to insert a blank line if a line of a paragraph...
drbrain authored
752 * Finishing a paragraph with two or more spaces will result in a line break.
753 This feature is experimental and may be modified or removed.
02c5f82 @drbrain Loosened TIDYLINK regular expression
drbrain authored
754
160ae63 @drbrain Use @ instead of % for cross-reference label links. Add "at" between la...
drbrain authored
755 * Bug fixes
756 * Markup defined by RDoc::Markup#add_special inside a <tt><tt></tt> is no
757 longer converted.
1758d71 @drbrain Use rindex instead of reverse.index to improve the performance of RDoc::...
drbrain authored
758 * Performance of RDoc::RubyLex has been improved. Ruby Bug #5202 by Ryan
759 Melton.
8089df4 @drbrain Update History for Issue #60, add name for Issue #63
drbrain authored
760 * Add US-ASCII magic comments to work with <tt>ruby -Ku</tt>. Issue #63 by
761 Travis D. Warlick, Jr.
3ac844d @drbrain Method source is only shown when clicking on the header. Issue #61
drbrain authored
762 * Clicking a link in the method description now works. Issue #61 by Alan
763 Hogan.
c435acb @drbrain RDoc::Markup::Parser now supports CRLF line endings. Issue #67
drbrain authored
764 * Fixed RDoc::Markup::Parser for CRLF line endings. Issue #67 by Marvin
765 Gülker.
8eabf2a @drbrain Fixed lexing of percent strings. Issue #68
drbrain authored
766 * Fixed lexing of percent strings like %r{#}. Issue #68 by eclectic923.
7724460 @drbrain Update History with Issue #73
drbrain authored
767 * The C parser now understands classes defined with
768 +rb_struct_define_without_accessor+ (like Range). Pull Request #73 by Dan
769 Bernier
062efe8 @drbrain Fix lexing of `a bb <<-HEREDOC`. Issue #75
drbrain authored
770 * Fixed lexing of <code>a b <<-HEREDOC</code>. Issue #75 by John Mair.
3628e19 @drbrain Add LEGAL.rdoc with references to licenses in other files. Issue #78
drbrain authored
771 * Added LEGAL.rdoc with references to licenses in other files. Issue #78 by
772 Dmitry Jemerov.
c864750 @drbrain Use param_seq instead of params to display up block parameters in Darkfi...
drbrain authored
773 * Block parameters are displayed in Darkfish output again. Issue #76 by
774 Andrea Singh.
c95606d @drbrain RDoc::AnyMethod#param_list now removes default values. Issue #77 by Jak...
drbrain authored
775 * The method parameter coverage report no longer includes parameter default
776 values. Issue #77 by Jake Goulding.
50d3bc0 @drbrain Delay looking up the module for an include statement until all files are...
drbrain authored
777 * The module for an include is not looked up until parsed all the files are
778 parsed. Unless your project includes nonexistent modules this avoids
779 worst-case behavior (<tt>O(n!)</tt>) of RDoc::Include#module.
160ae63 @drbrain Use @ instead of % for cross-reference label links. Add "at" between la...
drbrain authored
780
1d22e8c @drbrain Comprehensive release notes for 4.0.0.rc.2.1
drbrain authored
781 === 3.9.5 / 2013-02-05
782
783 * Bug fixes
784 * Fixed an XSS exploit in darkfish.js. This could lead to cookie disclosure
785 to third parties. See CVE-2013-0256.rdoc for full details including a
786 patch you can apply to generated RDoc documentation.
787
788 === 3.9.4 / 2011-08-26
789
790 * Bug fixes
791 * Applied typo and grammar fixes from Luke Gruber. Ruby bug #5203
792
793 === 3.9.3 / 2011-08-23
794
795 * Bug fixes
796 * Add US-ASCII magic comments to work with <tt>ruby -Ku</tt>. Issue #63 by
797 Travis D. Warlick, Jr.
798 * Image paths at HTTPS URLs are now turned into +<img>+ tags. Pull
799 Request #60 by James Mead
800 * Markup defined by RDoc::Markup#add_special inside a <tt><tt></tt> is no
801 longer converted.
802
035ad25 @drbrain Add 3.9.2 to trunk
drbrain authored
803 === 3.9.2 / 2011-08-11
804
805 * Bug fix
02c5f82 @drbrain Loosened TIDYLINK regular expression
drbrain authored
806 * Loosened TIDYLINK regexp to allow any content in the link section like:
807 <tt>{foo}[rdoc-ref:SomeClass]</tt>
46c19ec @drbrain Cap headings in HTML at level 6 again
drbrain authored
808 * In HTML output headings are capped at <tt><h6></tt> again
ae69bbb @drbrain Add RDoc::Parser::RD to parse .rd files
drbrain authored
809
810 === 3.9.1 / 2011-07-31
311d8c3 @drbrain Fix bug report URL when rdoc crashes
drbrain authored
811
812 * Bug fixes
06bf78d @drbrain Fix RDoc::Markup::Parser for a header followed by a non-text token. Iss...
drbrain authored
813 * Fix RDoc::Markup parser for a header followed by a non-text token. Issue
814 #56 by Adam Tait
0d64bd5 @drbrain Fix gen_url for non-rdoc-ref links. Issue #56
drbrain authored
815 * Fix RDoc::Markup::ToHtmlCrossref#gen_url for non-<tt>rdoc-ref</tt> links.
311d8c3 @drbrain Fix bug report URL when rdoc crashes
drbrain authored
816 * Fix bug report URL when rdoc crashes.
817
0c22240 @drbrain Set version
drbrain authored
818 === 3.9 / 2011-07-30
01275ae @drbrain Bump version
drbrain authored
819
820 * Minor enhancements
9cc3a51 @drbrain Support doc, nodoc via class comment in the C parser
drbrain authored
821 * RDoc::Parser::C now supports :doc: and :nodoc: for class comments
914e3f3 @drbrain Change rdoc: to rdoc-ref: and update documetation. Issue #53
drbrain authored
822 * Added the <tt>rdoc-ref:</tt> link scheme which links to a named reference.
823 <tt>rdoc-ref:</tt> can resolve references to classes, modules, methods,
824 files, etc. This can be used to create cross-generator named links unlike
825 the <tt>link:</tt> scheme which is dependent upon the exact file name.
826 Issue #53 by Simon Chiang
23b6048 @drbrain Pull RDoc::CrossReference out of RDoc::Markup:ToHtmlCrossref. Now refer...
drbrain authored
827 * Pulled RDoc::CrossReference out of RDoc::Markup::ToHtmlCrossref.
e2c02eb @drbrain RDoc::CrossReference should not create HTML links
drbrain authored
828 Cross-references can now be created easily for non-HTML formatters.
e935763 @drbrain Updating Object in an ri data store now removes methods, etc. properly.
drbrain authored
829 * Bug fixes
8c87409 @drbrain Handle [] and other specials. Issue #41
drbrain authored
830 * `ri []` and other special methods now work properly. Issue #52 by
831 ddebernardy.
01e7ef4 @drbrain Update history for ri spacing fix
drbrain authored
832 * `ri` now has space between class comments from multiple files.
cf861cf @drbrain Fix loop termination when looking for the modifier comment of a class al...
drbrain authored
833 * :stopdoc: no longer creates Object references. Issue #55 by Simon Chiang
834 * :nodoc: works on class aliases now. Issue #51 by Steven G. Harms
46f1350 @drbrain Remove tokenizer restrictions on header lengths for verbatim sections. ...
drbrain authored
835 * Remove tokenizer restriction on header lengths for verbatim sections.
836 Issue #49 by trans
01275ae @drbrain Bump version
drbrain authored
837
6db7bd9 @drbrain Fix History, I forgot I released 3.8
drbrain authored
838 === 3.8 / 2011-06-29
839
840 * Minor enhancements
841 * RDoc::Parser::C can now discover methods on ENV and ARGF.
842 * RDoc::Parser::C now knows about rb_cSocket and rb_mDL.
843 * Bug fixes
844 * Updating Object in an ri data store with new data now removes methods,
845 includes, constants and aliases.
846
73e9ee2 @drbrain Update History with release date
drbrain authored
847 === 3.7 / 2011-06-27
8d2f2ee @drbrain RDoc::Parser::C no longer creates classes when processing aliases.
drbrain authored
848
0b45495 @drbrain Add the :category: directive which works like :section: but only for one...
drbrain authored
849 * Minor enhancements
850 * New directive :category: which allows methods to be grouped into sections
851 more cleanly. See RDoc::Markup for details.
614a1bd @drbrain Support Foo::CONST as well as CONST for Document-class in the C parser
drbrain authored
852 * Document-class for RDoc::Parser::C now supports Foo::CONST as well as
853 CONST.
1924ddf @drbrain Add tests for the other features added by pull request #39
drbrain authored
854 * ri method output is now a comma-separated list when displayed
855 interactively. Pull Request #39 by Benoit Daloze.
ea29773 @drbrain Make ClassModule#merge behave like Hash#merge!. Issue #21
drbrain authored
856 * RDoc::ClassModule#merge now prefers the argument's information over the
87a855e @drbrain Clarify #merge change in history
drbrain authored
857 receiver's (it now behaves like Hash#merge! instead of a backwards
858 Hash#merge!).
9ec67d0 @drbrain RDoc::Markup#convert now accepts an RDoc::Markup::Document instance
drbrain authored
859 * RDoc::Markup#convert now accepts an RDoc::Markup::Document instance
60b17e4 @drbrain Import Gem::RDoc as RDoc::RubygemsHook. RDoc now owns the "how to gener...
drbrain authored
860 * RDoc now owns the code for generating RDoc and ri data when gems install
caf961f @drbrain Fix RDoc::ClassModule#parse when the location is nil
drbrain authored
861 * Added RDoc::RDoc::reset
862 * Added RDoc::CodeObject#file_name
8d2f2ee @drbrain RDoc::Parser::C no longer creates classes when processing aliases.
drbrain authored
863 * Bug fixes
fe3069f @drbrain Also escape class names when attempting to complete them
drbrain authored
864 * ri no longer crashes when attempting to complete a plain [.
3112ea3 @drbrain Fix module -> class promotion to not destroy comment location informatio...
drbrain authored
865 * ri data now tracks which file information came from so it can process
866 removals and changes to:
867 * Classes and Modules
868 * Methods
869 * Attributes
870 * Includes
871 * Constants
872 You will need to rebuild your ri data for it to update properly. Issue
873 #21 by Sven Riedel
874 * Signal and SignalException no longer clobber each other
875 * RDoc::Parser::C no longer creates classes when processing aliases.
2d625a6 @drbrain Handle methods ending in =!? when stripping Document-method in RDoc::Tex...
drbrain authored
876 * RDoc::Text#strip_stars handles Document-method for methods with =, ! and ?
877 now.
5b2a547 @drbrain Add cpp to allowed file names for "in" comment on rb_define_method
drbrain authored
878 * RDoc::Parser::C now allows .cpp files to be used with the "in" comment on
879 rb_define_method. Bug #35 by Hanmac.
b5bc83c @drbrain Don't assume there is a TkNL following a TkCOMMENT
drbrain authored
880 * RDoc::Parser::Ruby no longer eats content when =begin/=end documentation
881 blocks are followed by a documentable item. Issue #41 by mfn.
f79d2a2 @drbrain Allow formatters to use a custom-created RDoc::Markup object. Issue #38
drbrain authored
882 * RDoc::Markup::Formatter and subclasses now allow an optional +markup+
883 parameter for adding custom markup. The example in
884 RDoc::Markup::Formatter will now work. Issue #38 by tsilen.
b0ad845 @drbrain Distinguish between class methods and instance methods when using Docume...
drbrain authored
885 * RDoc::Parser::C can now distinguish between class methods and instance
886 methods in Document-method. Issue #36 by Vincent Batts.
1112c01 @drbrain Encode filenames in the destination encoding to work around bug on 1.9.1...
drbrain authored
887 * RDoc now encodes file names in the output encoding. Issue #33 by Perry
888 Smith.
e1397a7 @drbrain Add tests for marshal round-trip
drbrain authored
889 * ri data generation for method aliases no longer duplicates the class in
890 #full_name
8d2f2ee @drbrain RDoc::Parser::C no longer creates classes when processing aliases.
drbrain authored
891
8252e0b @drbrain Allow rb_path2class in rb_define_class_under. Allows rdoc to find OpenS...
drbrain authored
892 === 3.6.1 / 2011-05-15
1d3f389 @drbrain Fix infinite loop caused by re-encountering superclass
drbrain authored
893
894 * Bug fixes
895 * Fix infinite loop created when re-encountering BasicObject.
017e6c9 @drbrain Duck type each_ancestor
drbrain authored
896 * RDoc::Context#each_ancestor is now provided for duck-typing.
8252e0b @drbrain Allow rb_path2class in rb_define_class_under. Allows rdoc to find OpenS...
drbrain authored
897 * rb_path2class() can now be used to discover the parent class in
898 rb_define_class_under.
1d3f389 @drbrain Fix infinite loop caused by re-encountering superclass
drbrain authored
899
9127ef0 @drbrain Set release date
drbrain authored
900 === 3.6 / 2011-05-13
4032839 @drbrain Pull #generate out of RDoc::RDoc to allow reuse.
drbrain authored
901
e815c30 @drbrain Add ri --list and make interactive ri the default if no names are given
drbrain authored
902 * Major Enhancements
903 * Interactive ri is now the default when no names are given.
4032839 @drbrain Pull #generate out of RDoc::RDoc to allow reuse.
drbrain authored
904 * Minor Enhancements
905 * RDoc::RDoc#generate was added to allow multiple generators to be used with
906 a set of parsed file info.
907 * RDoc::Options#finish can be called multiple times now.
cf7aca2 @drbrain Only show one level of namespace when completing class names
drbrain authored
908 * `ri -i` only shows one level of namespace when completing class names.
e815c30 @drbrain Add ri --list and make interactive ri the default if no names are given
drbrain authored
909 * Added `ri --list` for explicit listing. `ri -l F G` will list all classes
910 or modules starting with F or G
e5d4f56 @drbrain Remove windows-specific test for test_check_files, it is too hard. Ruby...
drbrain authored
911 * Bug fixes
912 * Remove windows-specific test for test_check_files, it is too hard to do.
913 Ruby commit r30811 by Usaku Nakamura.
18a316f @drbrain Merge ruby commit r30829, remove platform-dependent hacks
drbrain authored
914 * Remove unnecessary (and wrong) platform-dependent hacks. Ruby commit
915 r30829 by Usaku Nakamura.
557ebe4 @drbrain Fix completion of IO::o
drbrain authored
916 * Completing via Array#[ in `ri -i` no longer crashes. Ruby Bug #3167
917 * Completing IO::o in `ri -i` now returns results. Ruby Bug #3167
1877775 @drbrain Fix greediness of function argument matching so prototypes are no longer...
drbrain authored
918 * RDoc::Parser::C ignores prototypes better. Pull Request #34 by Pete
919 Higgins.
5fb832a @drbrain Handle private_class_method and public_class_method correctly by copying...
drbrain authored
920 * private_class_method and public_class_method are now parsed correctly for
921 inherited methods. Issue #16 by gitsucks.
38354a7 @drbrain Obey force_documentation when removing methods and attributes due to vis...
drbrain authored
922 * The doc directive now forces documentation even when the method is marked
923 private or protected.
e5d4f56 @drbrain Remove windows-specific test for test_check_files, it is too hard. Ruby...
drbrain authored
924
260cc22 @drbrain Set release date
drbrain authored
925 === 3.5.3 / 2010-02-06
b4d29fa @drbrain Add optional force-transcoding to RDoc::Encoding#read_file. Address Rub...
drbrain authored
926
927 * Bug fixes
51820d5 @drbrain Fixed various typos discovered by rdoc-spellcheck
drbrain authored
928 * When including a file perform a lossy force-transcoding to the output
929 encoding instead of crashing to preserve as much content as possible.
930 Ruby Bug #4376 by Yui NARUSE.
36feda5 @drbrain Work around inconsistent encoding result from String#gsub! in #expand_ta...
drbrain authored
931 * Work around inconsistent encoding result from String#sub!, String#gsub!.
932 Related to Ruby Bug #4376.
8b9fd3b @drbrain Work around inconsistent encoding from String#[]=. Related to Ruby Bug ...
drbrain authored
933 * Work around inconsistent encoding result from String#[]=. Related to Ruby
934 Bug #4376.
a05c7e4 @drbrain Report file being generated upon failure
drbrain authored
935 * When Darkfish fails the file being generated is now reported.
b4d29fa @drbrain Add optional force-transcoding to RDoc::Encoding#read_file. Address Rub...
drbrain authored
936
c7907cc @drbrain Set release date
drbrain authored
937 === 3.5.2 / 2010-02-04
3422133 @drbrain Fix AnyMethod#markup_code to use === not ==
drbrain authored
938
431baa1 @drbrain Use an anchor that will be constant across multiple RDoc runs
drbrain authored
939 * Deprecations
940 * RDoc::Context::Section#sequence is now deprecated. Use
941 RDoc::Context::Section#aref instead.
942
3422133 @drbrain Fix AnyMethod#markup_code to use === not ==
drbrain authored
943 * Bug fixes
944 * Fixed syntax highlighting CSS class generation. Reported by Daniel
945 Bretoi.
1c2df99 @drbrain Test and History update for pull request 15
drbrain authored
946 * Fixed ri for methods with aliases. Pull Request #15 by Sven Riedel.
68185c9 @drbrain Create unreadable file by opening and deleting a file
drbrain authored
947 * Added windows-specific test for test_check_files.
9c21a2f @drbrain Support sections in Darkfish
drbrain authored
948 * Darkfish now supports sections. Template and generator author see
949 RDoc::Context#each_section to add section support. RubyForge Bug #26883
950 by Jeff Hodges.
a7037ca @drbrain Fix post-install message and required ruby version
drbrain authored
951 * Fixed post-install message for Ruby 1.9.2 users.
952 * Set required ruby version to >= 1.8.7.
3422133 @drbrain Fix AnyMethod#markup_code to use === not ==
drbrain authored
953
5095483 @drbrain Forgot to set date
drbrain authored
954 === 3.5.1 / 2010-01-30
23ea7cd @drbrain Ensure an RDoc::Stats is created even when there are no files
drbrain authored
955
956 * Bug fixes
957 * Fixed some typos. Pull request #13 by R.T. Lechow.
958 * Ensure an RDoc::Stats is created in #parse_files. Fixes documentation for
959 railties which has no files. Reported by Aaron Patterson
960
289f76d @drbrain Set release date
drbrain authored
961 === 3.5 / 2010-01-29
14c80df @drbrain Record location of module alias
drbrain authored
962
c43e6ab @drbrain Look for rb_call_seq in C method bodies.
drbrain authored
963 * Minor enhancements
964 * RDoc::Parser::C looks for rb_scan_args and fills in RDoc::AnyMethod#params
965 appropriately. This may provide useful information if the author did not
966 provide a call-seq.
082758f @drbrain Record C implementation function for methods, make find_body more robust...
drbrain authored
967 * RDoc::Parser::C now records the function name for methods implemented in
968 C.
0f88031 @drbrain Fixed further locations where output encoding was not preserved. Bug #1...
drbrain authored
969 * RDoc now records file and byte offset information for methods.
14c80df @drbrain Record location of module alias
drbrain authored
970 * Bug fixes
971 * Locations of module aliases are now recorded.
082758f @drbrain Record C implementation function for methods, make find_body more robust...
drbrain authored
972 * RDoc::Parser::C finds method bodies better now.
0f88031 @drbrain Fixed further locations where output encoding was not preserved. Bug #1...
drbrain authored
973 * Fixed further locations where output encoding was not preserved. Bug #11
c87fc13 @drbrain Work around possible ruby bug in String#gsub!
drbrain authored
974 by Vít Ondruch, RubyForge bug #28791 by Dzmitry Prakapenka.
ff60db2 @drbrain Fix display of numeric lists on file and index pages
drbrain authored
975 * Fixed display of numeric lists on the index page and file pages. Bug #12
976 by tobijk.
a686911 @drbrain Apply ruby r30453 by Usaku Nakamura.
drbrain authored
977 * Skip TestRDocOptions#test_check_files on windows until a windows-specific
978 test can be created. RubyForge bug #28821 by Usaku Nakamura.
0d16de3 @drbrain Fix line-height for method descriptions. RubyForge bug #27770
drbrain authored
979 * Fixed line-height of headings in method and alias descriptions. RubyForge
980 Bug #2770 by Adam Avilla
9a97f62 @drbrain Restore earlier behavior of -- to stop comments. Bug #7
drbrain authored
981 * Relaxed RDoc::Parser::Ruby#remove_private_comments to consume more dashes
982 as older versions once did. Bug #7 by Claus Folke Brobak.
14c80df @drbrain Record location of module alias
drbrain authored
983
ff60db2 @drbrain Fix display of numeric lists on file and index pages
drbrain authored
984 === 3.4 / 2010-01-06
2eee4b8 @drbrain Fix warnings and skip encoding tests for 1.8
drbrain authored
985
43a7725 @drbrain RDoc::RDoc#document now takes an RDoc::Options
drbrain authored
986 * Minor enhancements
987 * RDoc::RDoc#document may now be called with an RDoc::Options instance.
2eee4b8 @drbrain Fix warnings and skip encoding tests for 1.8
drbrain authored
988 * Bug fixes
989 * Added skips to Encoding tests running on 1.8.
990 * Fixed warnings
991
992 === 3.3 / 2010-01-03
e800790 @drbrain First pass at coverage report for method parameters
drbrain authored
993
994 * Minor enhancements
09ddb2b @drbrain Fix for 1.8's regexps
drbrain authored
995 * The coverage report can now report undocumented method parameters
996 including methods defined in C.
997
e800790 @drbrain First pass at coverage report for method parameters
drbrain authored
998 <kbd>rdoc -C</kbd> gives a standard report, <kbd>rdoc -C1</kbd> includes
999 method parameters. Method parameters are considered documented if they're
1000 marked-up with <tt>+</tt>, <tt><code></tt> or <code><tt></code>.
5ed8ded @drbrain Use *args instead of ... for unknown args
drbrain authored
1001 * The C parser now uses <tt>*args</tt> instead of <tt>...</tt> if no
1002 <tt>call-seq</tt> was provided to give names to the arguments.
6c980a3 @drbrain Update history for call-seq darkfish fix
drbrain authored
1003 * Bug fixes
5ed8ded @drbrain Use *args instead of ... for unknown args
drbrain authored
1004 * The C parser now records the file location of aliases, attributes,
1005 constants and methods allowing -C to work on C files.
b8c6035 @drbrain Fix typos in History
drbrain authored
1006 * Darkfish now handles dots in call-seq allowing <tt>ary.insert(index,
6c980a3 @drbrain Update history for call-seq darkfish fix
drbrain authored
1007 obj...)</tt> to display correctly. Patch #6 by KUBO Takehiro.
e9b89fe @drbrain Improve processing of meta-programmed methods followed by unparseable sy...
drbrain authored
1008 * Improved processing of meta-programmed methods when followed by unparseable
1009 syntax. RubyForge patch #28653 by Aidan Cully.
76fb2b7 @drbrain Touch the flag file at directory creation time to prevent error after rd...
drbrain authored
1010 * rdoc now touches the flag file when it create the output directory.
1011 Prevents the "isn't an RDoc directory" error if rdoc crashes.
0ffd797 @drbrain Use #gsub with block to preserve encoding. Fixes RubyForge bug #28791
drbrain authored
1012 * RDoc now properly converts to the expected output encoding. RubyForge bug
1013 #28791 by Dzmitry Prakapenka.
9d52f7d @drbrain Don't distinguish between block and hash comments. RubyForge bug #28668
drbrain authored
1014 * Restored parsing of block comments. RubyForge bug #28668 by Stefano Crocco.
6b10e45 @drbrain Process block following meta-method. RubyForge bug #28370
drbrain authored
1015 * Metaprogrammed methods defined with blocks no longer confuse the ruby
1016 parser. RubyForge bug #28370 by Erik Hollensbe.
c5abcbd @drbrain Filter ri method list. This is probably not the best solution
drbrain authored
1017 * ri no longer displays all methods in the inheritance chain.
e800790 @drbrain First pass at coverage report for method parameters
drbrain authored
1018
b360808 @drbrain Set release date
drbrain authored
1019 === 3.2 / 2010-12-29
dc6c300 @drbrain Allow suppression of created.rid. For rdoc-tags
drbrain authored
1020
1021 * Minor enhancements
1022 * RDoc generator authors may now suppress updating the output dir (creating
1023 a created.rid file) by setting RDoc::Options#update_output_dir to false.
55e2933 @drbrain Refactor RDoc::Task so RDoc::TagsTask can reuse it better
drbrain authored
1024 * RDoc::Task has been refactored to ease creating subclasses.
2d8a466 @drbrain Note Shane's contribution to .gitignore
drbrain authored
1025 * Bug fixes
1026 * RDoc's gitignore now ignores .DS_Store files. Pull Request #3 by Shane
1027 Becker.
dc6c300 @drbrain Allow suppression of created.rid. For rdoc-tags
drbrain authored
1028
2d1a47f @drbrain Set release date
drbrain authored
1029 === 3.1 / 2010-12-28
aaf8e4a @drbrain String encoding comment to avoid making it the file comment. Bug #22113
drbrain authored
1030
de51885 @drbrain Reference the correct version in History.txt
drbrain authored
1031 RDoc has moved to github. Releases after 3.1 reference github unless
a02cf40 @drbrain Complete test for pull request 1
drbrain authored
1032 otherwise noted.
1033
a8099cf @drbrain Update test to not require rdoc/options.
drbrain authored
1034 * Minor enhancements
1035 * RDoc::Task now features a #generator option to choose an alternate
1036 generator. Pull Request #2 by Erik Hollensbe.
4c897e6 @drbrain Lex negative numbers correctly. RubyForge patch #28538
drbrain authored
1037 * Enhanced test for RDoc::Parser::binary? RubyForge patch #28538 by Eito
1038 Katagiri.
0e147ef @drbrain Improve generator handling in options
drbrain authored
1039 * Generator list in --help is no longer static. Generator description comes
1040 from the generator's DESCRIPTION constant.
fd3cfbb @drbrain Use dynamic widths in the rdoc summary
drbrain authored
1041 * Documentation summary is now displayed with dynamic width.
2010f72 @drbrain Process ghost methods/attributes if otherwise unconsumed. RF Bug#22793
drbrain authored
1042 * Bug fixes
a02cf40 @drbrain Complete test for pull request 1
drbrain authored
1043 * Strip encoding comment from input to avoid overriding file comment.
1044 RubyForge Bug #22113 by James Gray.
a2d42ac @drbrain Restore call-seq parsing behavior. Bug #26290
drbrain authored
1045 * Restore call-seq parsing behavior when the call-seq is the only comment.
a02cf40 @drbrain Complete test for pull request 1
drbrain authored
1046 RubyForge Bug #26290 by Sylvain Joyeux.
1047 * Coverage report no longer crashes for constant aliases. Pull Request #1
1048 by Andy Lindeman.
b8c6035 @drbrain Fix typos in History
drbrain authored
1049 * RDoc no longer loses ghost methods when followed by certain tokens.
2010f72 @drbrain Process ghost methods/attributes if otherwise unconsumed. RF Bug#22793
drbrain authored
1050 RubyForge bug #27793 by Aaron Patterson.
7eb6246 @drbrain Don't crash if HOME is not set
drbrain authored
1051 * RDoc no longer crashes in ri if HOME is not set. Ruby Bug #4202 by
1052 Shyouhei Urabe.
90eb2f3 @drbrain Rules need weights. RubyForge bug #28675
drbrain authored
1053 * ri no longer crashes with HTML format output. RubyForge bug #28675 by
1054 7rans.
585a6d6 @drbrain Initialize @from_path. RubyForge bug #27838
drbrain authored
1055 * RDoc::Markup::ToHtml#gen_url now initializes #from_path to ''.
1056 Additionally, #from_path is now settable. RubyForge bug #27838 by Claus
1057 Folke Brobak.
8d03713 @drbrain Fix typo
drbrain authored
1058 * Comments in the C parser are now normalized before being combined.
aae5eff @drbrain Normalize comments before combining. RubyForge patch #28646
drbrain authored
1059 RubyForge patch #28646 by Sven Herzberg.
f7ae92a @drbrain Find more C method bodies. RubyForge Patch #28654
drbrain authored
1060 * RDoc::Parser::C no longer requires a comment and finds more method bodies.
1061 RubyForge patch #28643 by Sven Herzberg.
22cf7ab @drbrain Rename to class/module index. RubyForge patch #28364
drbrain authored
1062 * Darkfish now has a "Class/Module Index" instead of a "Class Index".
1063 RubyForge patch #28364 by James Tucker.
4c897e6 @drbrain Lex negative numbers correctly. RubyForge patch #28538
drbrain authored
1064 * RDoc::Parser::Ruby now parses negative numbers correctly. RubyForge patch
1065 #28544 by Eito Katagiri.
aaf8e4a @drbrain String encoding comment to avoid making it the file comment. Bug #22113
drbrain authored
1066
132105f @drbrain There is no Perl parser in RDoc 3 ☹
drbrain authored
1067 === 3.0.1 / 2010-12-19
1068
1069 * Bug fix
1070 * RDoc no longer has a Perl parser.
1071
b04bc9e @drbrain Make 3.0 official
drbrain authored
1072 === 3.0 / 2010-12-19
14b83d9 @drbrain Support Encoding where available
drbrain authored
1073
df4c9b5 @drbrain Update and slightly reorder History
drbrain authored
1074 Special thanks to Thierry Lambert for massive improvements to RDoc.
1075
c52111b @drbrain Added RDoc::Options#dry_run
drbrain authored
1076 * Major enhancements
4036e9a @drbrain Default to Bs formatter when ri is piped.
drbrain authored
1077 * Ruby 1.8.6 is no longer supported by RDoc.
df4c9b5 @drbrain Update and slightly reorder History
drbrain authored
1078 * RDoc now converts input files to a single encoding specified by
1079 <tt>--encoding</tt>. See RDoc::RDoc and RDoc::Options#encoding.
1080 <tt>--encoding</tt> is now preferred over <tt>--charset</tt>
b6df2ff @drbrain Expand RDoc::Context#fully_documented? to include attributes
drbrain authored
1081 * RDoc now supports a <tt>--coverage-report</tt> flag (also <tt>-C</tt> and
1082 <tt>--dcov</tt>) that outputs a report on items lacking documentation.
df4c9b5 @drbrain Update and slightly reorder History
drbrain authored
1083 * Templates (<tt>rdoc -T</tt>) are now checked for existence in
1084 RDoc::Options. Generator authors can now use RDoc::Options#template_dir
1085 which is the full path to the template directory.
1086 * Added support for class aliases. Patch by Thierry Lambert.
54dbcf7 @drbrain Import various improvements from Thierry Lambert. See History.txt.
drbrain authored
1087 * Improved merging of classes and modules across multiple files including
1088 more accurate documentation statistics. Patch by Thierry Lambert.
1089 * Improved handling of method aliases. Patch by Thierry Lambert.
1090 * Improved handling of visibility of RDoc code objects. Patch by Thierry
1091 Lambert.
1092 * RDoc::Attr#type is now RDoc::Attr#definition. Patch by Thierry Lambert.
1093 * Removed TimeConstantMethods
b6df2ff @drbrain Expand RDoc::Context#fully_documented? to include attributes
drbrain authored
1094 * RDoc now calls ::new instead of ::for on generators.
c52111b @drbrain Added RDoc::Options#dry_run
drbrain authored
1095 * Minor enhancements
78cb359 @drbrain Remove --line-numbers, --style. Move HTML-type options to RDoc::Generat...
drbrain authored
1096 * Added rdoc arguments <tt>--dry-run</tt>, <tt>--all</tt>,
1097 <tt>--visibility</tt>, <tt>--force-output</tt>, <tt>--hyperlink-all</tt>.
1098 Patch by Thierry Lambert.
54dbcf7 @drbrain Import various improvements from Thierry Lambert. See History.txt.
drbrain authored
1099 * RDoc::Markup::FormatterTestCase has been expanded. Patch by Thierry
1100 Lambert.
1101 * RDoc::Markup::TextFormatterTestCase has been extracted from RDoc tests.
1102 Patch by Thierry Lambert.
9d76f7e @drbrain Various fixes from Thierry Lambert.
drbrain authored
1103 * Various RDoc::Parser::Ruby enhancements. Patch by Thierry Lambert.
54dbcf7 @drbrain Import various improvements from Thierry Lambert. See History.txt.
drbrain authored
1104 * Various RDoc::Markup::Parser enhancements. Patch by Thierry Lambert.
1105 * RDoc::Parser::binary? is more robust now that it uses Encoding.
1106 * Deprecated rdoc arguments are now explicitly mentioned in rdoc command
1107 output. Patch by Thierry Lambert.
1108 * Constant values are formatted more accurately. Patch by Thierry Lambert.
1109 * Enhanced call-seq parsing in RDoc::Parser::C. Patch by Thierry Lambert.
1110 * RDoc no longer uses kw, cmt, re or str classes for embedded source code
1111 snippets. Patch by Thierry Lambert.
1112 * RDoc directives may now be escaped with a leading '\\'. Patch by Thierry
1113 Lambert.
1114 * RDoc note lists (<tt>label::</tt>) now generate a table with class
f3c05fa @drbrain Remove --style, add some comments
drbrain authored
1115 "rdoc-list". Patch by Thierry Lambert.
54dbcf7 @drbrain Import various improvements from Thierry Lambert. See History.txt.
drbrain authored
1116 * RDoc markup documentation has been moved to RDoc::Markup including notes
1117 on how to document source code.
1118 * An RDoc::Require is now always listed at the file level. Patch by Thierry
1119 Lambert.
8efdd1b @drbrain Move record_location up to RDoc::CodeObject and record locations of alia...
drbrain authored
1120 * RDoc::CodeObjects now know which file they were defined in.
9523f25 @drbrain Call setup_options when --format is given
drbrain authored
1121 * RDoc::Options calls ::setup_options on the generator class specified by
1122 <tt>--format</tt>. See RDoc::Options::setup_generator.
781139d @drbrain Move some generic options out of RDoc::Options. TODO: add an 'html opti...
drbrain authored
1123 * rdoc gives an error when multiple formats are given.
1262785 @drbrain Files with erb inside will no longer trip RDoc::Parser::binary?
drbrain authored
1124 * Files with erb inside will no longer trip RDoc::Parser::binary?
9d76f7e @drbrain Various fixes from Thierry Lambert.
drbrain authored
1125 * Last <tt>--title</tt> wins. Patch by Thierry Lambert.
1126 * Better block params handling. Patch by Thierry Lambert.
3605d42 @drbrain Rename tokenstream and preprocess for consistency
drbrain authored
1127 * Moved rdoc/tokenstream.rb to rdoc/token_stream.rb.
1128 * Moved rdoc/markup/preprocess.rb to rdoc/markup/pre_process.rb.
58c9d78 @drbrain Support documenting methods on nil, false, true. Remove outdated warning
drbrain authored
1129 * Removed "':' not followed by operator or identifier" warning for new Hash
1130 syntax.
0ebac86 @drbrain Support rb_attr in the C parser
drbrain authored
1131 * rb_attr() is now supported for attributes.
28faf3a @drbrain Use common implementation for CodeObject directives
drbrain authored
1132 * RDoc::Parser::C now supports yields, doc, and args directives like
1133 RDoc::Parser::Ruby.
abfd19e @drbrain Move RDoc::Parser::PerlPOD out of RDoc
drbrain authored
1134 * Moved RDoc::Parser::PerlPOD to the rdoc-perl_pod gem.
54dbcf7 @drbrain Import various improvements from Thierry Lambert. See History.txt.
drbrain authored
1135 * Bug fixes
8efdd1b @drbrain Move record_location up to RDoc::CodeObject and record locations of alia...
drbrain authored
1136 * RDoc::Generator tests no longer require any installed RDoc on Ruby 1.9
be78fc0 @drbrain Merge changes from ruby trunk
drbrain authored
1137 * Load existing cache before generating ri. Ruby r27749 by NAKAMURA Usaku.
1138 * RDoc now handles BOM. Ruby r28062 by Nobuyoshi Nakada.
1139 * Use proper XML encoding for darkfish classpage. Ruby r28083 by NARUSE,
1140 Yui.
1141 * Fix ri output when special characters are inside html tags. Patch by Tomo
1142 Kazahaya, Ruby Bug #3512.
1143 * Don't bother checking if the pager exists, it's already done. Ruby r28842
1144 by NAKAMURA Usaku.
1145 * RDoc::Parser::Ruby now ignores non-constant-named singleton classes. Ruby
1146 r29140 by Nobuyoshi Nakada. Ruby Bug #3759.
1147 * RDoc::Parser::Ruby call args no longer include assignment. Ruby r29141 by
1148 Nobuyoshi Nakada. Ruby Bug #3759
1149 * Handle $HOME being unset in ri. Ruby r29272 by Nobuyoshi Nakada.
1150 * uniq ancestors and modules too. Ruby r29312 by Nobuyoshi Nakada.
1151 * RDoc now knows about Encoding by default. Ruby r29356 by Nobuyoshi
1152 Nakada.
781139d @drbrain Move some generic options out of RDoc::Options. TODO: add an 'html opti...
drbrain authored
1153 * ri now defaults to the backspace formatter when piped. Use RI environment
1154 variable or options to override. Ruby r28455 by Yusuke Endoh.
9d76f7e @drbrain Various fixes from Thierry Lambert.
drbrain authored
1155 * __send__ and friends no longer get their underscores removed. Patch by
1156 Thierry Lambert.
301a7ef @drbrain The C parser now makes new public
drbrain authored
1157 * The C parser now makes new public when promoting initialize.
dcbfee5 @drbrain Fix bug in TkUnknownChar that would crash #markup_code
drbrain authored
1158 * Fix crash in #markup_code for TkUnknownChar.
bea8b7d @drbrain Verify template's existence in RDoc::Options. Adds #template_dir for ge...
drbrain authored
1159 * Fix crash in RDoc::Parser::C when aliasing methods with Regexp special
1160 characters.
eb53cb6 @drbrain Fix warning with dynamic use of attr_* for DSTRING and IDENTIFIER
drbrain authored
1161 * Fix crash when various operators are used as a name as in
f173a6d @drbrain Add more operators to get_symbol_or_name
drbrain authored
1162 <tt>alias * compose</tt>.
eb53cb6 @drbrain Fix warning with dynamic use of attr_* for DSTRING and IDENTIFIER
drbrain authored
1163 * Fix warning with some dynamic use of <tt>attr_*</tt>
58c9d78 @drbrain Support documenting methods on nil, false, true. Remove outdated warning
drbrain authored
1164 * Methods added to true, false and nil are now documented.
4d0a313 @drbrain Remove warning for methods on globals variables
drbrain authored
1165 * Remove warning for methods defined on globals.
14b83d9 @drbrain Support Encoding where available
drbrain authored
1166
0323f5d @drbrain Support alias comments in the C parser.
drbrain authored
1167 === 2.5.11 / 2010-08-20
1168
1169 * Minor Enhancements
1170 * Alias comments are now discovered by the C parser. Reported by Jeremy
1171 Evans.
d76fe2b @drbrain Remove unused --all option
drbrain authored
1172 * Removed --all option which is unused in RDoc. Use the nodoc or
1173 stopdoc/startdoc directives to suppress documentation instead.
0323f5d @drbrain Support alias comments in the C parser.
drbrain authored
1174
1e269e6 @drbrain When show_hash is false the wrong side is deleted.
drbrain authored
1175 === 2.5.10 / 2010-08-17
8d6dd97 @drbrain Support rb_singleton_class()
drbrain authored
1176
1177 * Minor Enhancements
1178 * Support rb_singleton_class(). Reported by Jeremy Evans.
8488f98 @drbrain Support rb_define_private_method() on rb_singleton_class().
drbrain authored
1179 * Support rb_define_private_method() on rb_singleton_class(). Reported by
1180 Jeremy Evans.
8d6dd97 @drbrain Support rb_singleton_class()
drbrain authored
1181
5177623 @drbrain Bug #28391
drbrain authored
1182 * Bug Fixes
01d9463 @drbrain Bug #28390
drbrain authored
1183 * Treat non-ASCII RDoc files as text. Bug #28391 by Kouhei Sutou.
1184 * Fix potential test failures due to ivar collision. Bug #28390 by Kouhei
1185 Sutou.
36ddd47 @drbrain Bug #28375
drbrain authored
1186 * Added duck-typed #aref for RDoc::Attr to RDoc::AnyMethod. Bug #28375 by
1187 Erik Hollensbe
1e269e6 @drbrain When show_hash is false the wrong side is deleted.
drbrain authored
1188 * Fixed method references in HTML output when show_hash is false.
b9a2a15 @drbrain Test for call-seq with dots
drbrain authored
1189 * Fixed comments with '.' in call-seq in C sources. Reported by Jeremy
1190 Evans.
2b3df00 @drbrain Teach RDoc about aliases of signletons
drbrain authored
1191 * RDoc now understands singleton aliases. Reported by Jeremy Evans.
5177623 @drbrain Bug #28391
drbrain authored
1192
48ad17a @drbrain Fixed handling of bullets in verbatim sections
drbrain authored
1193 === 2.5.9 / 2010-07-06
894615f @drbrain Look up pager correctly
drbrain authored
1194
1195 * Bug Fixes
1196 * Look up pager correctly.
48ad17a @drbrain Fixed handling of bullets in verbatim sections
drbrain authored
1197 * Fixed handling of bullets in verbatim sections. Partial patch by
1198 Juha-Jarmo Heinonen.
894615f @drbrain Look up pager correctly
drbrain authored
1199
faf6524 @drbrain Don't complain about nonexistent pagers
drbrain authored
1200 === 2.5.8 / 2010-04-27
be4e216 @drbrain Fix param_seq, marshal params for RDoc::AnyMethod
drbrain authored
1201
1202 *NOTE*:
1203
1204 RDoc 2.5 did not save method parameters, so you should upgrade your rdoc-data
9941aab @drbrain Ignore options correctly
drbrain authored
1205 gem to a version >= 2.5.3.
be4e216 @drbrain Fix param_seq, marshal params for RDoc::AnyMethod
drbrain authored
1206
1207 To have ri data for core and stdlib you'll need to:
1208
1209 gem install rdoc-data
1210
1211 then run:
1212
1213 rdoc-data --install
1214
1215 To have ri data for you gems you'll also need to run:
1216
1217 gem rdoc --all --overwrite
1218
1219 If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
1220
faf6524 @drbrain Don't complain about nonexistent pagers
drbrain authored
1221 * Bug Fixes
1222 * ri no longer complains about nonexistent pagers.
1223 * Fixed failing test
1224
1225 === 2.5.7 / 2010-04-22
1226
2b43f87 @drbrain Turn unrecognized directives into metadata
drbrain authored
1227 * Minor Enhancements
ca91dfd @drbrain Better handling of arbitrary directives, including help for plugin autho...
drbrain authored
1228 * Unrecognized RDoc directives can now be registered by a plugin for
1229 handling. See RDoc::Markup::PreProcess.
4a21236 @drbrain Added RDoc::Markup::Raw
drbrain authored
1230 * Added RDoc::Markup::Raw to allow other markup engines to dump raw content
1231 into RDoc.
64e619e @drbrain -p should not mean --pipe if files are given (for --promiscuous)
drbrain authored
1232 * Bug Fixes
1233 * rdoc -p no longer means --pipe if files are also given.
febc877 @drbrain Add BasicObject. Ruby bug #1318
drbrain authored
1234 * RDoc now knows about BasicObject by default. Ruby Bug #1318 by Ambrus Zsbán
ca91dfd @drbrain Better handling of arbitrary directives, including help for plugin autho...
drbrain authored
1235
1236 === 2.5.6 / 2010-04-22
1237
1238 * Minor Enhancements
2b43f87 @drbrain Turn unrecognized directives into metadata
drbrain authored
1239 * Unrecognized RDoc directives are added as metadata to the object they get
1240 attached to.
1241
1242 ##
1243 # :my_new_directive: my cool value
1244
1245 Results in a 'my_new_directive' metadata key with value 'my cool value' on
1246 the RDoc::CodeObject it is for
1247 * Bug Fixes
07deadf @drbrain Don't print 'invalid options' when there are none
drbrain authored
1248 * RDoc no longer prints out "invalid options:" when there were no invalid
1249 options.
fb32e5c @drbrain Fix link size
drbrain authored
1250 * Fixed link size on Darkfish file pages
07deadf @drbrain Don't print 'invalid options' when there are none
drbrain authored
1251
1252 === 2.5.5 / 2010-04-19
1253
9941aab @drbrain Ignore options correctly
drbrain authored
1254 * 1 Minor Enhancement
1255 * Use #binread in RDoc::Markup::PreProcess. Patch from ruby trunk.
1256 * 3 Bug Fixes
848f497 @drbrain Bug #28081
drbrain authored
1257 * Fixed indentation of method-description lists in Darkfish. Bug #28081 by
1258 Theresa Dwinnell.
020abfa @drbrain Bug #28107
drbrain authored
1259 * Fixed loading RDoc::AnyMethod aliases to no longer infinitely loop. Bug
1260 #28107 by Sven Riedel
9941aab @drbrain Ignore options correctly
drbrain authored
1261 * Fixed handling of ignored invalid options to continue after the invalid
1262 option.
72746d6 @drbrain Use binread when determining encoding ourselves
drbrain authored
1263
1264 === 2.5.4 / 2010-04-18
1265
9909e04 @drbrain Finalize release notes
drbrain authored
1266 * 2 Minor Enhancements
51820d5 @drbrain Fixed various typos discovered by rdoc-spellcheck
drbrain authored
1267 * Methods will now be cross-referenced when preceded with ::. Ruby Bug
1297127 @drbrain Ruby bug #3169
drbrain authored
1268 #3169 by Marc-Andre Lafortune.
9990447 @drbrain Ruby bug #3023
drbrain authored
1269 * Methods now have human readable fragment identifiers for HTML output.
1270 (#method-i-gsub vs #M000005). Ruby Bug #3023 by Marc-Andre Lafortune.
9909e04 @drbrain Finalize release notes
drbrain authored
1271 * 1 Bug Fixes
79d2a39 @drbrain Ruby bug #3160
drbrain authored
1272 * RDoc::Parser::Ruby now handles <code>while begin a; b end # ...</code>.
1273 Ruby Bug #3160 by Yusuke Endoh.
1297127 @drbrain Ruby bug #3169
drbrain authored
1274
1275 === 2.5.3 / 2010-04-10
1276
1c59086 @drbrain Fix ruby bug 3121
drbrain authored
1277 * 1 Minor Enhancement
fb396fc @drbrain Remove coding: comment from first line of include
drbrain authored
1278 * RDoc::Parser::Simple and the include directive remove coding: comment from
1279 first line
1297127 @drbrain Ruby bug #3169
drbrain authored
1280 * 2 Bug Fixes
1c59086 @drbrain Fix ruby bug 3121
drbrain authored
1281 * Fixed loading of created.rid when regenerating documentation. Ruby bug
1282 #3121 by Yusuke Endoh.
1a0826b @drbrain Apply r27290 from ruby trunk, add test
drbrain authored
1283 * Compare times as Integers as created.rid doesn't store fractional times.
04d2139 @drbrain Remove coding: comment from first line of
drbrain authored
1284
1285 === 2.5.2 / 2010-04-09
1286
1287 * 1 Minor Enhancement
907966e @drbrain Import Nobu's changes from trunk
drbrain authored
1288 * Imported various changes by Nobu from ruby trunk.
d657894 @drbrain Update
drbrain authored
1289 * 2 Bug Fixes
930c0f4 @drbrain Fix parsing of %{ strings
drbrain authored
1290 * RDoc parses files without extensions as text files again.
1291 * RDoc::Parser::Ruby parses %{ strings correctly again.
1292
1293 === 2.5.1 / 2010-04-06
1294
2ad9039 @drbrain Add support for the include directive to the C parser
drbrain authored
1295 * 1 Minor Enhancement
1296 * RDoc::Parser::C now supports the include directive for classes and
1297 modules.
930c0f4 @drbrain Fix parsing of %{ strings
drbrain authored
1298 * 6 Bug Fixes
be4e216 @drbrain Fix param_seq, marshal params for RDoc::AnyMethod
drbrain authored
1299 * RDoc::AnyMethod params now get saved in ri data.
aa4e516 @drbrain Display method arguments correctly.
drbrain authored
1300 * ri now displays method arguments correctly.
d44121d @drbrain Allow no space between = and header
drbrain authored
1301 * RDoc::Markup::Parser allows no space between = and header text like rdoc
ccf514e @drbrain Fix RDoc::Task's clobbering of the rdoc directory
drbrain authored
1302 2.4 and earlier.
1303 * RDoc::Parser::C's "in" directive now looks in the current directory.
1304 * RDoc::Task's rerdoc task no longer deletes the doc directory twice.
6736ef0 @drbrain Various fixes and changes from ruby trunk by Nobu.
drbrain authored
1305 * rdoc --force-update now works correctly. Patch by Nobu Nokada
be4e216 @drbrain Fix param_seq, marshal params for RDoc::AnyMethod
drbrain authored
1306
3c07e48 @drbrain Arrange History.txt better
drbrain authored
1307 === 2.5 / 2010-03-31
203869f @drbrain Clean up circular requires, allow :attr: to specify attr name
drbrain authored
1308
118df0b @drbrain Final bits for release
drbrain authored
1309 * 9 Major Enhancements
3c07e48 @drbrain Arrange History.txt better
drbrain authored
1310 * Darkfish now has a "Home" button
fd44179 @drbrain Handle inline markup in ToAnsi
drbrain authored
1311 * ri no longer displays the value of a constant. There's no easy way to
1312 make them presentable. Use irb or ruby -e instead. Ruby Bug #549.
3c07e48 @drbrain Arrange History.txt better
drbrain authored
1313 * New ri data format now uses Marshal and pre-builds caches
1314 * No support for old ri data format, too hard to maintain
1315 * To upgrade your core ri documentation, install the rdoc-data gem and run
1316 rdoc-data
1317 * RDoc now displays how well you've documented your library
fcf215f @drbrain Add SIGINFO support to the ri generator
drbrain authored
1318 * New recursive-descent parser for RDoc::Markup. See RDoc::Markup::Parser
00ccb01 @drbrain Fix some problems in RDoc::RubyLex
drbrain authored
1319 * Updated ruby_lex and ruby_token
3c07e48 @drbrain Arrange History.txt better
drbrain authored
1320 * Removed threading support, RDoc is not thread-safe
118df0b @drbrain Final bits for release
drbrain authored
1321 * Removed many unsupported options to rdoc
3c07e48 @drbrain Arrange History.txt better
drbrain authored
1322 * Future versions of RDoc will not support Ruby 1.8.6. Bugs filed for
1323 1.8.6-only issues will be (largely) rejected.
b3601b7 @drbrain Remove constant display from ri output
drbrain authored
1324
166f361 @drbrain Update History.txt
drbrain authored
1325 * 17 Minor Enhancements
3c07e48 @drbrain Arrange History.txt better
drbrain authored
1326 * Source Parsing
d5eebcf @drbrain Fix indent
drbrain authored
1327 * RDoc now supports module aliasing via constant assignment.
1328 * RDoc now tracks superclasses correctly. Fixes File < IO for core docs.
1329 * RDoc now ignores methods inside methods.
1330 * RDoc now ignores Marshal and other binray files.
1331 * Removed "Skipping require of dynamic string" warning.
1332 * C parser now handles Document-method better. Bug #27329.
1333 * API enhancements for writing parsers like the Ruby parser, see
1334 RDoc::Parser::RubyTools
3c07e48 @drbrain Arrange History.txt better
drbrain authored
1335 * ri
1336 * Uses pager over less and more for Debian. Ruby Bug #1171.
1337 * ri will use the RI_PAGER environment variable to find a pager.
1338 * ri data generator now supports SIGINFO (^T)
fcf215f @drbrain Add SIGINFO support to the ri generator
drbrain authored
1339 * When rdoc is in debug mode, ^C now prints a backtrace
fd44179 @drbrain Handle inline markup in ToAnsi
drbrain authored
1340 * RDoc::Markup::AttributeManager no longer uses global state.
40be750 @drbrain Patch #27167
drbrain authored
1341 * RDoc::RDoc no longer passes around options. Patch #27167.
274ee48 @drbrain Patch #25857
drbrain authored
1342 * Darkfish won't generate a file if its template is missing. Patch #25857.
3c07e48 @drbrain Arrange History.txt better
drbrain authored
1343 * Improved some wording for the RDoc main page. Patch #27264, #27268.
aa5a44c @drbrain Update History.txt
drbrain authored
1344 * Removed diagram generation support (to return in the future).
1345 * Removed external support for RDoc::Task.
32fdcde @drbrain Break out some parts of the Ruby parser into the reusable RDoc::Parser::...
drbrain authored
1346
166f361 @drbrain Update History.txt
drbrain authored
1347 * 12 Bug Fixes
203869f @drbrain Clean up circular requires, allow :attr: to specify attr name
drbrain authored
1348 * The :attr: directives now use the name given to create an attribute. See
1349 RDoc::Parser::Ruby#parse_meta_attr.
84cfbd5 @drbrain Handle paths with - in them. Ruby Bug #883
drbrain authored
1350 * Fix crossrefs on paths with '-'. Ruby Bug #883.
f3806cf @drbrain Fix alias with =. Bug #27522
drbrain authored
1351 * Fix ruby parser for alias with = in the name. Bug #27522.
4f377b8 @drbrain Bug #27054, Bug #26910
drbrain authored
1352 * Images are no longer executable. Bug #27156.
1353 * --op is no longer overridden by --ri. Bug #27054.
1354 * :method: now works when at the end of a class. Bug #26910.
51820d5 @drbrain Fixed various typos discovered by rdoc-spellcheck
drbrain authored
1355 * Preserve ellipsis from call-seq in Darkfish. Patch #26974.
44f60a8 @drbrain Patch #27388 + tests
drbrain authored
1356 * Emacs-style <tt>coding:</tt> is handled properly. Patch #27388.
3c07e48 @drbrain Arrange History.txt better
drbrain authored
1357 * RDoc::RubyLex now parses UTF-8 identifiers. Bug #26946, #26947.
ef2bfb8 @drbrain Update History for Bug #26161
drbrain authored
1358 * Fixed namespace lookup rules. Bug #26161.
3164bf8 @drbrain Work around Selenium bug with a .jar in a .txt file
drbrain authored
1359 * Worked around bug in Selenium where they hide a .jar in a .txt file.
1360 Filed Selenium bug #27789.
4cb5da2 @drbrain Don't hide alias comments
drbrain authored
1361 * Alias comments are no longer hidden. Reported by Adam Avilla.
203869f @drbrain Clean up circular requires, allow :attr: to specify attr name
drbrain authored
1362
8af329e @drbrain 2.4.3
drbrain authored
1363 === 2.4.3 / 2009-04-01
acb3a5e @drbrain Fix file popups. Patch #24403.
drbrain authored
1364
8af329e @drbrain 2.4.3
drbrain authored
1365 * 2 Bug Fixes
acb3a5e @drbrain Fix file popups. Patch #24403.
drbrain authored
1366 * Corrected patch for file links
1367 * Corrected display of file popup
1368
11a0f94 @drbrain Release 2.4.2
drbrain authored
1369 === 2.4.2 / 2009-03-25
c3ffb9e @drbrain Add --pipe
drbrain authored
1370
11a0f94 @drbrain Release 2.4.2
drbrain authored
1371 * 2 Minor Enhancements
c3ffb9e @drbrain Add --pipe
drbrain authored
1372 * Added --pipe for turning RDoc on stdin into HTML
453633d @drbrain Add RDoc::Task to replace Rake::RDocTask
drbrain authored
1373 * Added rdoc/task.rb containing a replacement for rake/rdoctask.rb. Use
1374 RDoc::Task now instead of Rake::RDocTask.
c3ffb9e @drbrain Add --pipe
drbrain authored
1375
11a0f94 @drbrain Release 2.4.2
drbrain authored
1376 * 10 Bug Fixes
b2af29b @drbrain Fix writing cache file. Bug #24459
drbrain authored
1377 * Writing the ri cache file to the proper directory. Bug #24459 by Lars
1378 Christensen.
f7af52a @drbrain Pathname / Dir interaction on 1.9. Bug #24650
drbrain authored
1379 * Possible fix for Dir::[] and Pathname interaction on 1.9. Bug #24650 by
1380 tiburon.
e78eee1 @drbrain Fix scanning of constants for if/end, etc. pairs. Bug #24609
drbrain authored
1381 * Fixed scanning constants for if/end, etc. pairs. Bug #24609 by Ryan
1382 Davis.
5e1ba6b @drbrain Fix private methods in the C parser. Bug #24599
drbrain authored
1383 * Fixed private methods in the C parser. Bug #24599 by Aaron Patterson.
aabf2b5 @drbrain Fix markup. Bug #24168
drbrain authored
1384 * Fixed display of markup on RDoc main page. Bug #24168 by rhubarb.
20bf721 @drbrain Fix display of \ character. Bug #22112
drbrain authored
1385 * Fixed display of \\ character in documentation proceeding words.
1386 Bug #22112 by James Gray. See RDoc for details.
0f83c48 @drbrain Fix args for corner cases. Bug #21113.
drbrain authored
1387 * Fixed parsing and display of arg params for some corner cases. Bug #21113
1388 by Csiszár Attila.
32a55c5 @drbrain Fix links in File box. Patch #24403
drbrain authored
1389 * Fixed links in Files box. Patch #24403 by Eric Wong.
069d355 @drbrain Add toplevel methods to Object. Bug #22677
drbrain authored
1390 * Toplevel methods now appear in Object. Bug #22677 by Ryan Davis.
187c5e1 @drbrain Make --promiscuous bitch
drbrain authored
1391 * Added back --promiscuous which didn't do anything you cared about. Why
1392 did you enable it? Nobody looked at that page! Oh, it warns, too.
b2af29b @drbrain Fix writing cache file. Bug #24459
drbrain authored
1393
ad8d95a @drbrain Finish History.txt
drbrain authored
1394 === 2.4.1 / 2009-02-26
6d89db2 @drbrain Don't complain on normal exit
drbrain authored
1395
ad8d95a @drbrain Finish History.txt
drbrain authored
1396 * 1 Minor Enhancements
efbba99 @drbrain Add :attr*: directives to the ruby parser.
drbrain authored
1397 * Added :attr:, :attr_reader:, :attr_writer:, :attr_accessor: directives.
ad8d95a @drbrain Finish History.txt
drbrain authored
1398 Replaces --accessor. See RDoc::Parser::Ruby for details.
efbba99 @drbrain Add :attr*: directives to the ruby parser.
drbrain authored
1399
ad8d95a @drbrain Finish History.txt
drbrain authored
1400 * 3 Bug Fixes
6d89db2 @drbrain Don't complain on normal exit
drbrain authored
1401 * Don't complain when exiting normally. Bug by Matt Neuburg.
751018d @drbrain Fix file links
drbrain authored
1402 * Restore --inline-source that warns
1403 * Fixed links to files in Darkfish output
6d89db2 @drbrain Don't complain on normal exit
drbrain authored
1404
e823862 @drbrain Fix history, darkfish
drbrain authored
1405 === 2.4.0 / 2009-02-24
f1ba94e @drbrain Make the ri -f html XHTML-happy
drbrain authored
1406
e823862 @drbrain Fix history, darkfish
drbrain authored
1407 * 9 Minor Enhancements
8e1b3ca @drbrain Add -T support for Darkfish
drbrain authored
1408 * `ri -f html` is now XHTML-happy
26eb39d @drbrain Bug #23815, #23517
drbrain authored
1409 * Clarified RDoc::Markup link syntax. Bug #23517 by Eric Armstrong.
8e1b3ca @drbrain Add -T support for Darkfish
drbrain authored
1410 * Number of threads to parse with is now configurable
1411 * Darkfish can now use alternate templates from $LOAD_PATH via -T
b338663 @drbrain History, markup and autotest
drbrain authored
1412 * Removed F95 parser in favor of the rdoc-f95 gem
1413 * Moved HTML and XML generators to unmaintained
1414 * No gem will be provided as it's too difficult to make them work
e9ea1ca @drbrain Fix a superclass bug
drbrain authored
1415 * Removed options --one-file, --style=, --inline-source, --promiscuous,
1416 --op-name
b338663 @drbrain History, markup and autotest
drbrain authored
1417 * Removed support for --accessor, use regular documentation or
1418 the method directive instead. See RDoc::Parser::Ruby
1419 * Removed --ri-system as it is unused by Ruby's makefiles
b74df1e @drbrain Workaround bug #23751. Ensure rake runs w/o rdoc installed.
drbrain authored
1420 * Added method list to index.html
f1ba94e @drbrain Make the ri -f html XHTML-happy
drbrain authored
1421
e823862 @drbrain Fix history, darkfish
drbrain authored
1422 * 6 Bug Fixes
51820d5 @drbrain Fixed various typos discovered by rdoc-spellcheck
drbrain authored
1423 * A class marked nodoc no longer appears in the index. Bug #23751 by
1424 Clifford Heath.
26eb39d @drbrain Bug #23815, #23517
drbrain authored
1425 * Fix 1.9 compatibility issues. Bug #23815 by paddor.
b338663 @drbrain History, markup and autotest
drbrain authored
1426 * Darkfish now respects --charset
b74df1e @drbrain Workaround bug #23751. Ensure rake runs w/o rdoc installed.
drbrain authored
1427 * RDoc no longer attempts to be lazy when building HTML. This is a
1428 workaround. Bug #23893 by Stefano Crocco.
67b3bb2 @drbrain Fix bug with def (blah).foo end
drbrain authored
1429 * RDoc doesn't crash with def (blah).foo() end
382b08b @drbrain Fix bug with #define methods in the C parser
drbrain authored
1430 * RDoc doesn't crash with #define functions
c976cde @drbrain Fix nodoc. Bug #23751
drbrain authored
1431
f6b5a04 @drbrain Update to final Darkfish
drbrain authored
1432 === 2.3.0 / 2009-01-28
e2f95ae @DesigningPatterns Added a space after the commas in ri class method lists.
DesigningPatterns authored
1433
f6b5a04 @drbrain Update to final Darkfish
drbrain authored
1434 * 3 Major Enhancements
1435 * Michael Granger's Darkfish generator is now the default for HTML output
fc1c656 @drbrain Improved ri --interactive
drbrain authored
1436 * Various rdoc generation speedups by Hongli Lai. Patches #22555, #22556,
1437 #22557, #22562, #22565.
f6b5a04 @drbrain Update to final Darkfish
drbrain authored
1438 * rdoc/discover.rb files are loaded automatically from installed gems
e2f95ae @DesigningPatterns Added a space after the commas in ri class method lists.
DesigningPatterns authored
1439
f6b5a04 @drbrain Update to final Darkfish
drbrain authored
1440 * 8 Minor Enhancements
735ede7 @drbrain Add autodiscovery of extensions via rdoc/discover.rb in third-party gems
drbrain authored
1441 * Added a space after the commas in ri class method lists. RubyForge
1442 enhancement #22182.
fc1c656 @drbrain Improved ri --interactive
drbrain authored
1443 * Improved ri --interactive
d9a6c18 @drbrain Fix ri location information for gem, one line per class on ri output
drbrain authored
1444 * Generators can now override generated file locations
1445 * Moved unmaintained CHM generator to it's own package
1446 * Moved unmaintained extra HTML templates to their own package
1447 * Removed experimental texinfo generator
1448 * Converted to minitest
1449 * Known classes and modules list outputs once per line now for grep
e2f95ae @DesigningPatterns Added a space after the commas in ri class method lists.
DesigningPatterns authored
1450
f6b5a04 @drbrain Update to final Darkfish
drbrain authored
1451 * 11 Bug Fixes
a872e2b @drbrain Don't include C comment in token stream
drbrain authored
1452 * Fix missing superclass in ri output
1453 * Fix an RDoc crash when told to parse an empty file
1454 * Ignore nonexistent files instead of crashing
a672ec7 @drbrain Patch #22897 - Always treat .txt, .rdoc files as text
drbrain authored
1455 * .txt and .rdoc files are always considered text. Patch #22897 by Aaron
1456 Patterson.
51820d5 @drbrain Fixed various typos discovered by rdoc-spellcheck
drbrain authored
1457 * When merging ri data with a nonexistent directory, RDoc no longer crashes
a151170 @drbrain Fix visibility of private methods
drbrain authored
1458 * Fix visibility of methods in XML output. Issue by Yehuda Katz.
a872e2b @drbrain Don't include C comment in token stream
drbrain authored
1459 * Fixed relative link generation
b55defb @drbrain Fix crasher, RDoc now ignores comments above local variable assignment
drbrain authored
1460 * Fix crash, RDoc now ignores comments above local variable assignments in
a872e2b @drbrain Don't include C comment in token stream
drbrain authored
1461 modules
a2008fc @drbrain Only grab adjacent comments when looking for class comments
drbrain authored
1462 * RDoc now only accepts adjacent comments for rb_define_module and
1463 rb_define_class
a872e2b @drbrain Don't include C comment in token stream
drbrain authored
1464 * C file RDoc is no longer included in token stream
d9a6c18 @drbrain Fix ri location information for gem, one line per class on ri output
drbrain authored
1465 * Scan all gem paths to match gem name for ri output
735ede7 @drbrain Add autodiscovery of extensions via rdoc/discover.rb in third-party gems
drbrain authored
1466
87d60f3 @DesigningPatterns Update History.txt for the release.
DesigningPatterns authored
1467 === 2.2.1 / 2008-09-24
c659960 @DesigningPatterns Make the html template explicitly set its text color.
DesigningPatterns authored
1468 This version provides some minor fixes and enhancements to 2.2.0 intended
1469 to polish RDoc for Ruby 1.9.1.
d5379b2 @DesigningPatterns Prepare the trunk for version 2.2.1.
DesigningPatterns authored
1470
87d60f3 @DesigningPatterns Update History.txt for the release.
DesigningPatterns authored
1471 * 3 Minor Enhancements
05ce9d4 @drbrain C parser/SWIG improvements, ruby bugs #10742 #13993 #11993
drbrain authored
1472 * Support for parsing RDoc from SWIG. Ruby patch #10742 by Gonzalo
1473 Garramuno, #13993 by Steven Jenkins.
6322537 @drbrain Hugh Sasse's patch adding simple Perl/POD support.
drbrain authored
1474 * Simple support for Perl POD documentation. Patch by Hugh Sasse.
6426a2d @DesigningPatterns Change the default character set of RDoc's output to utf-8.
DesigningPatterns authored
1475 * Changed the default character set of RDoc's output from iso-8859-1 to
1476 utf-8.
d5379b2