voloko-sdoc 0.1.7 → 0.1.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (99) hide show
  1. data/LICENSE +21 -0
  2. data/VERSION.yml +4 -0
  3. data/lib/sdoc/generator/shtml.rb +1 -4
  4. data/lib/sdoc.rb +0 -1
  5. metadata +32 -101
  6. data/rdoc/History.txt +0 -254
  7. data/rdoc/Manifest.txt +0 -126
  8. data/rdoc/README.txt +0 -47
  9. data/rdoc/RI.txt +0 -58
  10. data/rdoc/Rakefile +0 -70
  11. data/rdoc/bin/rdoc +0 -35
  12. data/rdoc/bin/ri +0 -5
  13. data/rdoc/lib/rdoc/alias.rb +0 -54
  14. data/rdoc/lib/rdoc/anon_class.rb +0 -10
  15. data/rdoc/lib/rdoc/any_method.rb +0 -190
  16. data/rdoc/lib/rdoc/attr.rb +0 -79
  17. data/rdoc/lib/rdoc/cache.rb +0 -41
  18. data/rdoc/lib/rdoc/class_module.rb +0 -87
  19. data/rdoc/lib/rdoc/code_object.rb +0 -152
  20. data/rdoc/lib/rdoc/code_objects.rb +0 -23
  21. data/rdoc/lib/rdoc/constant.rb +0 -36
  22. data/rdoc/lib/rdoc/context.rb +0 -712
  23. data/rdoc/lib/rdoc/diagram.rb +0 -340
  24. data/rdoc/lib/rdoc/dot.rb +0 -249
  25. data/rdoc/lib/rdoc/generator/darkfish.rb +0 -455
  26. data/rdoc/lib/rdoc/generator/markup.rb +0 -194
  27. data/rdoc/lib/rdoc/generator/ri.rb +0 -230
  28. data/rdoc/lib/rdoc/generator/template/darkfish/classpage.rhtml +0 -281
  29. data/rdoc/lib/rdoc/generator/template/darkfish/filepage.rhtml +0 -112
  30. data/rdoc/lib/rdoc/generator/template/darkfish/images/brick.png +0 -0
  31. data/rdoc/lib/rdoc/generator/template/darkfish/images/brick_link.png +0 -0
  32. data/rdoc/lib/rdoc/generator/template/darkfish/images/bug.png +0 -0
  33. data/rdoc/lib/rdoc/generator/template/darkfish/images/bullet_black.png +0 -0
  34. data/rdoc/lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png +0 -0
  35. data/rdoc/lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png +0 -0
  36. data/rdoc/lib/rdoc/generator/template/darkfish/images/date.png +0 -0
  37. data/rdoc/lib/rdoc/generator/template/darkfish/images/find.png +0 -0
  38. data/rdoc/lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif +0 -0
  39. data/rdoc/lib/rdoc/generator/template/darkfish/images/macFFBgHack.png +0 -0
  40. data/rdoc/lib/rdoc/generator/template/darkfish/images/package.png +0 -0
  41. data/rdoc/lib/rdoc/generator/template/darkfish/images/page_green.png +0 -0
  42. data/rdoc/lib/rdoc/generator/template/darkfish/images/page_white_text.png +0 -0
  43. data/rdoc/lib/rdoc/generator/template/darkfish/images/page_white_width.png +0 -0
  44. data/rdoc/lib/rdoc/generator/template/darkfish/images/plugin.png +0 -0
  45. data/rdoc/lib/rdoc/generator/template/darkfish/images/ruby.png +0 -0
  46. data/rdoc/lib/rdoc/generator/template/darkfish/images/tag_green.png +0 -0
  47. data/rdoc/lib/rdoc/generator/template/darkfish/images/wrench.png +0 -0
  48. data/rdoc/lib/rdoc/generator/template/darkfish/images/wrench_orange.png +0 -0
  49. data/rdoc/lib/rdoc/generator/template/darkfish/images/zoom.png +0 -0
  50. data/rdoc/lib/rdoc/generator/template/darkfish/index.rhtml +0 -64
  51. data/rdoc/lib/rdoc/generator/template/darkfish/js/darkfish.js +0 -116
  52. data/rdoc/lib/rdoc/generator/template/darkfish/js/jquery.js +0 -32
  53. data/rdoc/lib/rdoc/generator/template/darkfish/js/quicksearch.js +0 -114
  54. data/rdoc/lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js +0 -10
  55. data/rdoc/lib/rdoc/generator/template/darkfish/rdoc.css +0 -696
  56. data/rdoc/lib/rdoc/generator.rb +0 -8
  57. data/rdoc/lib/rdoc/ghost_method.rb +0 -8
  58. data/rdoc/lib/rdoc/include.rb +0 -39
  59. data/rdoc/lib/rdoc/known_classes.rb +0 -68
  60. data/rdoc/lib/rdoc/markup/attribute_manager.rb +0 -311
  61. data/rdoc/lib/rdoc/markup/formatter.rb +0 -25
  62. data/rdoc/lib/rdoc/markup/fragments.rb +0 -377
  63. data/rdoc/lib/rdoc/markup/inline.rb +0 -126
  64. data/rdoc/lib/rdoc/markup/lines.rb +0 -156
  65. data/rdoc/lib/rdoc/markup/preprocess.rb +0 -80
  66. data/rdoc/lib/rdoc/markup/to_flow.rb +0 -211
  67. data/rdoc/lib/rdoc/markup/to_html.rb +0 -406
  68. data/rdoc/lib/rdoc/markup/to_html_crossref.rb +0 -140
  69. data/rdoc/lib/rdoc/markup/to_latex.rb +0 -328
  70. data/rdoc/lib/rdoc/markup/to_test.rb +0 -53
  71. data/rdoc/lib/rdoc/markup/to_texinfo.rb +0 -73
  72. data/rdoc/lib/rdoc/markup.rb +0 -378
  73. data/rdoc/lib/rdoc/meta_method.rb +0 -8
  74. data/rdoc/lib/rdoc/normal_class.rb +0 -18
  75. data/rdoc/lib/rdoc/normal_module.rb +0 -34
  76. data/rdoc/lib/rdoc/options.rb +0 -542
  77. data/rdoc/lib/rdoc/parser/c.rb +0 -678
  78. data/rdoc/lib/rdoc/parser/perl.rb +0 -165
  79. data/rdoc/lib/rdoc/parser/ruby.rb +0 -2904
  80. data/rdoc/lib/rdoc/parser/simple.rb +0 -39
  81. data/rdoc/lib/rdoc/parser.rb +0 -138
  82. data/rdoc/lib/rdoc/rdoc.rb +0 -375
  83. data/rdoc/lib/rdoc/require.rb +0 -32
  84. data/rdoc/lib/rdoc/ri/cache.rb +0 -187
  85. data/rdoc/lib/rdoc/ri/descriptions.rb +0 -156
  86. data/rdoc/lib/rdoc/ri/display.rb +0 -340
  87. data/rdoc/lib/rdoc/ri/driver.rb +0 -828
  88. data/rdoc/lib/rdoc/ri/formatter.rb +0 -654
  89. data/rdoc/lib/rdoc/ri/paths.rb +0 -93
  90. data/rdoc/lib/rdoc/ri/reader.rb +0 -106
  91. data/rdoc/lib/rdoc/ri/util.rb +0 -79
  92. data/rdoc/lib/rdoc/ri/writer.rb +0 -68
  93. data/rdoc/lib/rdoc/ri.rb +0 -8
  94. data/rdoc/lib/rdoc/single_class.rb +0 -8
  95. data/rdoc/lib/rdoc/stats.rb +0 -178
  96. data/rdoc/lib/rdoc/task.rb +0 -276
  97. data/rdoc/lib/rdoc/tokenstream.rb +0 -33
  98. data/rdoc/lib/rdoc/top_level.rb +0 -242
  99. data/rdoc/lib/rdoc.rb +0 -398
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ Copyright (c) 2009 Vladimir Kolesnikov
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21
+
data/VERSION.yml ADDED
@@ -0,0 +1,4 @@
1
+ ---
2
+ :minor: 1
3
+ :patch: 9
4
+ :major: 0
@@ -298,10 +298,7 @@ class RDoc::Generator::SHtml
298
298
  ### current context. Adds all +local_assigns+ to context
299
299
  def include_template(template_name, local_assigns = {})
300
300
  source = local_assigns.keys.map { |key| "#{key} = local_assigns[:#{key}];" }.join
301
- eval(source)
302
-
303
- templatefile = @template_dir + template_name
304
- eval_template(templatefile, binding)
301
+ eval("#{source};templatefile = @template_dir + template_name;eval_template(templatefile, binding)")
305
302
  end
306
303
 
307
304
  ### Load and render the erb template in the given +templatefile+ within the
data/lib/sdoc.rb CHANGED
@@ -1,5 +1,4 @@
1
1
  $:.unshift File.dirname(__FILE__)
2
- $:.unshift File.join File.dirname(__FILE__), '..', 'rdoc', 'lib'
3
2
  require "rdoc/rdoc"
4
3
 
5
4
  module SDoc
metadata CHANGED
@@ -1,15 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: voloko-sdoc
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.7
4
+ version: 0.1.9
5
5
  platform: ruby
6
6
  authors:
7
- - Vladimir Kolesnikov
7
+ - Volodya Kolesnikov
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
11
 
12
- date: 2009-03-29 00:00:00 -07:00
12
+ date: 2009-04-02 00:00:00 -07:00
13
13
  default_executable:
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
@@ -22,6 +22,16 @@ dependencies:
22
22
  - !ruby/object:Gem::Version
23
23
  version: 1.1.3
24
24
  version:
25
+ - !ruby/object:Gem::Dependency
26
+ name: rdoc
27
+ type: :runtime
28
+ version_requirement:
29
+ version_requirements: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 2.4.2
34
+ version:
25
35
  description:
26
36
  email: voloko@gmail.com
27
37
  executables:
@@ -31,125 +41,46 @@ extensions: []
31
41
 
32
42
  extra_rdoc_files:
33
43
  - README
44
+ - LICENSE
34
45
  files:
46
+ - VERSION.yml
47
+ - bin/sdoc
48
+ - bin/sdoc-merge
49
+ - lib/sdoc
50
+ - lib/sdoc/generator
35
51
  - lib/sdoc/generator/shtml.rb
52
+ - lib/sdoc/generator/template
53
+ - lib/sdoc/generator/template/shtml
36
54
  - lib/sdoc/generator/template/shtml/_context.rhtml
37
55
  - lib/sdoc/generator/template/shtml/class.rhtml
38
56
  - lib/sdoc/generator/template/shtml/file.rhtml
39
57
  - lib/sdoc/generator/template/shtml/index.rhtml
58
+ - lib/sdoc/generator/template/shtml/resources
59
+ - lib/sdoc/generator/template/shtml/resources/css
40
60
  - lib/sdoc/generator/template/shtml/resources/css/main.css
41
61
  - lib/sdoc/generator/template/shtml/resources/css/panel.css
42
62
  - lib/sdoc/generator/template/shtml/resources/css/reset.css
63
+ - lib/sdoc/generator/template/shtml/resources/i
43
64
  - lib/sdoc/generator/template/shtml/resources/i/arrows.png
44
65
  - lib/sdoc/generator/template/shtml/resources/i/results_bg.png
45
66
  - lib/sdoc/generator/template/shtml/resources/i/tree_bg.png
67
+ - lib/sdoc/generator/template/shtml/resources/js
46
68
  - lib/sdoc/generator/template/shtml/resources/js/jquery-1.3.2.min.js
47
69
  - lib/sdoc/generator/template/shtml/resources/js/main.js
48
70
  - lib/sdoc/generator/template/shtml/resources/js/searchdoc.js
71
+ - lib/sdoc/generator/template/shtml/resources/panel
49
72
  - lib/sdoc/generator/template/shtml/resources/panel/index.html
50
73
  - lib/sdoc/github.rb
51
74
  - lib/sdoc/merge.rb
52
75
  - lib/sdoc.rb
53
- - rdoc/bin/rdoc
54
- - rdoc/bin/ri
55
- - rdoc/History.txt
56
- - rdoc/lib/rdoc/alias.rb
57
- - rdoc/lib/rdoc/anon_class.rb
58
- - rdoc/lib/rdoc/any_method.rb
59
- - rdoc/lib/rdoc/attr.rb
60
- - rdoc/lib/rdoc/cache.rb
61
- - rdoc/lib/rdoc/class_module.rb
62
- - rdoc/lib/rdoc/code_object.rb
63
- - rdoc/lib/rdoc/code_objects.rb
64
- - rdoc/lib/rdoc/constant.rb
65
- - rdoc/lib/rdoc/context.rb
66
- - rdoc/lib/rdoc/diagram.rb
67
- - rdoc/lib/rdoc/dot.rb
68
- - rdoc/lib/rdoc/generator/darkfish.rb
69
- - rdoc/lib/rdoc/generator/markup.rb
70
- - rdoc/lib/rdoc/generator/ri.rb
71
- - rdoc/lib/rdoc/generator/template/darkfish/classpage.rhtml
72
- - rdoc/lib/rdoc/generator/template/darkfish/filepage.rhtml
73
- - rdoc/lib/rdoc/generator/template/darkfish/images/brick.png
74
- - rdoc/lib/rdoc/generator/template/darkfish/images/brick_link.png
75
- - rdoc/lib/rdoc/generator/template/darkfish/images/bug.png
76
- - rdoc/lib/rdoc/generator/template/darkfish/images/bullet_black.png
77
- - rdoc/lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png
78
- - rdoc/lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png
79
- - rdoc/lib/rdoc/generator/template/darkfish/images/date.png
80
- - rdoc/lib/rdoc/generator/template/darkfish/images/find.png
81
- - rdoc/lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif
82
- - rdoc/lib/rdoc/generator/template/darkfish/images/macFFBgHack.png
83
- - rdoc/lib/rdoc/generator/template/darkfish/images/package.png
84
- - rdoc/lib/rdoc/generator/template/darkfish/images/page_green.png
85
- - rdoc/lib/rdoc/generator/template/darkfish/images/page_white_text.png
86
- - rdoc/lib/rdoc/generator/template/darkfish/images/page_white_width.png
87
- - rdoc/lib/rdoc/generator/template/darkfish/images/plugin.png
88
- - rdoc/lib/rdoc/generator/template/darkfish/images/ruby.png
89
- - rdoc/lib/rdoc/generator/template/darkfish/images/tag_green.png
90
- - rdoc/lib/rdoc/generator/template/darkfish/images/wrench.png
91
- - rdoc/lib/rdoc/generator/template/darkfish/images/wrench_orange.png
92
- - rdoc/lib/rdoc/generator/template/darkfish/images/zoom.png
93
- - rdoc/lib/rdoc/generator/template/darkfish/index.rhtml
94
- - rdoc/lib/rdoc/generator/template/darkfish/js/darkfish.js
95
- - rdoc/lib/rdoc/generator/template/darkfish/js/jquery.js
96
- - rdoc/lib/rdoc/generator/template/darkfish/js/quicksearch.js
97
- - rdoc/lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js
98
- - rdoc/lib/rdoc/generator/template/darkfish/rdoc.css
99
- - rdoc/lib/rdoc/generator.rb
100
- - rdoc/lib/rdoc/ghost_method.rb
101
- - rdoc/lib/rdoc/include.rb
102
- - rdoc/lib/rdoc/known_classes.rb
103
- - rdoc/lib/rdoc/markup/attribute_manager.rb
104
- - rdoc/lib/rdoc/markup/formatter.rb
105
- - rdoc/lib/rdoc/markup/fragments.rb
106
- - rdoc/lib/rdoc/markup/inline.rb
107
- - rdoc/lib/rdoc/markup/lines.rb
108
- - rdoc/lib/rdoc/markup/preprocess.rb
109
- - rdoc/lib/rdoc/markup/to_flow.rb
110
- - rdoc/lib/rdoc/markup/to_html.rb
111
- - rdoc/lib/rdoc/markup/to_html_crossref.rb
112
- - rdoc/lib/rdoc/markup/to_latex.rb
113
- - rdoc/lib/rdoc/markup/to_test.rb
114
- - rdoc/lib/rdoc/markup/to_texinfo.rb
115
- - rdoc/lib/rdoc/markup.rb
116
- - rdoc/lib/rdoc/meta_method.rb
117
- - rdoc/lib/rdoc/normal_class.rb
118
- - rdoc/lib/rdoc/normal_module.rb
119
- - rdoc/lib/rdoc/options.rb
120
- - rdoc/lib/rdoc/parser/c.rb
121
- - rdoc/lib/rdoc/parser/perl.rb
122
- - rdoc/lib/rdoc/parser/ruby.rb
123
- - rdoc/lib/rdoc/parser/simple.rb
124
- - rdoc/lib/rdoc/parser.rb
125
- - rdoc/lib/rdoc/rdoc.rb
126
- - rdoc/lib/rdoc/require.rb
127
- - rdoc/lib/rdoc/ri/cache.rb
128
- - rdoc/lib/rdoc/ri/descriptions.rb
129
- - rdoc/lib/rdoc/ri/display.rb
130
- - rdoc/lib/rdoc/ri/driver.rb
131
- - rdoc/lib/rdoc/ri/formatter.rb
132
- - rdoc/lib/rdoc/ri/paths.rb
133
- - rdoc/lib/rdoc/ri/reader.rb
134
- - rdoc/lib/rdoc/ri/util.rb
135
- - rdoc/lib/rdoc/ri/writer.rb
136
- - rdoc/lib/rdoc/ri.rb
137
- - rdoc/lib/rdoc/single_class.rb
138
- - rdoc/lib/rdoc/stats.rb
139
- - rdoc/lib/rdoc/task.rb
140
- - rdoc/lib/rdoc/tokenstream.rb
141
- - rdoc/lib/rdoc/top_level.rb
142
- - rdoc/lib/rdoc.rb
143
- - rdoc/Manifest.txt
144
- - rdoc/Rakefile
145
- - rdoc/README.txt
146
- - rdoc/RI.txt
147
76
  - README
77
+ - LICENSE
148
78
  has_rdoc: true
149
- homepage: http://railsapi.com
79
+ homepage: http://github.com/voloko/sdoc
150
80
  post_install_message:
151
- rdoc_options: []
152
-
81
+ rdoc_options:
82
+ - --inline-source
83
+ - --charset=UTF-8
153
84
  require_paths:
154
85
  - lib
155
86
  required_ruby_version: !ruby/object:Gem::Requirement
@@ -170,6 +101,6 @@ rubyforge_project:
170
101
  rubygems_version: 1.2.0
171
102
  signing_key:
172
103
  specification_version: 2
173
- summary: RDoc extensions for searchable html generations
104
+ summary: rdoc html with javascript search index.
174
105
  test_files: []
175
106
 
data/rdoc/History.txt DELETED
@@ -1,254 +0,0 @@
1
- === 2.4.2 / 2009-03-25
2
-
3
- * 2 Minor Enhancements
4
- * Added --pipe for turning RDoc on stdin into HTML
5
- * Added rdoc/task.rb containing a replacement for rake/rdoctask.rb. Use
6
- RDoc::Task now instead of Rake::RDocTask.
7
-
8
- * 10 Bug Fixes
9
- * Writing the ri cache file to the proper directory. Bug #24459 by Lars
10
- Christensen.
11
- * Possible fix for Dir::[] and Pathname interaction on 1.9. Bug #24650 by
12
- tiburon.
13
- * Fixed scanning constants for if/end, etc. pairs. Bug #24609 by Ryan
14
- Davis.
15
- * Fixed private methods in the C parser. Bug #24599 by Aaron Patterson.
16
- * Fixed display of markup on RDoc main page. Bug #24168 by rhubarb.
17
- * Fixed display of \\ character in documentation proceeding words.
18
- Bug #22112 by James Gray. See RDoc for details.
19
- * Fixed parsing and display of arg params for some corner cases. Bug #21113
20
- by Csiszár Attila.
21
- * Fixed links in Files box. Patch #24403 by Eric Wong.
22
- * Toplevel methods now appear in Object. Bug #22677 by Ryan Davis.
23
- * Added back --promiscuous which didn't do anything you cared about. Why
24
- did you enable it? Nobody looked at that page! Oh, it warns, too.
25
-
26
- === 2.4.1 / 2009-02-26
27
-
28
- * 1 Minor Enhancements
29
- * Added :attr:, :attr_reader:, :attr_writer:, :attr_accessor: directives.
30
- Replaces --accessor. See RDoc::Parser::Ruby for details.
31
-
32
- * 3 Bug Fixes
33
- * Don't complain when exiting normally. Bug by Matt Neuburg.
34
- * Restore --inline-source that warns
35
- * Fixed links to files in Darkfish output
36
-
37
- === 2.4.0 / 2009-02-24
38
-
39
- * 9 Minor Enhancements
40
- * `ri -f html` is now XHTML-happy
41
- * Clarified RDoc::Markup link syntax. Bug #23517 by Eric Armstrong.
42
- * Number of threads to parse with is now configurable
43
- * Darkfish can now use alternate templates from $LOAD_PATH via -T
44
- * Removed F95 parser in favor of the rdoc-f95 gem
45
- * Moved HTML and XML generators to unmaintained
46
- * No gem will be provided as it's too difficult to make them work
47
- * Removed options --one-file, --style=, --inline-source, --promiscuous,
48
- --op-name
49
- * Removed support for --accessor, use regular documentation or
50
- the method directive instead. See RDoc::Parser::Ruby
51
- * Removed --ri-system as it is unused by Ruby's makefiles
52
- * Added method list to index.html
53
-
54
- * 6 Bug Fixes
55
- * nodoc'd classes no longer appear in the index. Bug #23751 by Clifford
56
- Heath.
57
- * Fix 1.9 compatibility issues. Bug #23815 by paddor.
58
- * Darkfish now respects --charset
59
- * RDoc no longer attempts to be lazy when building HTML. This is a
60
- workaround. Bug #23893 by Stefano Crocco.
61
- * RDoc doesn't crash with def (blah).foo() end
62
- * RDoc doesn't crash with #define functions
63
-
64
- === 2.3.0 / 2009-01-28
65
-
66
- * 3 Major Enhancements
67
- * Michael Granger's Darkfish generator is now the default for HTML output
68
- * Various rdoc generation speedups by Hongli Lai. Patches #22555, #22556,
69
- #22557, #22562, #22565.
70
- * rdoc/discover.rb files are loaded automatically from installed gems
71
-
72
- * 8 Minor Enhancements
73
- * Added a space after the commas in ri class method lists. RubyForge
74
- enhancement #22182.
75
- * Improved ri --interactive
76
- * Generators can now override generated file locations
77
- * Moved unmaintained CHM generator to it's own package
78
- * Moved unmaintained extra HTML templates to their own package
79
- * Removed experimental texinfo generator
80
- * Converted to minitest
81
- * Known classes and modules list outputs once per line now for grep
82
-
83
- * 11 Bug Fixes
84
- * Fix missing superclass in ri output
85
- * Fix an RDoc crash when told to parse an empty file
86
- * Ignore nonexistent files instead of crashing
87
- * .txt and .rdoc files are always considered text. Patch #22897 by Aaron
88
- Patterson.
89
- * When merging ri data with a nonexistant directory, RDoc no longer crashes
90
- * Fix visibility of methods in XML output. Issue by Yehuda Katz.
91
- * Fixed relative link generation
92
- * Fix crash, RDoc now ignores comments above local variable assignments in
93
- modules
94
- * RDoc now only accepts adjacent comments for rb_define_module and
95
- rb_define_class
96
- * C file RDoc is no longer included in token stream
97
- * Scan all gem paths to match gem name for ri output
98
-
99
- === 2.2.1 / 2008-09-24
100
- This version provides some minor fixes and enhancements to 2.2.0 intended
101
- to polish RDoc for Ruby 1.9.1.
102
-
103
- * 3 Minor Enhancements
104
- * Support for parsing RDoc from SWIG. Ruby patch #10742 by Gonzalo
105
- Garramuno, #13993 by Steven Jenkins.
106
- * Simple support for Perl POD documentation. Patch by Hugh Sasse.
107
- * Changed the default character set of RDoc's output from iso-8859-1 to
108
- utf-8.
109
-
110
- * 9 Bug Fixes
111
- * Explicitly set the html template's text color, so that the generated
112
- documentation will display correctly on browsers with custom text and
113
- background color settings (patch by Luther Thompson).
114
- * Ensure that RDoc correctly will associate an alias and a method, even
115
- if it encounters the alias first because the alias lives in a different
116
- file.
117
- * Fix the parsing of multiline constants (patch by Chris Alfeld and
118
- Joel VanderWerf)
119
- * Make --exclude usuable. Ruby patch #11671 by Trans.
120
- * Detect inline C functions. Ruby Bug #11993 by Florian Frank.
121
- * Fix an issue in which RDoc might not document a class'
122
- superclass correctly if the class was defined in multiple files and
123
- depending on the order in which RDoc processed the files. This should
124
- ensure that the child class -> parent class relationship is correct in
125
- ri documentation, allowing ri to lookup inherited methods (i.e., File.read).
126
- * Stop ri from crashing when it looks for a completely bogus method (i.e.,
127
- File#reada). Now, ri exits with a helpful error message.
128
- * Fixed missing display of constant values in ri.
129
- * Fixed display of constants in ri's html output.
130
-
131
- === 2.2.0 / 2008-09-19
132
- This version includes some significant enhancements to ri. See RI.txt for
133
- documentation about ri.
134
-
135
- * 5 Major Enhancements
136
- * More extensive unit tests (special thanks to Chris Lowis for contributing
137
- a test).
138
- * Made ri twice as fast for the most common use case of displaying
139
- information for a class or a fully-qualified method
140
- (i.e., ri Array#flatten, after ri has created a cache the first time that
141
- it runs).
142
- * Made ri many times faster when searching for an unqualified method (i.e.,
143
- ri read, again after the first such search has populated ri's cache)
144
- * Changed ri to do regular expression searches for unqualified methods;
145
- now, a regular expression for a method can be passed to ri on the
146
- command-line.
147
- * Added an interactive mode to ri (patch by Daniel Choi). Now, when ri
148
- is given a -i argument, it will allow the user to disambiguate
149
- unqualified methods if more than one is present and also will allow a
150
- user to get information for a class' method.
151
-
152
- * 8 Minor Enhancements
153
- * RDoc now adds the package title to the web pages that it generates
154
- for files and classes/modules, which helps them appear better in
155
- search engine results.
156
- * RDoc now automatically generates cross-reference links for classes and
157
- methods specified relative to the global namespace (i.e., ::A::B::C#method).
158
- * All built-in templates now output valid, strict XHTML.
159
- * The documentation is slightly better organized (the markup details were
160
- merged into the RDoc module's documentation).
161
- * Improved rdoc's HTML generation speed by about 20% (on Windows, the
162
- boost seems larger).
163
- * Provided an ri command-line option to control its caching behavior.
164
- * Improved RDoc's documentation. Added RI.txt to document ri.
165
- * Allow HTML templates distributed as gems to be loaded with the -T option,
166
- just like the standard templates in rdoc/generator/html (so an HTML
167
- template lib/new_template.rb in a gem can be used with rdoc -T new_template)
168
-
169
- * 25 Bug fixes:
170
- * Fixed prototype detection in C parser. Can process ruby 1.8 C files
171
- again.
172
- * Fixed the main page for frameless template. Patch by Marcin Raczkowski.
173
- * Fixed the main page for frame templates. Now, if no main page is
174
- specified, RDoc will default to the README.
175
- * Fixed missing stylesheet in generated chm. Patch by Gordon Thiesfeld.
176
- * Fixed the parsing of module names starting with '::'. Patch by
177
- Giuseppe Bilotta.
178
- * Fixed a case where RDoc first would encounter Foo::Bar and then would
179
- encounter class Foo. Previously, RDoc erroneously would have considered
180
- that both a Foo class and a Foo module existed.
181
- * Fix a clase where RDoc would not generate correct cross-reference links
182
- to a class contained within a module of the same name (i.e. RDoc::RDoc)
183
- * Prevented RDoc from trying to parse binary files, which would produce
184
- garbage output.
185
- * RDoc now correctly converts ' characters to apostrophes, opening single
186
- quotes, and closing single quotes in most cases (smart single quotes).
187
- * RDoc now correctly converts " characters to opening double quotes and
188
- and closing double quotes in most cases (smart double quotes).
189
- * (c) correctly is converted into the copyright symbol.
190
- * '&' characters in text now correctly are translated to HTML character codes.
191
- * Fixed missing stylesheet in generated chm. Patch by Gordon Thiesfeld.
192
- * Fixed broken method links in the built-in templates.
193
- * RDoc properly links to files and classes in the one page HTML template.
194
- * The kilmer and hefss templates properly syntax highlight when inlining
195
- source code.
196
- * The kilmer and hefss template class pages properly display methods again.
197
- * Fixed broken class, file, and method links in the frameless template.
198
- * Fixed the clipping of source code in the html and frameless templates when
199
- the source code cannot fit into the window; a scrollbar now will allow
200
- all of the source code to be viewed.
201
- * Fixed the missing constant descriptions in the html and frameless
202
- templates.
203
- * Fixed the ri command-line options that customize the directories to be
204
- searched for documentation.
205
- * Fixed the XML generator. Patch by Anthony Durity.
206
- * Stopped the XML template from generating invalid XML due to malformed
207
- embedded ruby.
208
- * Adding missing information about a class' constants to the XML template.
209
- * Fixed the horizontal rule markup (---) so that it correctly adds a
210
- horizontal rule rather than suppressing all text that follows.
211
-
212
- === 2.1.0 / 2008-07-20
213
-
214
- * 3 Major Enhancements:
215
- * RDoc now knows about meta-programmed methods, see RDoc::Parser::Ruby
216
- * Reorganized parsers under RDoc::Parser base class
217
- * ri now walks the ancestors of a class looking for a method e.g. ri
218
- File#read displays documentation for IO#read (may require regeneration of
219
- ri data)
220
- * 5 Minor Enhancements:
221
- * Allow links to files
222
- * Default options now taken from RDOCOPT environment variable
223
- * Class method documentation can be found at toplevel now (def X.foo)
224
- * Allow HTML templates distributed as gems to be loaded with the -T option,
225
- just like the standard templates in rdoc/generator/html (so an HTML
226
- template lib/new_template.rb in a gem can be used with rdoc -T new_template)
227
- * `rdoc -v` prints out files, classes, modules and methods as it goes
228
- * 11 Bug Fixes:
229
- * `ri Foo.bar` now looks for class methods also
230
- * Sections work in the default template again
231
- * Doesn't warn about :foo:: list item being an unrecognized directive
232
- * RDoc no longer converts characters inside tt tags
233
- * Fixed "unitialized constant RDoc::Markup::ToHtml::HTML"
234
- * Fixed generation of relative links
235
- * Fixed various diagram generation issues
236
- * Fixed templates broken by switch to erb
237
- * Fixed issue with <!-- --> style comments
238
- * Lowercase words are no longer rdoc'd as methods without leading #, as
239
- described in the documentation
240
- * RDoc now correctly sets superclasses if they were originally unknown
241
-
242
- === 2.0.0 / 2008-04-10
243
-
244
- * 3 Major Enhancements:
245
- * Renamespaced everything RDoc under the RDoc module.
246
- * New `ri` implementation.
247
- * Reads from a cache in ~/.ri/ for enhanced speed.
248
- * RubyGems aware, only searches latest gem versions.
249
- * Now up to over 100 tests and 200 assertions.
250
- * 4 Minor Enhancements:
251
- * Switched to an ERb-based TemplatePage, see RDoc::TemplatePage.
252
- * Class/module ri now displays attribute and constant comments.
253
- * Cross-references can be disabled with a leading \.
254
- * Relaxed parsing for some RDoc inline markup.
data/rdoc/Manifest.txt DELETED
@@ -1,126 +0,0 @@
1
- .autotest
2
- .document
3
- History.txt
4
- Manifest.txt
5
- README.txt
6
- RI.txt
7
- Rakefile
8
- bin/rdoc
9
- bin/ri
10
- lib/rdoc.rb
11
- lib/rdoc/alias.rb
12
- lib/rdoc/anon_class.rb
13
- lib/rdoc/any_method.rb
14
- lib/rdoc/attr.rb
15
- lib/rdoc/cache.rb
16
- lib/rdoc/class_module.rb
17
- lib/rdoc/code_object.rb
18
- lib/rdoc/code_objects.rb
19
- lib/rdoc/constant.rb
20
- lib/rdoc/context.rb
21
- lib/rdoc/diagram.rb
22
- lib/rdoc/dot.rb
23
- lib/rdoc/generator.rb
24
- lib/rdoc/generator/darkfish.rb
25
- lib/rdoc/generator/markup.rb
26
- lib/rdoc/generator/ri.rb
27
- lib/rdoc/generator/template/darkfish/.document
28
- lib/rdoc/generator/template/darkfish/classpage.rhtml
29
- lib/rdoc/generator/template/darkfish/filepage.rhtml
30
- lib/rdoc/generator/template/darkfish/images/brick.png
31
- lib/rdoc/generator/template/darkfish/images/brick_link.png
32
- lib/rdoc/generator/template/darkfish/images/bug.png
33
- lib/rdoc/generator/template/darkfish/images/bullet_black.png
34
- lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png
35
- lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png
36
- lib/rdoc/generator/template/darkfish/images/date.png
37
- lib/rdoc/generator/template/darkfish/images/find.png
38
- lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif
39
- lib/rdoc/generator/template/darkfish/images/macFFBgHack.png
40
- lib/rdoc/generator/template/darkfish/images/package.png
41
- lib/rdoc/generator/template/darkfish/images/page_green.png
42
- lib/rdoc/generator/template/darkfish/images/page_white_text.png
43
- lib/rdoc/generator/template/darkfish/images/page_white_width.png
44
- lib/rdoc/generator/template/darkfish/images/plugin.png
45
- lib/rdoc/generator/template/darkfish/images/ruby.png
46
- lib/rdoc/generator/template/darkfish/images/tag_green.png
47
- lib/rdoc/generator/template/darkfish/images/wrench.png
48
- lib/rdoc/generator/template/darkfish/images/wrench_orange.png
49
- lib/rdoc/generator/template/darkfish/images/zoom.png
50
- lib/rdoc/generator/template/darkfish/index.rhtml
51
- lib/rdoc/generator/template/darkfish/js/darkfish.js
52
- lib/rdoc/generator/template/darkfish/js/jquery.js
53
- lib/rdoc/generator/template/darkfish/js/quicksearch.js
54
- lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js
55
- lib/rdoc/generator/template/darkfish/rdoc.css
56
- lib/rdoc/ghost_method.rb
57
- lib/rdoc/include.rb
58
- lib/rdoc/known_classes.rb
59
- lib/rdoc/markup.rb
60
- lib/rdoc/markup/attribute_manager.rb
61
- lib/rdoc/markup/formatter.rb
62
- lib/rdoc/markup/fragments.rb
63
- lib/rdoc/markup/inline.rb
64
- lib/rdoc/markup/lines.rb
65
- lib/rdoc/markup/preprocess.rb
66
- lib/rdoc/markup/to_flow.rb
67
- lib/rdoc/markup/to_html.rb
68
- lib/rdoc/markup/to_html_crossref.rb
69
- lib/rdoc/markup/to_latex.rb
70
- lib/rdoc/markup/to_test.rb
71
- lib/rdoc/markup/to_texinfo.rb
72
- lib/rdoc/meta_method.rb
73
- lib/rdoc/normal_class.rb
74
- lib/rdoc/normal_module.rb
75
- lib/rdoc/options.rb
76
- lib/rdoc/parser.rb
77
- lib/rdoc/parser/c.rb
78
- lib/rdoc/parser/perl.rb
79
- lib/rdoc/parser/ruby.rb
80
- lib/rdoc/parser/simple.rb
81
- lib/rdoc/rdoc.rb
82
- lib/rdoc/require.rb
83
- lib/rdoc/ri.rb
84
- lib/rdoc/ri/cache.rb
85
- lib/rdoc/ri/descriptions.rb
86
- lib/rdoc/ri/display.rb
87
- lib/rdoc/ri/driver.rb
88
- lib/rdoc/ri/formatter.rb
89
- lib/rdoc/ri/paths.rb
90
- lib/rdoc/ri/reader.rb
91
- lib/rdoc/ri/util.rb
92
- lib/rdoc/ri/writer.rb
93
- lib/rdoc/single_class.rb
94
- lib/rdoc/stats.rb
95
- lib/rdoc/task.rb
96
- lib/rdoc/tokenstream.rb
97
- lib/rdoc/top_level.rb
98
- test/binary.dat
99
- test/test.ja.rdoc
100
- test/test.ja.txt
101
- test/test_attribute_manager.rb
102
- test/test_rdoc_any_method.rb
103
- test/test_rdoc_code_object.rb
104
- test/test_rdoc_constant.rb
105
- test/test_rdoc_context.rb
106
- test/test_rdoc_include.rb
107
- test/test_rdoc_markup.rb
108
- test/test_rdoc_markup_attribute_manager.rb
109
- test/test_rdoc_markup_to_html.rb
110
- test/test_rdoc_markup_to_html_crossref.rb
111
- test/test_rdoc_normal_module.rb
112
- test/test_rdoc_parser.rb
113
- test/test_rdoc_parser_c.rb
114
- test/test_rdoc_parser_perl.rb
115
- test/test_rdoc_parser_ruby.rb
116
- test/test_rdoc_require.rb
117
- test/test_rdoc_ri_attribute_formatter.rb
118
- test/test_rdoc_ri_default_display.rb
119
- test/test_rdoc_ri_driver.rb
120
- test/test_rdoc_ri_formatter.rb
121
- test/test_rdoc_ri_html_formatter.rb
122
- test/test_rdoc_ri_overstrike_formatter.rb
123
- test/test_rdoc_task.rb
124
- test/test_rdoc_top_level.rb
125
- test/xref_data.rb
126
- test/xref_test_case.rb
data/rdoc/README.txt DELETED
@@ -1,47 +0,0 @@
1
- = \RDoc
2
-
3
- * {RDoc Project Page}[http://rubyforge.org/projects/rdoc/]
4
- * {RDoc Documentation}[http://rdoc.rubyforge.org/]
5
- * {RDoc Bug Tracker}[http://rubyforge.org/tracker/?atid=2472&group_id=627&func=browse]
6
-
7
- == DESCRIPTION:
8
-
9
- RDoc is an application that produces documentation for one or more Ruby source
10
- files. RDoc includes the +rdoc+ and +ri+ tools for generating and displaying
11
- online documentation.
12
-
13
- At this point in time, RDoc 2.x is a work in progress and may incur further
14
- API changes beyond what has been made to RDoc 1.0.1. Command-line tools are
15
- largely unaffected, but internal APIs may shift rapidly.
16
-
17
- See RDoc for a description of RDoc's markup and basic use.
18
-
19
- == SYNOPSIS:
20
-
21
- gem 'rdoc'
22
- require 'rdoc/rdoc'
23
- # ... see RDoc
24
-
25
- == BUGS:
26
-
27
- The markup engine has lots of little bugs. In particular:
28
- * Escaping does not work for all markup.
29
- * Typesetting is not always correct.
30
- * Some output formats (ri, for example) do not correctly handle all of the
31
- markup.
32
-
33
- RDoc has some subtle bugs processing classes that are split across multiple
34
- files (bugs that may or may not manifest depending on the order in which
35
- the files are encountered). This issue can be tracked here[http://rubyforge.org/tracker/index.php?func=detail&aid=22135&group_id=627&atid=2475].
36
-
37
- If you find a bug, please report it at the RDoc project's
38
- tracker[http://rubyforge.org/tracker/?group_id=627] on RubyForge:
39
-
40
- == LICENSE:
41
-
42
- RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.
43
- Portions (c) 2007-2009 Eric Hodel. Portions copyright others, see individual
44
- files for details.
45
-
46
- It is free software, and may be redistributed under the terms specified in the
47
- README file of the Ruby distribution.