rdoc 4.0.1 → 4.1.0.preview.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25425cbd40fc0fb6688babd542c72e35da9c1af1
-  data.tar.gz: ce7517ea48d04c18235cb6b6555167247bc3c380
+  metadata.gz: 63a8392d312b7021635d3ca1f8b767fdeb703578
+  data.tar.gz: 9d8b4adcb0c60f3157d6b9fb41cdcfc4c8912ef1
 SHA512:
-  metadata.gz: 0931f21823f76e532d0a0628a66435a73968b9a4287077f758ed3a3863fd7dc3ef585fcc9d2042166aacf3299693aeb884e5509b924c7eafb362514e22ca3ca0
-  data.tar.gz: f4edd9434deb4657edf3da618757eb70339eb661288ee513b43f341b63ab372e5b6add88795f3d39f09e5a3cad5d13326c3c4073a5e25474c27c0c78fd74ea46
+  metadata.gz: fbe17dd9ed231a22d9252f70d7f057cded0a482d7a2ca1fcd1423e22b2aa74613fb95253df0d362f38af8cd1747e477106cddaf0de85a48074c1e472e9a7d605
+  data.tar.gz: ee95d4887bff5955cc1fb3a976833871045dd0e5ece158124ff8cf8428a2e681f3c2cb58896b5e20461d933c55751f3a5d62d8362fb3aca517818201248c76d0

data/.autotest

@@ -1,13 +1,11 @@
 require 'autotest/restart'
 
 Autotest.add_hook :run_command do |at|
-  at.unit_diff = 'cat'
-
   system "#{Gem.ruby} -rubygems #{Gem.bin_path 'rake', 'rake'} generate"
 end
 
 Autotest.add_hook :initialize do |at|
-  at.testlib = 'minitest/autorun'
+  at.testlib = ''
   at.add_exception '.git'
 
   def at.path_to_classname s

data/{DEVELOPERS.rdoc → CONTRIBUTING.rdoc}

@@ -10,13 +10,38 @@ classes for each feature.
 If you think you found a bug, file a ticket on the {issues
 tracker}[https://github.com/rdoc/rdoc/issues] on github.
 
-To get your bug fixed as fast as possible please include a sample file that
-illustrates the problem or link to a repository and include steps to reproduce
-the issue.  Here are some examples of good issues:
+If your bug involves an error RDoc produced please include a sample file that
+illustrates the problem or link to the repository or gem that is associated
+with the bug.
+
+Please include steps to reproduce the issue.  Here are some examples of good
+issues:
 
 * https://github.com/rdoc/rdoc/issues/55
 * https://github.com/rdoc/rdoc/issues/61
 
+== Developer Quick Start
+
+RDoc uses hoe for development.  To get ready to work on RDoc run:
+
+  $ gem install hoe
+  [...]
+  $ rake
+  [...]
+
+This will install all the necessary dependencies for development with rake,
+generate documentation and run the tests for the first time.
+
+If the tests don't pass on the first run check the {Travis CI page for
+RDoc}[https://travis-ci.org/rdoc/rdoc] to see if there are any known failures
+(there shouldn't be).
+
+You can now use `rake` and `autotest` to run the tests.
+
+Note: the `rake` command must be used first before running any tests, because
+its used to generate various parsers implemented in RDoc. Also `rake clean` is
+helpful to delete these generated files.
+
 == Glossary
 
 Here are definitions for some common terms in the RDoc documentation.  The

data/ExampleMarkdown.md

@@ -0,0 +1,37 @@
+This document contains example output to show RDoc styling.  This file was
+created from a Markdown file.
+
+For the following styles, see ExampleRDoc.rdoc for style examples:
+
+* Headings
+* Paragraphs
+* Code blocks (verbatim sections)
+* Definition lists
+* Ordered lists
+* Unordered lists
+
+These items all use the same styles as RDoc format files.
+
+## Footnotes
+
+Footnotes are rendered at the bottom of the documentation section[^1].  For
+pages this will be at the bottom of the page.  For method documentation this
+will be at the end of the current method.
+
+[^1]: Here is the footnote content.  As you can see it is at the bottom of the
+page.
+
+## Blockquotes
+
+Here is how a blockquote looks.
+
+> We finished our first sensor sweep of the neutral zone. Now, how the hell do
+> we defeat an enemy that knows us better than we know ourselves? and attack
+> the Romulans.
+>
+> > Sorry, Data. I guess it's better to be lucky than good. The unexpected is
+> > our normal routine. Could someone survive inside a transporter buffer for
+> > 75 years?
+
+This text is from [Riker Ipsum](http://rikeripsum.com)
+

data/ExampleRDoc.rdoc

@@ -0,0 +1,208 @@
+This document contains example output to show RDoc styling.  This file was
+created from a RDoc Markup file.
+
+== Headings
+
+You should not use headings beyond level 3, it is a sign of poor organization
+of your code or documentation.  It also becomes difficult for the user to
+figure out what you are attempting to explain to them as they have to track
+the multiple layers of nesting.
+
+= Heading level 1
+
+Above is a level one heading.
+
+These paragraphs are filler that exist so you can see how the heading
+interacts with paragraphs before and after the heading.  As you can see each
+different heading has a different amount of margin above and below.
+
+This should be sufficient to give you a proper picture of how it will appear in
+your documentation.
+
+== Heading level 2
+
+Above is a level two heading.
+
+These paragraphs are filler that exist so you can see how the heading
+interacts with paragraphs before and after the heading.  As you can see each
+different heading has a different amount of margin above and below.
+
+This should be sufficient to give you a proper picture of how it will appear in
+your documentation.
+
+=== Heading level 3
+
+Above is a level three heading.
+
+These paragraphs are filler that exist so you can see how the heading
+interacts with paragraphs before and after the heading.  As you can see each
+different heading has a different amount of margin above and below.
+
+This should be sufficient to give you a proper picture of how it will appear in
+your documentation.
+
+==== Heading level 4
+
+Above is a level four heading.
+
+These paragraphs are filler that exist so you can see how the heading
+interacts with paragraphs before and after the heading.  As you can see each
+different heading has a different amount of margin above and below.
+
+This should be sufficient to give you a proper picture of how it will appear in
+your documentation.
+
+===== Heading level 5
+
+Above is a level five heading.
+
+These paragraphs are filler that exist so you can see how the heading
+interacts with paragraphs before and after the heading.  As you can see each
+different heading has a different amount of margin above and below.
+
+This should be sufficient to give you a proper picture of how it will appear in
+your documentation.
+
+====== Heading level 6
+
+Above is a level six heading.
+
+These paragraphs are filler that exist so you can see how the heading
+interacts with paragraphs before and after the heading.  As you can see each
+different heading has a different amount of margin above and below.
+
+This should be sufficient to give you a proper picture of how it will appear in
+your documentation.
+
+== Paragraphs
+
+This is how a paragraph looks.  Since it is difficult to generate good content
+for paragraphs I have chosen to use {Riker Ipsum}[http://rikeripsum.com] for
+nonsense filler content.  In the previous sentence you can see how a link is
+formatted.
+
+Here is an example of *bold* and _emphasis_ styling.  Try not to combine the
+two or use them too often.  Here is an example of <code>inline verbatim
+text</code>.  That should be enough of a taste of inline markup in paragraphs.
+The Riker Ipsum filler follows:
+
+Shields up! Rrrrred alert! Well, I'll say this for him - he's sure of himself.
+and attack the Romulans. Worf, It's better than music. It's jazz. This should
+be interesting. When has justice ever been as simple as a rule book? Flair is
+what marks the difference between artistry and mere competence.
+
+Sorry, Data. I think you've let your personal feelings cloud your judgement. We
+finished our first sensor sweep of the neutral zone. Yes, absolutely, I do
+indeed concur, wholeheartedly! Mr. Worf, you do remember how to fire phasers? A
+lot of things can change in twelve years, Admiral. Your shields were failing,
+sir.
+
+== Verbatim sections
+
+A verbatim section typically contains source code or example output.  This is
+how verbatim blocks of code looks:
+
+  def local responder
+    responder.ping do |value|
+      return value
+    end
+  end
+  
+  def ping uri
+    @uri = uri
+    @remote = DRb::DRbObject.new_with_uri @uri
+  
+    @remote.ping do |value|
+      return value
+    end
+  end
+
+This is a paragraph following the verbatim block so you can see how leading and trailing paragraphs interact with it.
+
+== Unordered lists
+
+Here is an unordered list.  As you can see it uses non-numeral markers for each list item:
+
+* This is the top-most item in the list.
+* This is a second item in the list.
+
+  Unlike the first item, this item has more than one paragraph so you can see
+  how they interact.
+* This is a third item in the list.  Like the item before it, this item has a
+  second paragraph.
+
+  Here is the second paragraph in the list item.
+* A final list item.
+
+== Ordered lists
+
+Here is an ordered list.  As you can see it uses numeral markers for each list
+item:
+
+1. This is the first item in the list.
+1. This is the second item in the list.
+
+   Unlike the first item, this item has more than one paragraph so you can see
+   how they interact.
+1. This is the third item in the list.  Like the item before it, this item has
+   a second paragraph.
+
+   Here is the second paragraph in the third list item.
+1. The fourth and final list item.
+
+== Definition lists
+
+=== "Note" list
+
+The "note" syntax can be used to create a definition list:
+
+  note::
+    description
+
+Here is such a definition list:
+
+cat::
+  A cat is a small mammal that is commonly kept as a pet.
+
+dog::
+  A dog is a mammal that is also kept as a pet.  A dog may range in size from
+  smaller than a cat to larger than a human.
+
+  Typically dogs are easier to train to respond to commands than cats.
+
+rabbit::
+  Rabbits are also mammals, but are infrequently kept as pets.  Most rabbits
+  are wild.
+
+=== "Label" list
+
+The "label" syntax can be used to create a definition list:
+
+  [label]
+    description
+
+Here is such a definition list:
+
+[cat]
+  A cat is a small mammal that is commonly kept as a pet.
+
+[dog]
+  A dog is a mammal that is also kept as a pet.  A dog may range in size from
+  smaller than a cat to larger than a human.
+
+  Typically dogs are easier to train to respond to commands than cats.
+
+[rabbit]
+  Rabbits are also mammals, but are infrequently kept as pets.  Most rabbits
+  are wild.
+
+== Rule
+
+A rule is a horizontal divider between two paragraphs.  Following this
+paragraph is a rule.
+
+---
+
+In historic versions of RDoc you could control the height of the rule in HTML
+output.  This is no longer true as HTML 5 does not support this.
+

data/History.rdoc

@@ -1,3 +1,84 @@
+=== 4.1.0.preview.3 / 2012-12-02
+
+* Minor enhancements
+  * RDoc can now link to [], []=, << and >> methods.  Pull request #202 by
+    Jeremy Evans, Bug # 191 by by Zachary Scott.
+  * Added RDoc::Options#output_decoration which controls header labels for
+    HTML output.  Pull Request #199 by Zachary Scott.
+  * Added --template-stylesheets options to RDoc to allow specification of
+    alternate stylesheets.  Pull request #205 by Zachary Scott.
+  * Improved performance of the Markdown and RD parsers.  Pull request #217 by
+    Ryan Davis.
+  * <code>rdoc -v</code> now prints the version instead of enabling verbose
+    mode.  Pull request #201 by Lee Jarvis.
+  * Running <code>rake newb</code> now automatically installs development
+    dependencies if the parser files haven't been built.  Pull request #235 by
+    Kouhei Sutou.
+  * Moved old DEVELOPERS file to CONTRIBUTING to match github conventions.
+  * TomDoc output now has a "Returns" heading.  Issue #234 by Brian Henderson
+  * Metaprogrammed methods can now use the :args: directive in addition to the
+    :call-seq: durective.  Issue #236 by Mike Moore.
+  * Sections can be linked to using "@" like labels.  If a section and a label
+    have the same name the section will be preferred.  Issue #233 by Brian
+    Henderson.
+  * Files that come with a template are hard-linked to save space.  Issue #186
+    by Vít Ondruch.
+
+* Bug fixes
+  * Restored behavior of --no-pager alias -T.  Pull request #223 by ruafozy.
+  * Fixed extra whitespace output in the rdoc coverage report.  Bug #210 by
+    Ryan Davis.
+  * RDoc no longer documents its timestamp file when run on an empty
+    directory.  Bug #212 by Rainer Keller
+  * HTML escape method names in the table of contents.  Bug #219 by Akinori
+    MUSHA.
+  * Character literals <code>?h</code> now create a new token type to prevent
+    loss of the "?" in output.  Bug #220 by Vipul A M.
+  * When looking up a method that does not exist, ri escapes the regular
+    expression for fallback searches.  Bug #227 by Aaron Patterson.
+  * The ri generator now writes the class method data after +module_function+.
+    Bug #222 by Zachary Scott, Ruby bug #8225 by David Unric.
+  * ri now handles missing ri data files.  Bug #222 by Zachary Scott, Ruby bug
+    #8225 by David Unric.
+  * Added TomDoc to the supported markup formats section of rdoc --help.
+    Bug #214 by Ryan Davis.
+  * Fixed documented? check for classes which indicated incorrect 100%
+    coverage.  Bug #211 by Ryan Davis.
+  * RDoc ignores constants discovered in passing in class and method bodies.
+    Bug #209 by Ryan Davis.
+  * An :enddoc: at the top level stops all further parsing.  Bug #213 by Ryan
+    Davis.
+  * Improved handling of multiline call-seq.  Bug #207 by Erik Hollensbe.
+  * Fixed text that is missing whitespace for TomDoc.  Bug #248 by Noel Cower.
+  * The RDoc methods now store the method they are aliased to.  Bug #206 by
+    Jeremy Stephens.
+  * Fixed parsing of multiple methods on the same line.  Bug #221 by derula.
+  * Fixed missing support for images in markdown.  Bug #241, pull request #242
+    by Zachary Scott.
+  * The markdown image fix also added support for images via an rdoc-image:
+    scheme.  See RDoc::Markup@Links for details.  Issue #93 by Tim Pease.
+  * Ignore empty call-seq for methods.  Improved deduplication of C methods
+    sharing the same C function.  This allows the method heading to show
+    up correctly for String#== and #===.  Bug #244 by Neurogami.
+  * RDoc no longer adds "http://" to urls without a scheme.  Bug #208 by
+    Zachary Scott.
+  * Improved the error message in the RDoc server when ri data is missing.
+    Bug #243, Pull Request #249 by Tadas Tamošauskas.
+  * Support ruby 2.0 hash syntax for keywords.  Bug #256 by diogocsc.
+  * Prevent \\<tag> from escaping the tag in RDoc markup.  (\<tag> still
+    escapes the tag.)  Bug #251 by Pablo Bianciotto.
+  * Fixed lexing of escaped characters in strings which could cause
+    duplication of the final characters in source code view.  Bug #252 by Mike
+    Stok.
+  * Disallow invalid tab widths for -w option.  Bug reported by Charles
+    Hixson.
+  * rb_file_const() now adds constants to File::Constants when used outside
+    file.c.  Fixes missing File::Constants::FNM_* constants in ruby.
+  * Fixed handling of :markup: when the file parser is unknown.  Issue #262 by
+    Brian Henderson, pull request #269 by Rein Henrichs.
+  * Regexp options are no longer stripped in HTML output.  Bug #259 by Zachary
+    Scott, Pull request #265 by Rein Henrichs
+
 === 4.0.1 / 2013-03-27
 
 * Bug fixes

data/Manifest.txt

@@ -1,7 +1,9 @@
 .autotest
 .document
+CONTRIBUTING.rdoc
 CVE-2013-0256.rdoc
-DEVELOPERS.rdoc
+ExampleMarkdown.md
+ExampleRDoc.rdoc
 History.rdoc
 LEGAL.rdoc
 LICENSE.rdoc
@@ -52,6 +54,13 @@ lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
 lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
 lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml
 lib/rdoc/generator/template/darkfish/class.rhtml
+lib/rdoc/generator/template/darkfish/fonts.css
+lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf
+lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf
+lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf
+lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf
+lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf
+lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf
 lib/rdoc/generator/template/darkfish/images/add.png
 lib/rdoc/generator/template/darkfish/images/arrow_up.png
 lib/rdoc/generator/template/darkfish/images/brick.png
@@ -138,6 +147,7 @@ lib/rdoc/markup/to_tt_only.rb
 lib/rdoc/markup/verbatim.rb
 lib/rdoc/meta_method.rb
 lib/rdoc/method_attr.rb
+lib/rdoc/mixin.rb
 lib/rdoc/normal_class.rb
 lib/rdoc/normal_module.rb
 lib/rdoc/options.rb
@@ -208,7 +218,6 @@ test/test.ja.largedoc
 test/test.ja.rdoc
 test/test.ja.txt
 test/test.txt
-test/test_attribute_manager.rb
 test/test_rdoc_alias.rb
 test/test_rdoc_any_method.rb
 test/test_rdoc_attr.rb

data/README.rdoc

@@ -3,7 +3,7 @@
 home :: https://github.com/rdoc/rdoc
 rdoc :: http://docs.seattlerb.org/rdoc
 bugs :: https://github.com/rdoc/rdoc/issues
-code quality :: {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/rdoc/rdoc]
+code quality :: {<img src="https://codeclimate.com/badge.png" alt="code climate">}[https://codeclimate.com/github/rdoc/rdoc]
 
 == Description
 
@@ -108,10 +108,10 @@ names in the documentation coverage report.
 
 == Bugs
 
-See DEVELOPERS@Bugs for information on filing a bug report.  It's OK to file a
-bug report for anything you're having a problem with.  If you can't figure out
-how to make RDoc produce the output you like that is probably a documentation
-bug.
+See CONTRIBUTING@Bugs for information on filing a bug report.  It's OK to file
+a bug report for anything you're having a problem with.  If you can't figure
+out how to make RDoc produce the output you like that is probably a
+documentation bug.
 
 == License