rdoc 6.6.3.1 → 6.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CONTRIBUTING.rdoc +1 -1
- data/ExampleMarkdown.md +2 -0
- data/ExampleRDoc.rdoc +2 -0
- data/History.rdoc +64 -62
- data/LICENSE.rdoc +2 -0
- data/README.rdoc +13 -0
- data/RI.md +842 -0
- data/TODO.rdoc +8 -7
- data/lib/rdoc/{alias.rb → code_object/alias.rb} +1 -1
- data/lib/rdoc/{class_module.rb → code_object/class_module.rb} +54 -0
- data/lib/rdoc/{context.rb → code_object/context.rb} +1 -1
- data/lib/rdoc/{method_attr.rb → code_object/method_attr.rb} +3 -3
- data/lib/rdoc/{top_level.rb → code_object/top_level.rb} +4 -4
- data/lib/rdoc/code_object.rb +6 -0
- data/lib/rdoc/generator/darkfish.rb +45 -3
- data/lib/rdoc/generator/pot/message_extractor.rb +1 -1
- data/lib/rdoc/generator/pot/po_entry.rb +1 -1
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +23 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +20 -11
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +3 -8
- data/lib/rdoc/generator/template/darkfish/class.rhtml +69 -43
- data/lib/rdoc/generator/template/darkfish/css/rdoc.css +367 -392
- data/lib/rdoc/generator/template/darkfish/index.rhtml +7 -6
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +18 -1
- data/lib/rdoc/generator/template/darkfish/page.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +10 -8
- data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +5 -2
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +11 -0
- data/lib/rdoc/markdown.kpeg +3 -3
- data/lib/rdoc/markdown.rb +25 -15
- data/lib/rdoc/markup/attribute_manager.rb +2 -2
- data/lib/rdoc/markup/pre_process.rb +9 -6
- data/lib/rdoc/markup/to_bs.rb +26 -1
- data/lib/rdoc/markup/to_html_crossref.rb +12 -13
- data/lib/rdoc/markup/to_markdown.rb +4 -4
- data/lib/rdoc/markup/to_rdoc.rb +15 -7
- data/lib/rdoc/markup.rb +18 -13
- data/lib/rdoc/options.rb +23 -5
- data/lib/rdoc/parser/c.rb +19 -9
- data/lib/rdoc/parser/changelog.rb +2 -2
- data/lib/rdoc/parser/ripper_state_lex.rb +7 -305
- data/lib/rdoc/parser/ruby.rb +26 -8
- data/lib/rdoc/parser.rb +6 -3
- data/lib/rdoc/rd/block_parser.rb +3 -7
- data/lib/rdoc/rd/inline_parser.rb +3 -7
- data/lib/rdoc/rdoc.rb +3 -2
- data/lib/rdoc/ri/driver.rb +11 -7
- data/lib/rdoc/task.rb +2 -3
- data/lib/rdoc/tom_doc.rb +1 -7
- data/lib/rdoc/version.rb +1 -1
- data/lib/rdoc.rb +23 -23
- metadata +27 -24
- data/RI.rdoc +0 -57
- /data/lib/rdoc/{anon_class.rb → code_object/anon_class.rb} +0 -0
- /data/lib/rdoc/{any_method.rb → code_object/any_method.rb} +0 -0
- /data/lib/rdoc/{attr.rb → code_object/attr.rb} +0 -0
- /data/lib/rdoc/{constant.rb → code_object/constant.rb} +0 -0
- /data/lib/rdoc/{context → code_object/context}/section.rb +0 -0
- /data/lib/rdoc/{extend.rb → code_object/extend.rb} +0 -0
- /data/lib/rdoc/{ghost_method.rb → code_object/ghost_method.rb} +0 -0
- /data/lib/rdoc/{include.rb → code_object/include.rb} +0 -0
- /data/lib/rdoc/{meta_method.rb → code_object/meta_method.rb} +0 -0
- /data/lib/rdoc/{mixin.rb → code_object/mixin.rb} +0 -0
- /data/lib/rdoc/{normal_class.rb → code_object/normal_class.rb} +0 -0
- /data/lib/rdoc/{normal_module.rb → code_object/normal_module.rb} +0 -0
- /data/lib/rdoc/{require.rb → code_object/require.rb} +0 -0
- /data/lib/rdoc/{single_class.rb → code_object/single_class.rb} +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8d8ca4bcc05f2aa35186aeb69b5894bcda2940029f2fdadaf1a3076940cb28d0
|
4
|
+
data.tar.gz: 414df07a4fe4f895bd3d9d347dfd33652d70b0018f894c75d5f2fd25972b9e46
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a8b23c1147cfd8ff7b67c34cdfe639714babf6a95302be285146b21cee8caa822c96f2ec80930ba8db1637d2001aeec7f8ea0d18b8b7319676fca3f4a0d1ccd3
|
7
|
+
data.tar.gz: 3ecaf85a188b9960142f929dfe3231747e266526d08060e176dde99d6e45a3a56a4dd97a6e45524af98604f5fe628a331179e8a4b249fc1b5219584d3e40e907
|
data/CONTRIBUTING.rdoc
CHANGED
@@ -40,7 +40,7 @@ If the tests don't pass on the first run check the {GitHub Actions page}[https:/
|
|
40
40
|
You can now use `rake` and `autotest` to run the tests.
|
41
41
|
|
42
42
|
Note: the `rake` command must be used first before running any tests, because
|
43
|
-
|
43
|
+
it's used to generate various parsers implemented in RDoc. Also `rake clean` is
|
44
44
|
helpful to delete these generated files.
|
45
45
|
|
46
46
|
== Glossary
|
data/ExampleMarkdown.md
CHANGED
data/ExampleRDoc.rdoc
CHANGED
data/History.rdoc
CHANGED
@@ -1,4 +1,6 @@
|
|
1
|
-
|
1
|
+
= History
|
2
|
+
|
3
|
+
== 5.1.0 / 2017-02-24
|
2
4
|
|
3
5
|
* Bug fixes
|
4
6
|
* Fix an issue that rdoc fails when running on Windows with RUBYOPT=-U.
|
@@ -8,7 +10,7 @@
|
|
8
10
|
* Parse ruby 2.1 <visibility> def. PR #436 by Akira Matsuda.
|
9
11
|
* Suppress warnings in eval. PR #440 by Nobuyoshi Nakada.
|
10
12
|
|
11
|
-
|
13
|
+
== 5.0.0 / 2016-11-05
|
12
14
|
|
13
15
|
* Major enhancements
|
14
16
|
* Cleanup deprecated code targeted Ruby 1.8
|
@@ -25,19 +27,19 @@
|
|
25
27
|
* Improve class name expansion/resolution in ri. PR #400 by NARUSE, Yui
|
26
28
|
* Improve performance of document generation. PR #397 by Yusuke Endoh.
|
27
29
|
|
28
|
-
|
30
|
+
== 4.3.0 / 2016-11-04
|
29
31
|
|
30
32
|
* Minor enhancements
|
31
33
|
* Removed json dependency for Ruby 2.4.0
|
32
34
|
* End to support Ruby 1.8.x
|
33
35
|
|
34
|
-
|
36
|
+
== 4.2.2 / 2016-02-09
|
35
37
|
|
36
38
|
* Bug fixes
|
37
39
|
* Include lib/rdoc/generator/pot/* in built gem
|
38
40
|
|
39
41
|
|
40
|
-
|
42
|
+
== 4.2.1 / 2015-12-22
|
41
43
|
|
42
44
|
* Bug fixes
|
43
45
|
* Fixed infinite loop with CR #339 by @nobu
|
@@ -47,7 +49,7 @@
|
|
47
49
|
* Fix for valid syntax `class C end` parsing #368 by @nobu
|
48
50
|
|
49
51
|
|
50
|
-
|
52
|
+
== 4.2.0 / 2014-12-06
|
51
53
|
|
52
54
|
* Major enhancements
|
53
55
|
* RDoc can now produce translation files for use with gettext. See
|
@@ -116,12 +118,12 @@
|
|
116
118
|
#312 by Scott Thompson.
|
117
119
|
* Fixed RegExp matching stack overflow on Ruby 1.8.7. Issue #327 by sshao.
|
118
120
|
|
119
|
-
|
121
|
+
== 4.1.2 / 2014-09-05
|
120
122
|
|
121
123
|
* Bug fixes
|
122
124
|
* Updated vendored jQuery to 1.6.4. Bug ruby/ruby#711 by @neuralme
|
123
125
|
|
124
|
-
|
126
|
+
== 4.1.1 / 2014-01-09
|
125
127
|
|
126
128
|
* Bug fixes
|
127
129
|
* Fixed reporting of undocumented method parameters when including when
|
@@ -132,7 +134,7 @@
|
|
132
134
|
* Removed duplicated condition in superclass fixup. Pull request #282 by
|
133
135
|
Benoit Daloze.
|
134
136
|
|
135
|
-
|
137
|
+
== 4.1.0 / 2013-12-26
|
136
138
|
|
137
139
|
* Notable changes
|
138
140
|
* Improved accessibility of HTML output. Accessibility review was provided
|
@@ -222,7 +224,7 @@
|
|
222
224
|
* Regexp options are no longer stripped in HTML output. Bug #259 by Zachary
|
223
225
|
Scott, Pull request #265 by Rein Henrichs
|
224
226
|
|
225
|
-
|
227
|
+
== 4.0.1 / 2013-03-27
|
226
228
|
|
227
229
|
* Bug fixes
|
228
230
|
* RDoc::Options parser should rescue from OptionParser::ParseError.
|
@@ -252,7 +254,7 @@
|
|
252
254
|
* The C parser now de-duplicates call-seq if the same C function is used for
|
253
255
|
multiple method names. Bug #203 by Pete Higgins
|
254
256
|
|
255
|
-
|
257
|
+
== 4.0.0 / 2013-02-24
|
256
258
|
|
257
259
|
RDoc 4.0 includes several new features and several breaking changes. The
|
258
260
|
changes should not affect users of `rdoc` or `ri`.
|
@@ -380,7 +382,7 @@ Changes since RDoc 3.12.1:
|
|
380
382
|
* RDoc now ignores methods defined on constants instead of creating a fake
|
381
383
|
module. Bug #163 by Zachary Scott.
|
382
384
|
* Fixed ChangeLog parsing for FFI gem. Bug #165 by Zachary Scott.
|
383
|
-
* RDoc now links
|
385
|
+
* RDoc now links \#== methods. Bug #164 by Zachary Scott.
|
384
386
|
* Allow [] following argument names for TomDoc. Bug #167 by Ellis Berner.
|
385
387
|
* Fixed the RDoc servlet for home and site directories. Bug #170 by Thomas
|
386
388
|
Leitner.
|
@@ -455,7 +457,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
455
457
|
* Templates now use the correct encoding when generating pages. Issue #183
|
456
458
|
by Vít Ondruch
|
457
459
|
|
458
|
-
|
460
|
+
== 4.0.0.rc.2 / 2013-02-05
|
459
461
|
|
460
462
|
* Minor enhancements
|
461
463
|
* Added current heading and page-top links to HTML headings.
|
@@ -476,7 +478,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
476
478
|
* RDoc now ignores methods defined on constants instead of creating a fake
|
477
479
|
module. Bug #163 by Zachary Scott.
|
478
480
|
* Fixed ChangeLog parsing for FFI gem. Bug #165 by Zachary Scott.
|
479
|
-
* RDoc now links
|
481
|
+
* RDoc now links \#== methods. Bug #164 by Zachary Scott.
|
480
482
|
* Allow [] following argument names for TomDoc. Bug #167 by Ellis Berner.
|
481
483
|
* Fixed the RDoc servlet for home and site directories. Bug #170 by Thomas
|
482
484
|
Leitner.
|
@@ -487,7 +489,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
487
489
|
* Fixed deletion of attribute ri data when a class was loaded then saved.
|
488
490
|
Issue #171 by Thomas Leitner.
|
489
491
|
|
490
|
-
|
492
|
+
== 4.0.0.preview2.1 / 2012-12-14
|
491
493
|
|
492
494
|
* Minor enhancements
|
493
495
|
* Added --page-dir option to give pretty names for a FAQ, guides, or other
|
@@ -510,7 +512,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
510
512
|
* Incremental ri builds of C files now work. C variable names from previous
|
511
513
|
runs are now saved between runs.
|
512
514
|
|
513
|
-
|
515
|
+
== 4.0.0.preview2 / 2012-12-01
|
514
516
|
|
515
517
|
* Breaking changes
|
516
518
|
* The default output encoding for RDoc is now UTF-8. Previously RDoc used
|
@@ -658,7 +660,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
658
660
|
* Fixed class << ::Foo writing documentation to /Foo.html
|
659
661
|
* Fixed class ::A referencing itself from inside its own namespace.
|
660
662
|
|
661
|
-
|
663
|
+
== 3.12.2 / 2013-02-24
|
662
664
|
|
663
665
|
* Bug fixes
|
664
666
|
* Fixed bug in syntax-highlighting that would corrupt regular expressions.
|
@@ -672,7 +674,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
672
674
|
end. When a HEREDOC is not followed by a line end RDoc is not currently
|
673
675
|
smart enough to restore the source correctly. Bug #162 by Zachary Scott.
|
674
676
|
|
675
|
-
|
677
|
+
== 3.12.1 / 2013-02-05
|
676
678
|
|
677
679
|
* Bug fixes
|
678
680
|
* Fixed an XSS exploit in darkfish.js. This could lead to cookie disclosure
|
@@ -680,7 +682,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
680
682
|
details including a patch you can apply to generated RDoc documentation.
|
681
683
|
* Ensured that rd parser files are generated before checking the manifest.
|
682
684
|
|
683
|
-
|
685
|
+
== 3.12 / 2011-12-15
|
684
686
|
|
685
687
|
* Minor enhancements
|
686
688
|
* Added DEVELOPERS document which contains an overview of how RDoc works and
|
@@ -711,13 +713,13 @@ Changes since RDoc 4.0.0.rc.2:
|
|
711
713
|
* In rdoc, backspace and ansi formatters, whitespace between label or note
|
712
714
|
and the colon is now stripped.
|
713
715
|
|
714
|
-
|
716
|
+
== 3.11 / 2011-10-17
|
715
717
|
|
716
718
|
* Bug fixes
|
717
719
|
* Avoid parsing TAGS files included in gems. Issue #81 by Santiago
|
718
720
|
Pastorino.
|
719
721
|
|
720
|
-
|
722
|
+
== 3.10 / 2011-10-08
|
721
723
|
|
722
724
|
* Major enhancements
|
723
725
|
* RDoc HTML output has been improved:
|
@@ -822,19 +824,19 @@ Changes since RDoc 4.0.0.rc.2:
|
|
822
824
|
parsed. Unless your project includes nonexistent modules this avoids
|
823
825
|
worst-case behavior (<tt>O(n!)</tt>) of RDoc::Include#module.
|
824
826
|
|
825
|
-
|
827
|
+
== 3.9.5 / 2013-02-05
|
826
828
|
|
827
829
|
* Bug fixes
|
828
830
|
* Fixed an XSS exploit in darkfish.js. This could lead to cookie disclosure
|
829
831
|
to third parties. See CVE-2013-0256.rdoc for full details including a
|
830
832
|
patch you can apply to generated RDoc documentation.
|
831
833
|
|
832
|
-
|
834
|
+
== 3.9.4 / 2011-08-26
|
833
835
|
|
834
836
|
* Bug fixes
|
835
837
|
* Applied typo and grammar fixes from Luke Gruber. Ruby bug #5203
|
836
838
|
|
837
|
-
|
839
|
+
== 3.9.3 / 2011-08-23
|
838
840
|
|
839
841
|
* Bug fixes
|
840
842
|
* Add US-ASCII magic comments to work with <tt>ruby -Ku</tt>. Issue #63 by
|
@@ -844,14 +846,14 @@ Changes since RDoc 4.0.0.rc.2:
|
|
844
846
|
* Markup defined by RDoc::Markup#add_special inside a <tt><tt></tt> is no
|
845
847
|
longer converted.
|
846
848
|
|
847
|
-
|
849
|
+
== 3.9.2 / 2011-08-11
|
848
850
|
|
849
851
|
* Bug fix
|
850
852
|
* Loosened TIDYLINK regexp to allow any content in the link section like:
|
851
853
|
<tt>{foo}[rdoc-ref:SomeClass]</tt>
|
852
854
|
* In HTML output headings are capped at <tt><h6></tt> again
|
853
855
|
|
854
|
-
|
856
|
+
== 3.9.1 / 2011-07-31
|
855
857
|
|
856
858
|
* Bug fixes
|
857
859
|
* Fix RDoc::Markup parser for a header followed by a non-text token. Issue
|
@@ -859,7 +861,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
859
861
|
* Fix RDoc::Markup::ToHtmlCrossref#gen_url for non-<tt>rdoc-ref</tt> links.
|
860
862
|
* Fix bug report URL when rdoc crashes.
|
861
863
|
|
862
|
-
|
864
|
+
== 3.9 / 2011-07-30
|
863
865
|
|
864
866
|
* Minor enhancements
|
865
867
|
* RDoc::Parser::C now supports :doc: and :nodoc: for class comments
|
@@ -879,7 +881,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
879
881
|
* Remove tokenizer restriction on header lengths for verbatim sections.
|
880
882
|
Issue #49 by trans
|
881
883
|
|
882
|
-
|
884
|
+
== 3.8 / 2011-06-29
|
883
885
|
|
884
886
|
* Minor enhancements
|
885
887
|
* RDoc::Parser::C can now discover methods on ENV and ARGF.
|
@@ -888,7 +890,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
888
890
|
* Updating Object in an ri data store with new data now removes methods,
|
889
891
|
includes, constants and aliases.
|
890
892
|
|
891
|
-
|
893
|
+
== 3.7 / 2011-06-27
|
892
894
|
|
893
895
|
* Minor enhancements
|
894
896
|
* New directive :category: which allows methods to be grouped into sections
|
@@ -933,7 +935,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
933
935
|
* ri data generation for method aliases no longer duplicates the class in
|
934
936
|
#full_name
|
935
937
|
|
936
|
-
|
938
|
+
== 3.6.1 / 2011-05-15
|
937
939
|
|
938
940
|
* Bug fixes
|
939
941
|
* Fix infinite loop created when re-encountering BasicObject.
|
@@ -941,7 +943,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
941
943
|
* rb_path2class() can now be used to discover the parent class in
|
942
944
|
rb_define_class_under.
|
943
945
|
|
944
|
-
|
946
|
+
== 3.6 / 2011-05-13
|
945
947
|
|
946
948
|
* Major Enhancements
|
947
949
|
* Interactive ri is now the default when no names are given.
|
@@ -966,7 +968,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
966
968
|
* The doc directive now forces documentation even when the method is marked
|
967
969
|
private or protected.
|
968
970
|
|
969
|
-
|
971
|
+
== 3.5.3 / 2010-02-06
|
970
972
|
|
971
973
|
* Bug fixes
|
972
974
|
* When including a file perform a lossy force-transcoding to the output
|
@@ -978,7 +980,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
978
980
|
Bug #4376.
|
979
981
|
* When Darkfish fails the file being generated is now reported.
|
980
982
|
|
981
|
-
|
983
|
+
== 3.5.2 / 2010-02-04
|
982
984
|
|
983
985
|
* Deprecations
|
984
986
|
* RDoc::Context::Section#sequence is now deprecated. Use
|
@@ -995,14 +997,14 @@ Changes since RDoc 4.0.0.rc.2:
|
|
995
997
|
* Fixed post-install message for Ruby 1.9.2 users.
|
996
998
|
* Set required ruby version to >= 1.8.7.
|
997
999
|
|
998
|
-
|
1000
|
+
== 3.5.1 / 2010-01-30
|
999
1001
|
|
1000
1002
|
* Bug fixes
|
1001
1003
|
* Fixed some typos. Pull request #13 by R.T. Lechow.
|
1002
1004
|
* Ensure an RDoc::Stats is created in #parse_files. Fixes documentation for
|
1003
1005
|
railties which has no files. Reported by Aaron Patterson
|
1004
1006
|
|
1005
|
-
|
1007
|
+
== 3.5 / 2010-01-29
|
1006
1008
|
|
1007
1009
|
* Minor enhancements
|
1008
1010
|
* RDoc::Parser::C looks for rb_scan_args and fills in RDoc::AnyMethod#params
|
@@ -1025,7 +1027,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
1025
1027
|
* Relaxed RDoc::Parser::Ruby#remove_private_comments to consume more dashes
|
1026
1028
|
as older versions once did. Bug #7 by Claus Folke Brobak.
|
1027
1029
|
|
1028
|
-
|
1030
|
+
== 3.4 / 2010-01-06
|
1029
1031
|
|
1030
1032
|
* Minor enhancements
|
1031
1033
|
* RDoc::RDoc#document may now be called with an RDoc::Options instance.
|
@@ -1033,7 +1035,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
1033
1035
|
* Added skips to Encoding tests running on 1.8.
|
1034
1036
|
* Fixed warnings
|
1035
1037
|
|
1036
|
-
|
1038
|
+
== 3.3 / 2010-01-03
|
1037
1039
|
|
1038
1040
|
* Minor enhancements
|
1039
1041
|
* The coverage report can now report undocumented method parameters
|
@@ -1060,7 +1062,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
1060
1062
|
parser. RubyForge bug #28370 by Erik Hollensbe.
|
1061
1063
|
* ri no longer displays all methods in the inheritance chain.
|
1062
1064
|
|
1063
|
-
|
1065
|
+
== 3.2 / 2010-12-29
|
1064
1066
|
|
1065
1067
|
* Minor enhancements
|
1066
1068
|
* RDoc generator authors may now suppress updating the output dir (creating
|
@@ -1070,7 +1072,7 @@ Changes since RDoc 4.0.0.rc.2:
|
|
1070
1072
|
* RDoc's gitignore now ignores .DS_Store files. Pull Request #3 by Shane
|
1071
1073
|
Becker.
|
1072
1074
|
|
1073
|
-
|
1075
|
+
== 3.1 / 2010-12-28
|
1074
1076
|
|
1075
1077
|
RDoc has moved to github. Releases after 3.1 reference github unless
|
1076
1078
|
otherwise noted.
|
@@ -1108,12 +1110,12 @@ otherwise noted.
|
|
1108
1110
|
* RDoc::Parser::Ruby now parses negative numbers correctly. RubyForge patch
|
1109
1111
|
#28544 by Eito Katagiri.
|
1110
1112
|
|
1111
|
-
|
1113
|
+
== 3.0.1 / 2010-12-19
|
1112
1114
|
|
1113
1115
|
* Bug fix
|
1114
1116
|
* RDoc no longer has a Perl parser.
|
1115
1117
|
|
1116
|
-
|
1118
|
+
== 3.0 / 2010-12-19
|
1117
1119
|
|
1118
1120
|
Special thanks to Thierry Lambert for massive improvements to RDoc.
|
1119
1121
|
|
@@ -1208,7 +1210,7 @@ Special thanks to Thierry Lambert for massive improvements to RDoc.
|
|
1208
1210
|
* Methods added to true, false and nil are now documented.
|
1209
1211
|
* Remove warning for methods defined on globals.
|
1210
1212
|
|
1211
|
-
|
1213
|
+
== 2.5.11 / 2010-08-20
|
1212
1214
|
|
1213
1215
|
* Minor Enhancements
|
1214
1216
|
* Alias comments are now discovered by the C parser. Reported by Jeremy
|
@@ -1216,7 +1218,7 @@ Special thanks to Thierry Lambert for massive improvements to RDoc.
|
|
1216
1218
|
* Removed --all option which is unused in RDoc. Use the nodoc or
|
1217
1219
|
stopdoc/startdoc directives to suppress documentation instead.
|
1218
1220
|
|
1219
|
-
|
1221
|
+
== 2.5.10 / 2010-08-17
|
1220
1222
|
|
1221
1223
|
* Minor Enhancements
|
1222
1224
|
* Support rb_singleton_class(). Reported by Jeremy Evans.
|
@@ -1234,14 +1236,14 @@ Special thanks to Thierry Lambert for massive improvements to RDoc.
|
|
1234
1236
|
Evans.
|
1235
1237
|
* RDoc now understands singleton aliases. Reported by Jeremy Evans.
|
1236
1238
|
|
1237
|
-
|
1239
|
+
== 2.5.9 / 2010-07-06
|
1238
1240
|
|
1239
1241
|
* Bug Fixes
|
1240
1242
|
* Look up pager correctly.
|
1241
1243
|
* Fixed handling of bullets in verbatim sections. Partial patch by
|
1242
1244
|
Juha-Jarmo Heinonen.
|
1243
1245
|
|
1244
|
-
|
1246
|
+
== 2.5.8 / 2010-04-27
|
1245
1247
|
|
1246
1248
|
*NOTE*:
|
1247
1249
|
|
@@ -1266,7 +1268,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1266
1268
|
* ri no longer complains about nonexistent pagers.
|
1267
1269
|
* Fixed failing test
|
1268
1270
|
|
1269
|
-
|
1271
|
+
== 2.5.7 / 2010-04-22
|
1270
1272
|
|
1271
1273
|
* Minor Enhancements
|
1272
1274
|
* Unrecognized RDoc directives can now be registered by a plugin for
|
@@ -1277,7 +1279,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1277
1279
|
* rdoc -p no longer means --pipe if files are also given.
|
1278
1280
|
* RDoc now knows about BasicObject by default. Ruby Bug #1318 by Ambrus Zsbán
|
1279
1281
|
|
1280
|
-
|
1282
|
+
== 2.5.6 / 2010-04-22
|
1281
1283
|
|
1282
1284
|
* Minor Enhancements
|
1283
1285
|
* Unrecognized RDoc directives are added as metadata to the object they get
|
@@ -1293,7 +1295,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1293
1295
|
options.
|
1294
1296
|
* Fixed link size on Darkfish file pages
|
1295
1297
|
|
1296
|
-
|
1298
|
+
== 2.5.5 / 2010-04-19
|
1297
1299
|
|
1298
1300
|
* 1 Minor Enhancement
|
1299
1301
|
* Use #binread in RDoc::Markup::PreProcess. Patch from ruby trunk.
|
@@ -1305,7 +1307,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1305
1307
|
* Fixed handling of ignored invalid options to continue after the invalid
|
1306
1308
|
option.
|
1307
1309
|
|
1308
|
-
|
1310
|
+
== 2.5.4 / 2010-04-18
|
1309
1311
|
|
1310
1312
|
* 2 Minor Enhancements
|
1311
1313
|
* Methods will now be cross-referenced when preceded with ::. Ruby Bug
|
@@ -1316,7 +1318,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1316
1318
|
* RDoc::Parser::Ruby now handles <code>while begin a; b end # ...</code>.
|
1317
1319
|
Ruby Bug #3160 by Yusuke Endoh.
|
1318
1320
|
|
1319
|
-
|
1321
|
+
== 2.5.3 / 2010-04-10
|
1320
1322
|
|
1321
1323
|
* 1 Minor Enhancement
|
1322
1324
|
* RDoc::Parser::Simple and the include directive remove coding: comment from
|
@@ -1326,7 +1328,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1326
1328
|
#3121 by Yusuke Endoh.
|
1327
1329
|
* Compare times as Integers as created.rid doesn't store fractional times.
|
1328
1330
|
|
1329
|
-
|
1331
|
+
== 2.5.2 / 2010-04-09
|
1330
1332
|
|
1331
1333
|
* 1 Minor Enhancement
|
1332
1334
|
* Imported various changes by Nobu from ruby trunk.
|
@@ -1334,7 +1336,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1334
1336
|
* RDoc parses files without extensions as text files again.
|
1335
1337
|
* RDoc::Parser::Ruby parses %{ strings correctly again.
|
1336
1338
|
|
1337
|
-
|
1339
|
+
== 2.5.1 / 2010-04-06
|
1338
1340
|
|
1339
1341
|
* 1 Minor Enhancement
|
1340
1342
|
* RDoc::Parser::C now supports the include directive for classes and
|
@@ -1348,7 +1350,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1348
1350
|
* RDoc::Task's rerdoc task no longer deletes the doc directory twice.
|
1349
1351
|
* rdoc --force-update now works correctly. Patch by Nobu Nokada
|
1350
1352
|
|
1351
|
-
|
1353
|
+
== 2.5 / 2010-03-31
|
1352
1354
|
|
1353
1355
|
* 9 Major Enhancements
|
1354
1356
|
* Darkfish now has a "Home" button
|
@@ -1404,13 +1406,13 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1404
1406
|
Filed Selenium bug #27789.
|
1405
1407
|
* Alias comments are no longer hidden. Reported by Adam Avilla.
|
1406
1408
|
|
1407
|
-
|
1409
|
+
== 2.4.3 / 2009-04-01
|
1408
1410
|
|
1409
1411
|
* 2 Bug Fixes
|
1410
1412
|
* Corrected patch for file links
|
1411
1413
|
* Corrected display of file popup
|
1412
1414
|
|
1413
|
-
|
1415
|
+
== 2.4.2 / 2009-03-25
|
1414
1416
|
|
1415
1417
|
* 2 Minor Enhancements
|
1416
1418
|
* Added --pipe for turning RDoc on stdin into HTML
|
@@ -1435,7 +1437,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1435
1437
|
* Added back --promiscuous which didn't do anything you cared about. Why
|
1436
1438
|
did you enable it? Nobody looked at that page! Oh, it warns, too.
|
1437
1439
|
|
1438
|
-
|
1440
|
+
== 2.4.1 / 2009-02-26
|
1439
1441
|
|
1440
1442
|
* 1 Minor Enhancements
|
1441
1443
|
* Added :attr:, :attr_reader:, :attr_writer:, :attr_accessor: directives.
|
@@ -1446,7 +1448,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1446
1448
|
* Restore --inline-source that warns
|
1447
1449
|
* Fixed links to files in Darkfish output
|
1448
1450
|
|
1449
|
-
|
1451
|
+
== 2.4.0 / 2009-02-24
|
1450
1452
|
|
1451
1453
|
* 9 Minor Enhancements
|
1452
1454
|
* `ri -f html` is now XHTML-happy
|
@@ -1473,7 +1475,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1473
1475
|
* RDoc doesn't crash with def (blah).foo() end
|
1474
1476
|
* RDoc doesn't crash with #define functions
|
1475
1477
|
|
1476
|
-
|
1478
|
+
== 2.3.0 / 2009-01-28
|
1477
1479
|
|
1478
1480
|
* 3 Major Enhancements
|
1479
1481
|
* Michael Granger's Darkfish generator is now the default for HTML output
|
@@ -1508,7 +1510,7 @@ If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
|
|
1508
1510
|
* C file RDoc is no longer included in token stream
|
1509
1511
|
* Scan all gem paths to match gem name for ri output
|
1510
1512
|
|
1511
|
-
|
1513
|
+
== 2.2.1 / 2008-09-24
|
1512
1514
|
This version provides some minor fixes and enhancements to 2.2.0 intended
|
1513
1515
|
to polish RDoc for Ruby 1.9.1.
|
1514
1516
|
|
@@ -1540,7 +1542,7 @@ to polish RDoc for Ruby 1.9.1.
|
|
1540
1542
|
* Fixed missing display of constant values in ri.
|
1541
1543
|
* Fixed display of constants in ri's html output.
|
1542
1544
|
|
1543
|
-
|
1545
|
+
== 2.2.0 / 2008-09-19
|
1544
1546
|
This version includes some significant enhancements to ri. See RI.txt for
|
1545
1547
|
documentation about ri.
|
1546
1548
|
|
@@ -1621,7 +1623,7 @@ documentation about ri.
|
|
1621
1623
|
* Fixed the horizontal rule markup (---) so that it correctly adds a
|
1622
1624
|
horizontal rule rather than suppressing all text that follows.
|
1623
1625
|
|
1624
|
-
|
1626
|
+
== 2.1.0 / 2008-07-20
|
1625
1627
|
|
1626
1628
|
* 3 Major Enhancements:
|
1627
1629
|
* RDoc now knows about meta-programmed methods, see RDoc::Parser::Ruby
|
@@ -1651,7 +1653,7 @@ documentation about ri.
|
|
1651
1653
|
described in the documentation
|
1652
1654
|
* RDoc now correctly sets superclasses if they were originally unknown
|
1653
1655
|
|
1654
|
-
|
1656
|
+
== 2.0.0 / 2008-04-10
|
1655
1657
|
|
1656
1658
|
* 3 Major Enhancements:
|
1657
1659
|
* Renamespaced everything RDoc under the RDoc module.
|
data/LICENSE.rdoc
CHANGED
data/README.rdoc
CHANGED
@@ -60,6 +60,10 @@ To generate documentation programmatically:
|
|
60
60
|
rdoc.document options
|
61
61
|
# see RDoc::RDoc
|
62
62
|
|
63
|
+
You can specify the target files for document generation with +.document+ file in the project root directory.
|
64
|
+
+.document+ file contains a list of file and directory names including comment lines starting with '#'.
|
65
|
+
See https://github.com/ruby/rdoc/blob/master/.document as an example.
|
66
|
+
|
63
67
|
== Writing Documentation
|
64
68
|
|
65
69
|
To write documentation for RDoc place a comment above the class, module,
|
@@ -106,6 +110,15 @@ To determine how well your project is documented run <tt>rdoc -C lib</tt> to
|
|
106
110
|
get a documentation coverage report. <tt>rdoc -C1 lib</tt> includes parameter
|
107
111
|
names in the documentation coverage report.
|
108
112
|
|
113
|
+
== Theme Options
|
114
|
+
|
115
|
+
There are a few community-maintained themes for \RDoc:
|
116
|
+
|
117
|
+
- rorvswild-theme-rdoc[https://github.com/BaseSecrete/rorvswild-theme-rdoc]
|
118
|
+
- hanna[https://github.com/jeremyevans/hanna] (a fork maintained by {Jeremy Evans}[https://github.com/jeremyevans])
|
119
|
+
|
120
|
+
Please follow the theme's README for usage instructions.
|
121
|
+
|
109
122
|
== Bugs
|
110
123
|
|
111
124
|
See CONTRIBUTING@Bugs for information on filing a bug report. It's OK to file
|