Permalink
Browse files

2.4.3

  • Loading branch information...
drbrain committed Apr 1, 2009
1 parent ad8d95a commit 9b7c6ca4305832c89bcb4b57f9a8d9543c0965ee
View
@@ -1,3 +1,34 @@
+=== 2.4.3 / 2009-04-01
+
+* 2 Bug Fixes
+ * Corrected patch for file links
+ * Corrected display of file popup
+
+=== 2.4.2 / 2009-03-25
+
+* 2 Minor Enhancements
+ * Added --pipe for turning RDoc on stdin into HTML
+ * Added rdoc/task.rb containing a replacement for rake/rdoctask.rb. Use
+ RDoc::Task now instead of Rake::RDocTask.
+
+* 10 Bug Fixes
+ * Writing the ri cache file to the proper directory. Bug #24459 by Lars
+ Christensen.
+ * Possible fix for Dir::[] and Pathname interaction on 1.9. Bug #24650 by
+ tiburon.
+ * Fixed scanning constants for if/end, etc. pairs. Bug #24609 by Ryan
+ Davis.
+ * Fixed private methods in the C parser. Bug #24599 by Aaron Patterson.
+ * Fixed display of markup on RDoc main page. Bug #24168 by rhubarb.
+ * Fixed display of \\ character in documentation proceeding words.
+ Bug #22112 by James Gray. See RDoc for details.
+ * Fixed parsing and display of arg params for some corner cases. Bug #21113
+ by Csiszár Attila.
+ * Fixed links in Files box. Patch #24403 by Eric Wong.
+ * Toplevel methods now appear in Object. Bug #22677 by Ryan Davis.
+ * Added back --promiscuous which didn't do anything you cared about. Why
+ did you enable it? Nobody looked at that page! Oh, it warns, too.
+
=== 2.4.1 / 2009-02-26
* 1 Minor Enhancements
View
@@ -92,6 +92,7 @@ lib/rdoc/ri/util.rb
lib/rdoc/ri/writer.rb
lib/rdoc/single_class.rb
lib/rdoc/stats.rb
+lib/rdoc/task.rb
lib/rdoc/tokenstream.rb
lib/rdoc/top_level.rb
test/binary.dat
@@ -119,6 +120,7 @@ test/test_rdoc_ri_driver.rb
test/test_rdoc_ri_formatter.rb
test/test_rdoc_ri_html_formatter.rb
test/test_rdoc_ri_overstrike_formatter.rb
+test/test_rdoc_task.rb
test/test_rdoc_top_level.rb
test/xref_data.rb
test/xref_test_case.rb
View
@@ -11,9 +11,11 @@ Hoe.new "rdoc", RDoc::VERSION do |rdoc|
rdoc.developer 'Phil Hagelberg', 'technomancy@gmail.com'
rdoc.developer 'Tony Strauss', 'tony.strauss@designingpatterns.com'
rdoc.remote_rdoc_dir = ''
+ rdoc.testlib = :minitest
rdoc.extra_dev_deps << ['minitest', '~> 1.3']
rdoc.spec_extras['required_rubygems_version'] = '>= 1.3'
+ rdoc.spec_extras['homepage'] = 'http://rdoc.rubyforge.org'
end
# These tasks expect to have the following directory structure:
View
@@ -61,6 +61,7 @@
# recursively for C and Ruby source files only.
#
# == \Options
+#
# rdoc can be passed a variety of command-line options. In addition,
# options can be specified via the +RDOCOPT+ environment variable, which
# functions similarly to the +RUBYOPT+ environment variable.
@@ -70,28 +71,15 @@
# will make rdoc default to inline method source code. Command-line options
# always will override those in +RDOCOPT+.
#
-# Run
+# Run:
#
-# % rdoc --help
+# rdoc --help
#
# for full details on rdoc's options.
#
-# Here are some of the most commonly used options.
-# [-d, --diagram]
-# Generate diagrams showing modules and
-# classes. You need dot V1.8.6 or later to
-# use the --diagram option correctly. Dot is
-# available from http://graphviz.org
-#
-# [-S, --inline-source]
-# Show method source code inline, rather than via a popup link.
-#
-# [-T, --template=NAME]
-# Set the template used when generating output.
-#
# == Documenting Source Code
#
-# Comment blocks can be written fairly naturally, either using +#+ on
+# Comment blocks can be written fairly naturally, either using <tt>#</tt> on
# successive lines of the comment, or by including the comment in
# a =begin/=end block. If you use the latter form, the =begin line must be
# flagged with an RDoc tag:
@@ -150,6 +138,11 @@
# +:yields:+ is an example of a documentation directive. These appear
# immediately after the start of the document element they are modifying.
#
+# RDoc automatically cross-references words with underscores or camel-case.
+# To suppress cross-references, prefix the word with a \\ character. To
+# include special characters like "\\n", you'll need to use two \\
+# characters like "\\\\\\n".
+#
# == \Markup
#
# * The markup engine looks for a document's natural left margin. This is
@@ -216,17 +209,17 @@
#
# Word-based markup uses flag characters around individual words:
#
-# [\*word*] displays word in a *bold* font
-# [\_word_] displays word in an _emphasized_ font
-# [\+word+] displays word in a +code+ font
+# [<tt>\*word*</tt>] displays word in a *bold* font
+# [<tt>\_word_</tt>] displays word in an _emphasized_ font
+# [<tt>\+word+</tt>] displays word in a +code+ font
#
# General markup affects text between a start delimiter and and end
# delimiter. Not surprisingly, these delimiters look like HTML markup.
#
-# [\<b>text...</b>] displays word in a *bold* font
-# [\<em>text...</em>] displays word in an _emphasized_ font
-# [\<i>text...</i>] displays word in an <i>italicized</i> font
-# [\<tt>text...</tt>] displays word in a +code+ font
+# [<tt>\<b>text...</b></tt>] displays word in a *bold* font
+# [<tt>\<em>text...</em></tt>] displays word in an _emphasized_ font
+# [<tt>\<i>text...</i></tt>] displays word in an <i>italicized</i> font
+# [<tt>\<tt>text...\</tt></tt>] displays word in a +code+ font
#
# Unlike conventional Wiki markup, general markup can cross line
# boundaries. You can turn off the interpretation of markup by
@@ -382,7 +375,7 @@ class Error < RuntimeError; end
##
# RDoc version you are using
- VERSION = "2.4.1"
+ VERSION = '2.4.3'
##
# Name of the dotfile that contains the description of files to be processed
View
@@ -361,7 +361,7 @@ def add_include(include)
def add_method(method)
method.visibility = @visibility
- add_to(@method_list, method)
+ add_to @method_list, method
unmatched_alias_list = @unmatched_alias_lists[method.name]
if unmatched_alias_list then
@@ -155,7 +155,7 @@ def write_style_sheet
FileUtils.cp @template_dir + 'rdoc.css', '.', options
- Dir[@template_dir + "{js,images}/**/*"].each do |path|
+ Dir[(@template_dir + "{js,images}/**/*").to_s].each do |path|
next if File.directory? path
next if path =~ /#{File::SEPARATOR}\./
@@ -28,7 +28,7 @@
<div class="section-body">
<ul>
<% klass.in_files.each do |tl| %>
- <li><a href="<%= rel_prefix %>/<%= h tl.absolute_name %>.html?TB_iframe=true&amp;height=550&amp;width=785"
+ <li><a href="<%= rel_prefix %>/<%= h tl.path %>?TB_iframe=true&amp;height=550&amp;width=785"
class="thickbox" title="<%= h tl.absolute_name %>"><%= h tl.absolute_name %></a></li>
<% end %>
</ul>
@@ -22,7 +22,7 @@
<% if file.parser == RDoc::Parser::Simple %>
<body class="file">
- <div id="metadata">
+ <div id="metadata">
<div id="project-metadata">
<% simple_files = @files.select { |f| f.parser == RDoc::Parser::Simple } %>
<% unless simple_files.empty? then %>
@@ -98,7 +98,9 @@
href="<%= file.cvs_url %>"><%= file.cvs_url %></a></dd>
<% end %>
</dl>
+ </div>
+ <div id="documentation">
<% if file.comment %>
<div class="description">
<h2>Description</h2>
@@ -227,7 +227,7 @@ def flow(str)
unmask_protected_sequences
- return split_into_flow
+ split_into_flow
end
##
@@ -304,7 +304,7 @@ def split_into_flow
# and reset to all attributes off
res << change_attribute(current_attr, 0) if current_attr != 0
- return res
+ res
end
end
@@ -121,7 +121,9 @@ def handle_special_CROSSREF(special)
ref = @context.find_symbol lookup unless ref
- out = if lookup =~ /^\\/ then
+ out = if lookup == '\\' then
+ lookup
+ elsif lookup =~ /^\\/ then
$'
elsif ref and ref.document_self then
"<a href=\"#{ref.as_href(@from_path)}\">#{name}</a>"
Oops, something went wrong.

0 comments on commit 9b7c6ca

Please sign in to comment.