yard 0.5.3 → 0.5.4
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of yard might be problematic. Click here for more details.
- data/ChangeLog +443 -0
- data/README.md +5 -2
- data/docs/WhatsNew.md +8 -0
- data/lib/yard.rb +4 -4
- data/lib/yard/autoload.rb +34 -30
- data/lib/yard/cli/base.rb +14 -0
- data/lib/yard/cli/yard_graph.rb +5 -11
- data/lib/yard/cli/yardoc.rb +9 -8
- data/lib/yard/cli/yri.rb +2 -9
- data/lib/yard/code_objects/base.rb +9 -6
- data/lib/yard/code_objects/class_object.rb +5 -5
- data/lib/yard/code_objects/module_object.rb +3 -2
- data/lib/yard/core_ext/file.rb +1 -1
- data/lib/yard/docstring.rb +9 -20
- data/lib/yard/handlers/base.rb +13 -0
- data/lib/yard/handlers/ruby/alias_handler.rb +1 -1
- data/lib/yard/handlers/ruby/attribute_handler.rb +1 -1
- data/lib/yard/handlers/ruby/class_condition_handler.rb +1 -1
- data/lib/yard/handlers/ruby/class_handler.rb +1 -1
- data/lib/yard/handlers/ruby/class_variable_handler.rb +1 -1
- data/lib/yard/handlers/ruby/constant_handler.rb +1 -1
- data/lib/yard/handlers/ruby/exception_handler.rb +1 -1
- data/lib/yard/handlers/ruby/legacy/alias_handler.rb +1 -1
- data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +1 -1
- data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +8 -0
- data/lib/yard/handlers/ruby/legacy/class_handler.rb +1 -1
- data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +1 -1
- data/lib/yard/handlers/ruby/legacy/constant_handler.rb +1 -1
- data/lib/yard/handlers/ruby/legacy/exception_handler.rb +1 -1
- data/lib/yard/handlers/ruby/legacy/method_handler.rb +1 -1
- data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +1 -1
- data/lib/yard/handlers/ruby/legacy/module_handler.rb +1 -1
- data/lib/yard/handlers/ruby/legacy/process_handler.rb +12 -0
- data/lib/yard/handlers/ruby/legacy/visibility_handler.rb +1 -1
- data/lib/yard/handlers/ruby/legacy/yield_handler.rb +1 -1
- data/lib/yard/handlers/ruby/method_condition_handler.rb +1 -1
- data/lib/yard/handlers/ruby/method_handler.rb +1 -1
- data/lib/yard/handlers/ruby/mixin_handler.rb +1 -1
- data/lib/yard/handlers/ruby/module_handler.rb +1 -1
- data/lib/yard/handlers/ruby/process_handler.rb +12 -0
- data/lib/yard/handlers/ruby/visibility_handler.rb +1 -1
- data/lib/yard/handlers/ruby/yield_handler.rb +1 -1
- data/lib/yard/parser/ruby/legacy/ruby_lex.rb +1 -1
- data/lib/yard/parser/ruby/legacy/statement.rb +6 -0
- data/lib/yard/parser/ruby/legacy/statement_list.rb +9 -3
- data/lib/yard/parser/ruby/ruby_parser.rb +16 -0
- data/lib/yard/tags/default_factory.rb +9 -13
- data/lib/yard/tags/library.rb +7 -7
- data/lib/yard/tags/overload_tag.rb +4 -4
- data/lib/yard/templates/erb_cache.rb +18 -0
- data/lib/yard/templates/helpers/html_helper.rb +24 -5
- data/lib/yard/templates/helpers/method_helper.rb +10 -2
- data/lib/yard/templates/template.rb +11 -7
- data/spec/code_objects/class_object_spec.rb +8 -1
- data/spec/code_objects/module_object_spec.rb +8 -1
- data/spec/core_ext/file_spec.rb +5 -1
- data/spec/docstring_spec.rb +80 -42
- data/spec/handlers/class_condition_handler_spec.rb +15 -13
- data/spec/handlers/examples/process_handler_001.rb.txt +11 -0
- data/spec/handlers/process_handler_spec.rb +17 -0
- data/spec/parser/source_parser_spec.rb +11 -0
- data/spec/tags/overload_tag_spec.rb +2 -2
- data/spec/templates/class_spec.rb +9 -0
- data/spec/templates/examples/class001.html +20 -17
- data/spec/templates/examples/class002.html +37 -0
- data/spec/templates/examples/method001.html +7 -7
- data/spec/templates/examples/method002.html +5 -5
- data/spec/templates/examples/method003.html +5 -5
- data/spec/templates/examples/method004.html +3 -3
- data/spec/templates/examples/method005.html +1 -1
- data/spec/templates/examples/module001.html +64 -36
- data/spec/templates/helpers/html_helper_spec.rb +28 -0
- data/spec/templates/helpers/method_helper_spec.rb +28 -0
- data/spec/templates/module_spec.rb +10 -1
- data/spec/templates/template_spec.rb +4 -0
- data/templates/default/class/setup.rb +1 -1
- data/templates/default/fulldoc/html/css/style.css +6 -1
- data/templates/default/fulldoc/html/frames.erb +1 -1
- data/templates/default/fulldoc/html/full_list.erb +1 -1
- data/templates/default/fulldoc/html/js/app.js +12 -0
- data/templates/default/fulldoc/html/js/full_list.js +11 -0
- data/templates/default/fulldoc/html/setup.rb +2 -1
- data/templates/default/layout/html/headers.erb +1 -1
- data/templates/default/layout/html/setup.rb +1 -1
- data/templates/default/module/html/box_info.erb +5 -0
- data/templates/default/module/html/constant_summary.erb +1 -1
- data/templates/default/module/html/inherited_methods.erb +10 -1
- data/templates/default/module/html/method_summary.erb +9 -7
- data/templates/default/module/setup.rb +17 -3
- metadata +9 -2
data/ChangeLog
CHANGED
@@ -1,5 +1,448 @@
|
|
1
|
+
2010-03-22 Loren Segal <lsegal@soen.ca>
|
2
|
+
|
3
|
+
* ChangeLog, README.md, docs/WhatsNew.md, lib/yard.rb, yard.gemspec: Bump
|
4
|
+
version 0.5.4
|
5
|
+
|
6
|
+
* templates/default/fulldoc/html/setup.rb: Fix hiding of @private classes in
|
7
|
+
unresolved namespaces to use @items instead of objects directly
|
8
|
+
|
9
|
+
* spec/templates/module_spec.rb: Fix failing spec in 1.8.6
|
10
|
+
|
11
|
+
* spec/templates/module_spec.rb, templates/default/module/setup.rb: Fix
|
12
|
+
testability of mixin list
|
13
|
+
|
14
|
+
* spec/templates/examples/module001.html, spec/templates/module_spec.rb,
|
15
|
+
templates/default/module/html/box_info.erb,
|
16
|
+
templates/default/module/setup.rb: Simplify listing of class/modules used by
|
17
|
+
a module
|
18
|
+
|
19
|
+
2010-03-21 Benjamin Bock <bb--github.com@bock.be>
|
20
|
+
|
21
|
+
* templates/default/module/html/box_info.erb,
|
22
|
+
templates/default/module/setup.rb: add sections "Included in" and "Extending"
|
23
|
+
for Modules
|
24
|
+
|
25
|
+
2010-03-21 Loren Segal <lsegal@soen.ca>
|
26
|
+
|
27
|
+
* templates/default/layout/html/setup.rb: Add .mkd file extension for
|
28
|
+
Markdown
|
29
|
+
|
30
|
+
* lib/yard/core_ext/file.rb, spec/core_ext/file_spec.rb: Fix handling of
|
31
|
+
relative paths that go outside the "initial" directory
|
32
|
+
|
33
|
+
* lib/yard.rb: YARD::ROOT should be absolute in 1.8
|
34
|
+
|
35
|
+
* templates/default/fulldoc/html/css/style.css: Inline only the first
|
36
|
+
paragraph of inlined docstrings.
|
37
|
+
|
38
|
+
* lib/yard/code_objects/module_object.rb: Avoid listing self as mixin in
|
39
|
+
inheritance tree
|
40
|
+
|
41
|
+
* templates/default/fulldoc/html/js/app.js,
|
42
|
+
templates/default/fulldoc/html/js/full_list.js: Make keyboard shortcuts more
|
43
|
+
reliable
|
44
|
+
|
45
|
+
* templates/default/fulldoc/html/setup.rb: Ignore @private classes defined in
|
46
|
+
unresolved namespaces in class list. Closes gh-103
|
47
|
+
|
48
|
+
* templates/default/fulldoc/html/css/style.css: Fix breadcrumb link text size
|
49
|
+
|
50
|
+
* spec/templates/examples/class001.html,
|
51
|
+
spec/templates/examples/method001.html,
|
52
|
+
spec/templates/examples/method002.html,
|
53
|
+
spec/templates/examples/method003.html,
|
54
|
+
spec/templates/examples/method004.html,
|
55
|
+
spec/templates/examples/method005.html,
|
56
|
+
spec/templates/examples/module001.html: Fix spec expectations for
|
57
|
+
htmlify_line changes
|
58
|
+
|
59
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
60
|
+
templates/default/fulldoc/html/css/style.css: Change how #htmlify_inline does
|
61
|
+
inlining
|
62
|
+
|
63
|
+
* lib/yard/code_objects/class_object.rb: Ensure default "Object" superclass
|
64
|
+
is "::Object" (same for BasicObject, Exception) Closes gh-72
|
65
|
+
|
66
|
+
* lib/yard/docstring.rb, spec/docstring_spec.rb: Remove only original
|
67
|
+
indentation from indented @tag text
|
68
|
+
|
69
|
+
* lib/yard/code_objects/class_object.rb,
|
70
|
+
lib/yard/code_objects/module_object.rb,
|
71
|
+
spec/code_objects/class_object_spec.rb,
|
72
|
+
spec/code_objects/module_object_spec.rb,
|
73
|
+
.../default/module/html/inherited_methods.erb: Show extended modules in
|
74
|
+
inherited methods list as class methods Closes gh-88
|
75
|
+
|
76
|
+
2010-03-20 Loren Segal <lsegal@soen.ca>
|
77
|
+
|
78
|
+
* templates/default/fulldoc/html/js/app.js: Don't activate shortcuts if a
|
79
|
+
modifier key is down
|
80
|
+
|
81
|
+
* lib/yard/docstring.rb, lib/yard/tags/default_factory.rb,
|
82
|
+
lib/yard/tags/library.rb, lib/yard/tags/overload_tag.rb,
|
83
|
+
spec/docstring_spec.rb, spec/tags/overload_tag_spec.rb: Remove distinction
|
84
|
+
between regular and "raw" tag text in the tags API. All tag text is now
|
85
|
+
delivered as a raw buffer with newlines intact. The API for creating factory
|
86
|
+
methods is now just `def parse_tag_NAME(tag_name, text)`. This change might
|
87
|
+
break existing plugins/extensions that add custom tags.
|
88
|
+
|
89
|
+
* spec/templates/class_spec.rb, spec/templates/examples/class002.html,
|
90
|
+
templates/default/class/setup.rb,
|
91
|
+
.../default/module/html/inherited_methods.erb,
|
92
|
+
templates/default/module/html/method_summary.erb: Respect @private for
|
93
|
+
constructors Closes gh-81
|
94
|
+
|
95
|
+
* lib/yard/parser/ruby/legacy/ruby_lex.rb: Graceful failure when multibyte
|
96
|
+
chars are tokenized Closes gh-94
|
97
|
+
|
98
|
+
* lib/yard/templates/helpers/method_helper.rb,
|
99
|
+
spec/templates/helpers/method_helper_spec.rb: Hide &block from argument list
|
100
|
+
for methods that yield. If a @param tag is specified for the block argument,
|
101
|
+
the argument will show. Closes gh-77
|
102
|
+
|
103
|
+
* spec/templates/examples/module001.html, spec/templates/module_spec.rb,
|
104
|
+
templates/default/fulldoc/html/css/style.css,
|
105
|
+
templates/default/module/html/constant_summary.erb,
|
106
|
+
templates/default/module/setup.rb: Show full docstrings for constants.
|
107
|
+
Closes gh-89 Closes gh-90
|
108
|
+
|
109
|
+
* lib/yard/docstring.rb, spec/docstring_spec.rb: Finish parsing @tag when
|
110
|
+
next line is de-dented. Closes gh-78
|
111
|
+
|
112
|
+
* spec/docstring_spec.rb: Refactor docstring specs
|
113
|
+
|
114
|
+
2010-03-16 Loren Segal <lsegal@soen.ca>
|
115
|
+
|
116
|
+
* lib/yard/templates/helpers/html_helper.rb: Escape HTML inside <tt>/++
|
117
|
+
typewriter blocks
|
118
|
+
|
119
|
+
* lib/yard/parser/ruby/legacy/statement_list.rb,
|
120
|
+
spec/parser/source_parser_spec.rb: Fix parsing of =begin/=end comments with
|
121
|
+
multiple consecutive newlines in 1.8
|
122
|
+
|
123
|
+
2010-03-14 Loren Segal <lsegal@soen.ca>
|
124
|
+
|
125
|
+
* lib/yard.rb: Don't treat 1.9.0 as a true "1.9" Closes gh-97
|
126
|
+
|
127
|
+
* templates/default/class/setup.rb: Show child namespaces in class
|
128
|
+
documentation. Closes gh-98
|
129
|
+
|
130
|
+
* templates/default/fulldoc/html/js/app.js,
|
131
|
+
templates/default/fulldoc/html/js/full_list.js: Add "C", "M" and "F" keyboard
|
132
|
+
shorcuts to bring up class/method/file menus in non-frame mode. Also can
|
133
|
+
press escape to close menu. Closes gh-69
|
134
|
+
|
135
|
+
* lib/yard/cli/yardoc.rb, lib/yard/templates/helpers/html_helper.rb,
|
136
|
+
spec/templates/helpers/html_helper_spec.rb,
|
137
|
+
templates/default/fulldoc/html/frames.erb,
|
138
|
+
templates/default/fulldoc/html/full_list.erb,
|
139
|
+
templates/default/layout/html/headers.erb: Add --charset commandline option
|
140
|
+
for yardoc to generate HTML docs for a specific charset Closes gh-96
|
141
|
+
|
142
|
+
* lib/yard/code_objects/base.rb: Fix documentation for
|
143
|
+
CodeObjects::Base#method_missing
|
144
|
+
|
145
|
+
* lib/yard/templates/helpers/html_helper.rb: Fix method summary listing for
|
146
|
+
methods ending in =
|
147
|
+
|
148
|
+
* templates/default/module/html/method_summary.erb: Show method summary
|
149
|
+
heading when methods are inherited but none are defined in the class
|
150
|
+
|
151
|
+
* lib/yard/autoload.rb, lib/yard/handlers/ruby/legacy/process_handler.rb,
|
152
|
+
lib/yard/handlers/ruby/process_handler.rb,
|
153
|
+
spec/handlers/examples/process_handler_001.rb.txt,
|
154
|
+
spec/handlers/process_handler_spec.rb: Add handler for YARD process blocks
|
155
|
+
|
156
|
+
* lib/yard/autoload.rb, .../ruby/legacy/class_condition_handler.rb,
|
157
|
+
spec/handlers/class_condition_handler_spec.rb: Add class condition handler
|
158
|
+
for Ruby 1.8
|
159
|
+
|
160
|
+
* lib/yard/handlers/base.rb, lib/yard/handlers/ruby/alias_handler.rb,
|
161
|
+
lib/yard/handlers/ruby/attribute_handler.rb,
|
162
|
+
lib/yard/handlers/ruby/class_condition_handler.rb,
|
163
|
+
lib/yard/handlers/ruby/class_handler.rb,
|
164
|
+
lib/yard/handlers/ruby/class_variable_handler.rb,
|
165
|
+
lib/yard/handlers/ruby/constant_handler.rb,
|
166
|
+
lib/yard/handlers/ruby/exception_handler.rb,
|
167
|
+
lib/yard/handlers/ruby/legacy/alias_handler.rb,
|
168
|
+
lib/yard/handlers/ruby/legacy/attribute_handler.rb,
|
169
|
+
lib/yard/handlers/ruby/legacy/class_handler.rb,
|
170
|
+
.../handlers/ruby/legacy/class_variable_handler.rb,
|
171
|
+
lib/yard/handlers/ruby/legacy/constant_handler.rb,
|
172
|
+
lib/yard/handlers/ruby/legacy/exception_handler.rb,
|
173
|
+
lib/yard/handlers/ruby/legacy/method_handler.rb,
|
174
|
+
lib/yard/handlers/ruby/legacy/mixin_handler.rb,
|
175
|
+
lib/yard/handlers/ruby/legacy/module_handler.rb,
|
176
|
+
.../handlers/ruby/legacy/visibility_handler.rb,
|
177
|
+
lib/yard/handlers/ruby/legacy/yield_handler.rb,
|
178
|
+
lib/yard/handlers/ruby/method_condition_handler.rb,
|
179
|
+
lib/yard/handlers/ruby/method_handler.rb,
|
180
|
+
lib/yard/handlers/ruby/mixin_handler.rb,
|
181
|
+
lib/yard/handlers/ruby/module_handler.rb,
|
182
|
+
lib/yard/handlers/ruby/visibility_handler.rb,
|
183
|
+
lib/yard/handlers/ruby/yield_handler.rb: Add `process` directive to handlers
|
184
|
+
which defines the `process` method on the class inside an anonymous module to
|
185
|
+
make it easier to extend an existing handler with mixins.
|
186
|
+
|
187
|
+
* lib/yard/parser/ruby/legacy/statement.rb: Add line_range method
|
188
|
+
|
189
|
+
2010-01-29 Loren Segal <lsegal@soen.ca>
|
190
|
+
|
191
|
+
* lib/yard/cli/base.rb, lib/yard/cli/yard_graph.rb, lib/yard/cli/yardoc.rb,
|
192
|
+
lib/yard/cli/yri.rb: Gracefully handle invalid CLI options passed to
|
193
|
+
yardoc/yri/yard-graph Closes gh-74
|
194
|
+
|
195
|
+
* lib/yard/parser/ruby/legacy/statement_list.rb,
|
196
|
+
lib/yard/parser/ruby/ruby_parser.rb, spec/parser/source_parser_spec.rb: Add
|
197
|
+
support for =begin/=end comment strings
|
198
|
+
|
199
|
+
2010-01-25 Nathan Weizenbaum <nex342@gmail.com>
|
200
|
+
|
201
|
+
* lib/yard/templates/template.rb: When dealing with many overloaded
|
202
|
+
templates, include them in reverse order. This is necessary due to the way
|
203
|
+
Ruby's module inclusion works with inheritance. Including a module puts it
|
204
|
+
at the base of the inheritance chain. For example, if a class hierarchy
|
205
|
+
looks like A->B->C, and C includes D, then it looks like A->B->D->C. This
|
206
|
+
means that the base template, which is last in the full_paths list, should
|
207
|
+
actually be included first, so that it ends up farthest back in the
|
208
|
+
inheritance chain.
|
209
|
+
|
210
|
+
2010-01-18 Nathan Weizenbaum <nex342@gmail.com>
|
211
|
+
|
212
|
+
* lib/yard/autoload.rb, lib/yard/templates/erb_cache.rb,
|
213
|
+
lib/yard/templates/template.rb, spec/templates/template_spec.rb: Cache the
|
214
|
+
compiled ERB methods to speed up rendering time.
|
215
|
+
|
216
|
+
2010-01-22 Nathan Weizenbaum <nex342@gmail.com>
|
217
|
+
|
218
|
+
* lib/yard/templates/helpers/html_helper.rb: Allow a broader variety of names
|
219
|
+
for syntax highlighting. This is necessary to support some names for
|
220
|
+
Pygments.
|
221
|
+
|
222
|
+
2010-01-18 Nathan Weizenbaum <nex342@gmail.com>
|
223
|
+
|
224
|
+
* lib/yard/templates/helpers/html_helper.rb: HTML-escape text that isn't
|
225
|
+
syntax highlighted due to --no-highlight.
|
226
|
+
|
227
|
+
2010-01-11 Loren Segal <lsegal@soen.ca>
|
228
|
+
|
229
|
+
* README.md: Fix links in README
|
230
|
+
|
231
|
+
* templates/default/layout/html/setup.rb: Fix encoding issues when reading
|
232
|
+
extra files
|
233
|
+
|
234
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
235
|
+
spec/templates/helpers/html_helper_spec.rb: Fix typewrite issues
|
236
|
+
|
237
|
+
* README.md: Add info to changelog
|
238
|
+
|
239
|
+
* docs/WhatsNew.md: Update what's new
|
240
|
+
|
241
|
+
* README.md, lib/yard.rb, yard.gemspec: Bump version to 0.5.3
|
242
|
+
|
243
|
+
2010-01-07 Loren Segal <lsegal@soen.ca>
|
244
|
+
|
245
|
+
* lib/yard/templates/helpers/html_helper.rb: Fix typewriter text after RDoc
|
246
|
+
markup is generated
|
247
|
+
|
248
|
+
* .gitignore, Rakefile: Remove gem package Rake tasks and use simplified gem
|
249
|
+
build functionality
|
250
|
+
|
251
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
252
|
+
spec/templates/helpers/html_helper_spec.rb: Fix +text+ RDoc markup showing
|
253
|
+
\004 characters inside code blocks
|
254
|
+
|
255
|
+
2010-01-05 Loren Segal <lsegal@soen.ca>
|
256
|
+
|
257
|
+
* templates/default/layout/html/setup.rb: Use default markup provider for
|
258
|
+
extra files. Also add ability to override markup provider for files with no
|
259
|
+
extension. Add #!MARKUP shebang to first line of file. Closes gh-64
|
260
|
+
|
261
|
+
* templates/default/layout/html/setup.rb: Use raw HTML for .html extra files
|
262
|
+
|
263
|
+
* lib/yard/core_ext/string.rb: Fix camelcase bug Closes gh-65
|
264
|
+
|
265
|
+
2009-12-31 Loren Segal <lsegal@soen.ca>
|
266
|
+
|
267
|
+
* lib/rubygems_plugin.rb: Fix yard gem plugin in 1.8.x with multiple versions
|
268
|
+
of yard installed Closes gh-62
|
269
|
+
|
270
|
+
* lib/rubygems_plugin.rb: Fix has_yardoc accessor
|
271
|
+
|
272
|
+
* lib/rubygems_plugin.rb: Don't build yard index if yardoc will run
|
273
|
+
|
274
|
+
2009-12-29 Loren Segal <lsegal@soen.ca>
|
275
|
+
|
276
|
+
* lib/yard/core_ext/hash.rb, spec/core_ext/hash_spec.rb: Fix another Hash.[]
|
277
|
+
related issue to make sure array can be passed in as a key
|
278
|
+
|
279
|
+
* lib/yard/core_ext/hash.rb: Fix improper Hash.[] implementation Closes
|
280
|
+
gh-61
|
281
|
+
|
282
|
+
2009-12-28 Loren Segal <lsegal@soen.ca>
|
283
|
+
|
284
|
+
* lib/yard/templates/template.rb: Remove unused private method call
|
285
|
+
|
286
|
+
* lib/yard/templates/template.rb, spec/templates/engine_spec.rb,
|
287
|
+
spec/templates/template_spec.rb: Fix inclusion of overridden template paths
|
288
|
+
above format directory. Closes gh-60
|
289
|
+
|
290
|
+
* templates/default/fulldoc/html/setup.rb: Remove unecessary line
|
291
|
+
|
292
|
+
2009-12-25 Loren Segal <lsegal@soen.ca>
|
293
|
+
|
294
|
+
* templates/default/fulldoc/html/css/full_list.css: Fix css for arrows
|
295
|
+
|
296
|
+
* lib/yard/parser/c_parser.rb: Fix showing entire source file as comment for
|
297
|
+
class/module
|
298
|
+
|
299
|
+
* lib/yard/parser/c_parser.rb: Better linking of variable names to
|
300
|
+
class/modules
|
301
|
+
|
302
|
+
* templates/default/layout/html/breadcrumb.erb: Show proxies namespaces in
|
303
|
+
small in breadcrumb
|
304
|
+
|
305
|
+
* templates/default/fulldoc/html/setup.rb: Show objects from proxies
|
306
|
+
namespaces
|
307
|
+
|
308
|
+
* lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Add --incremental to
|
309
|
+
generate only new objects parsed in changed files. Using yardoc -c alone will
|
310
|
+
now use the cached yardoc but will generate all objects
|
311
|
+
|
312
|
+
* yard.gemspec: Fix reloading of yard in Rakefile (1.8)
|
313
|
+
|
314
|
+
2009-12-24 Loren Segal <lsegal@soen.ca>
|
315
|
+
|
316
|
+
* lib/rubygems_plugin.rb: Improve Rubygems plugin behaviour and generate
|
317
|
+
.yardoc db for yri
|
318
|
+
|
319
|
+
* lib/yard/parser/ruby/legacy/statement_list.rb,
|
320
|
+
lib/yard/parser/ruby/ruby_parser.rb, spec/parser/source_parser_spec.rb: Unify
|
321
|
+
comment parsing behaviour between 1.8/1.9
|
322
|
+
|
323
|
+
* templates/default/fulldoc/html/js/full_list.js: Make any click to the left
|
324
|
+
of an arrow expand the tree rather than select the item
|
325
|
+
|
326
|
+
* templates/default/fulldoc/html/css/full_list.css,
|
327
|
+
templates/default/fulldoc/html/css/style.css,
|
328
|
+
templates/default/fulldoc/html/full_list.erb,
|
329
|
+
templates/default/fulldoc/html/full_list_class.erb,
|
330
|
+
templates/default/fulldoc/html/full_list_files.erb,
|
331
|
+
.../default/fulldoc/html/full_list_methods.erb,
|
332
|
+
templates/default/fulldoc/html/js/full_list.js,
|
333
|
+
templates/default/fulldoc/html/setup.rb: Add tree view implementation for
|
334
|
+
class list
|
335
|
+
|
336
|
+
* spec/code_objects/base_spec.rb, spec/templates/helpers/html_helper_spec.rb:
|
337
|
+
Fix specs (disable a broken one temporarily)
|
338
|
+
|
339
|
+
* templates/default/class/setup.rb: Don't show subclasses for Object
|
340
|
+
|
341
|
+
* lib/yard/templates/helpers/html_helper.rb: Use relative path for link
|
342
|
+
title. Also add more appropriate title tag
|
343
|
+
|
344
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
345
|
+
spec/templates/helpers/html_helper_spec.rb: Update #resolve_links to work
|
346
|
+
with ({Name}) syntax. Add specs
|
347
|
+
|
348
|
+
* lib/yard/code_objects/class_object.rb: Fix behaviour of
|
349
|
+
ClassObject#superclass=
|
350
|
+
|
351
|
+
* lib/yard/code_objects/base.rb, spec/code_objects/base_spec.rb: Add
|
352
|
+
Base#relative_path to return relative namespace path of two objects
|
353
|
+
|
354
|
+
* lib/yard/code_objects/base.rb, spec/code_objects/base_spec.rb: Add check
|
355
|
+
for creating objects with empty name
|
356
|
+
|
357
|
+
* lib/yard/parser/source_parser.rb: Force encoding to source file's encoding
|
358
|
+
(using # coding shebang line) to properly parse source
|
359
|
+
|
360
|
+
* benchmarks/parsing.rb, lib/yard/cli/yardoc.rb,
|
361
|
+
lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb,
|
362
|
+
spec/spec_helper.rb: Add --exclude REGEXP to yardoc to ignore paths with a
|
363
|
+
regexp match. yardoc --exclude '_spec\.rb$' will ignore any file ending in
|
364
|
+
_spec.rb
|
365
|
+
|
366
|
+
2009-12-23 Loren Segal <lsegal@soen.ca>
|
367
|
+
|
368
|
+
* spec/templates/examples/module001.html, spec/templates/module_spec.rb,
|
369
|
+
templates/default/module/html/constant_summary.erb: Fix anchor for constants
|
370
|
+
|
371
|
+
* spec/templates/examples/class001.html,
|
372
|
+
spec/templates/examples/class001.txt,
|
373
|
+
templates/default/class/html/subclasses.erb,
|
374
|
+
templates/default/class/setup.rb,
|
375
|
+
templates/default/class/text/subclasses.erb: Fix subclasses not showing in
|
376
|
+
documentation
|
377
|
+
|
378
|
+
2009-12-22 Loren Segal <lsegal@soen.ca>
|
379
|
+
|
380
|
+
* templates/default/fulldoc/html/full_list.erb: Move links below header
|
381
|
+
|
382
|
+
* templates/default/fulldoc/html/js/app.js: Make summary links work within
|
383
|
+
frames
|
384
|
+
|
385
|
+
* templates/default/fulldoc/html/full_list.erb,
|
386
|
+
templates/default/layout/html/layout.erb: Add frames class name immediately
|
387
|
+
(improves UI responsiveness)
|
388
|
+
|
389
|
+
* templates/default/fulldoc/html/css/full_list.css,
|
390
|
+
templates/default/fulldoc/html/css/style.css,
|
391
|
+
templates/default/fulldoc/html/frames.erb,
|
392
|
+
templates/default/fulldoc/html/full_list.erb,
|
393
|
+
templates/default/fulldoc/html/js/app.js,
|
394
|
+
templates/default/fulldoc/html/js/full_list.js,
|
395
|
+
templates/default/fulldoc/html/setup.rb,
|
396
|
+
templates/default/layout/html/breadcrumb.erb,
|
397
|
+
templates/default/layout/html/search.erb: Add classical frameset view to docs
|
398
|
+
as frames.html
|
399
|
+
|
400
|
+
2009-12-20 Loren Segal <lsegal@soen.ca>
|
401
|
+
|
402
|
+
* lib/yard/handlers/ruby/legacy/method_handler.rb: Fix bug in 1.8 handler
|
403
|
+
|
404
|
+
* lib/yard/core_ext/file.rb, lib/yard/parser/source_parser.rb,
|
405
|
+
spec/code_objects/base_spec.rb, spec/parser/source_parser_spec.rb: Add
|
406
|
+
File.read_binary to fix specs
|
407
|
+
|
408
|
+
* lib/yard/handlers/ruby/attribute_handler.rb,
|
409
|
+
lib/yard/handlers/ruby/legacy/attribute_handler.rb,
|
410
|
+
lib/yard/handlers/ruby/legacy/method_handler.rb,
|
411
|
+
lib/yard/handlers/ruby/method_handler.rb,
|
412
|
+
lib/yard/templates/helpers/html_helper.rb,
|
413
|
+
spec/handlers/attribute_handler_spec.rb,
|
414
|
+
.../handlers/examples/attribute_handler_001.rb.txt,
|
415
|
+
spec/handlers/examples/method_handler_001.rb.txt,
|
416
|
+
spec/handlers/method_handler_spec.rb, spec/templates/examples/module001.html,
|
417
|
+
templates/default/module/html/item_summary.erb: When a reader/writer method
|
418
|
+
is defined alongside an attribute, mark it as part of attribute
|
419
|
+
|
420
|
+
* lib/yard/cli/base.rb, lib/yard/cli/yard_graph.rb, lib/yard/cli/yardoc.rb,
|
421
|
+
lib/yard/cli/yri.rb, lib/yard/logging.rb: Show backtraces by default outside
|
422
|
+
of CLI classes
|
423
|
+
|
424
|
+
* lib/yard/code_objects/method_object.rb,
|
425
|
+
lib/yard/templates/helpers/html_helper.rb,
|
426
|
+
spec/code_objects/method_object_spec.rb,
|
427
|
+
spec/templates/examples/module001.dot,
|
428
|
+
spec/templates/examples/module001.html, spec/templates/module_spec.rb,
|
429
|
+
templates/default/module/dot/info.erb,
|
430
|
+
.../default/module/html/attribute_details.erb,
|
431
|
+
templates/default/module/html/item_summary.erb: Add MethodObject#attr_info
|
432
|
+
and do not show '=' in attribute's method summary signature
|
433
|
+
|
434
|
+
2009-12-17 Loren Segal <lsegal@soen.ca>
|
435
|
+
|
436
|
+
* lib/yard/parser/source_parser.rb: Read source in binary mode to be encoding
|
437
|
+
safe
|
438
|
+
|
1
439
|
2009-12-16 Loren Segal <lsegal@soen.ca>
|
2
440
|
|
441
|
+
* lib/yard/cli/yardoc.rb: Fix behaviour for --build-gems Closes gh-56
|
442
|
+
|
443
|
+
* lib/yard/cli/yardoc.rb: Don't build a gem if there is no yardoc path for
|
444
|
+
gem
|
445
|
+
|
3
446
|
* ChangeLog, lib/yard.rb, yard.gemspec: Bump version to 0.5.2
|
4
447
|
|
5
448
|
* lib/yard/cli/yri.rb, lib/yard/core_ext/file.rb, lib/yard/registry_store.rb,
|
data/README.md
CHANGED
@@ -1,11 +1,11 @@
|
|
1
|
-
YARD Release 0.5.
|
1
|
+
YARD Release 0.5.4 "The Longest" (Mar 22nd 2010)
|
2
2
|
================================================
|
3
3
|
|
4
4
|
**Homepage**: [http://yardoc.org](http://yardoc.org)
|
5
5
|
**IRC**: **Join us on IRC in #yard on irc.freenode.net!**
|
6
6
|
**Git**: [http://github.com/lsegal/yard](http://github.com/lsegal/yard)
|
7
7
|
**Author**: Loren Segal
|
8
|
-
**Copyright**: 2007-
|
8
|
+
**Copyright**: 2007-2010
|
9
9
|
**License**: MIT License
|
10
10
|
|
11
11
|
|
@@ -222,6 +222,9 @@ More options can be seen by typing `yard-graph --help`, but here is an example:
|
|
222
222
|
CHANGELOG
|
223
223
|
---------
|
224
224
|
|
225
|
+
- **March.22.10**: 0.5.4 release
|
226
|
+
- See {file:docs/WhatsNew.md what's new document} for changes
|
227
|
+
|
225
228
|
- **January.11.10**: 0.5.3 release
|
226
229
|
- See {file:docs/WhatsNew.md what's new document} for changes
|
227
230
|
|