yard 0.4.0 → 0.5.0
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 +585 -1
- data/README.md +10 -2
- data/benchmarks/yri_cache.rb +19 -0
- data/bin/yri +1 -26
- data/docs/WhatsNew.md +99 -0
- data/lib/rubygems_plugin.rb +2 -0
- data/lib/yard.rb +2 -2
- data/lib/yard/autoload.rb +9 -4
- data/lib/yard/cli/base.rb +26 -0
- data/lib/yard/cli/yard_graph.rb +2 -9
- data/lib/yard/cli/yardoc.rb +93 -33
- data/lib/yard/cli/yri.rb +128 -0
- data/lib/yard/code_objects/base.rb +16 -5
- data/lib/yard/code_objects/class_object.rb +11 -4
- data/lib/yard/code_objects/method_object.rb +11 -1
- data/lib/yard/code_objects/proxy.rb +5 -2
- data/lib/yard/code_objects/root_object.rb +1 -0
- data/lib/yard/core_ext/file.rb +1 -1
- data/lib/yard/core_ext/hash.rb +15 -0
- data/lib/yard/core_ext/module.rb +2 -2
- data/lib/yard/core_ext/string.rb +66 -0
- data/lib/yard/core_ext/symbol_hash.rb +1 -1
- data/lib/yard/docstring.rb +5 -5
- data/lib/yard/handlers/base.rb +10 -4
- data/lib/yard/handlers/processor.rb +3 -4
- data/lib/yard/handlers/ruby/attribute_handler.rb +3 -2
- data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +2 -2
- data/lib/yard/handlers/ruby/legacy/method_handler.rb +7 -1
- data/lib/yard/handlers/ruby/method_handler.rb +7 -1
- data/lib/yard/logging.rb +11 -1
- data/lib/yard/parser/c_parser.rb +407 -0
- data/lib/yard/parser/ruby/ast_node.rb +2 -2
- data/lib/yard/parser/ruby/legacy/ruby_lex.rb +3 -4
- data/lib/yard/parser/source_parser.rb +18 -7
- data/lib/yard/rake/yardoc_task.rb +1 -1
- data/lib/yard/registry.rb +83 -29
- data/lib/yard/registry_store.rb +213 -0
- data/lib/yard/serializers/base.rb +1 -1
- data/lib/yard/serializers/yardoc_serializer.rb +113 -0
- data/lib/yard/tags/library.rb +4 -0
- data/lib/yard/tags/overload_tag.rb +16 -5
- data/lib/yard/tags/tag.rb +1 -2
- data/lib/yard/templates/engine.rb +3 -3
- data/lib/yard/templates/helpers/html_helper.rb +50 -16
- data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +1 -3
- data/lib/yard/templates/helpers/html_syntax_highlight_helper18.rb +1 -3
- data/lib/yard/templates/helpers/method_helper.rb +11 -4
- data/lib/yard/templates/helpers/text_helper.rb +24 -2
- data/lib/yard/verifier.rb +3 -3
- data/spec/cli/yardoc_spec.rb +33 -6
- data/spec/cli/yri_spec.rb +30 -0
- data/spec/code_objects/base_spec.rb +7 -0
- data/spec/code_objects/class_object_spec.rb +6 -1
- data/spec/code_objects/method_object_spec.rb +25 -0
- data/spec/core_ext/hash_spec.rb +10 -0
- data/spec/core_ext/module_spec.rb +1 -1
- data/spec/core_ext/string_spec.rb +50 -12
- data/spec/handlers/attribute_handler_spec.rb +4 -0
- data/spec/handlers/examples/method_handler_001.rb.txt +9 -0
- data/spec/handlers/method_handler_spec.rb +22 -4
- data/spec/parser/c_parser_spec.rb +22 -0
- data/spec/parser/examples/array.c.txt +3887 -0
- data/spec/parser/source_parser_spec.rb +29 -7
- data/spec/registry_spec.rb +93 -72
- data/spec/registry_store_spec.rb +184 -0
- data/spec/serializers/file_system_serializer_spec.rb +96 -75
- data/spec/spec_helper.rb +2 -2
- data/spec/tags/overload_tag_spec.rb +18 -0
- data/spec/templates/examples/class001.html +32 -30
- data/spec/templates/examples/method001.html +4 -1
- data/spec/templates/examples/method002.html +7 -2
- data/spec/templates/examples/method002.txt +1 -1
- data/spec/templates/examples/method003.html +30 -8
- data/spec/templates/examples/method003.txt +4 -4
- data/spec/templates/examples/method004.html +44 -0
- data/spec/templates/examples/method004.txt +10 -0
- data/spec/templates/examples/method005.html +99 -0
- data/spec/templates/examples/method005.txt +33 -0
- data/spec/templates/examples/module001.dot +1 -1
- data/spec/templates/examples/module001.html +391 -37
- data/spec/templates/examples/module001.txt +1 -1
- data/spec/templates/helpers/base_helper_spec.rb +2 -2
- data/spec/templates/helpers/html_helper_spec.rb +83 -0
- data/spec/templates/helpers/method_helper_spec.rb +47 -0
- data/spec/templates/helpers/shared_signature_examples.rb +102 -0
- data/spec/templates/helpers/text_helper_spec.rb +31 -0
- data/spec/templates/method_spec.rb +43 -18
- data/spec/templates/module_spec.rb +22 -1
- data/spec/templates/spec_helper.rb +10 -1
- data/spec/yard_spec.rb +4 -3
- data/templates/default/class/html/constructor_details.erb +1 -1
- data/templates/default/docstring/html/returns_void.erb +1 -0
- data/templates/default/docstring/setup.rb +9 -4
- data/templates/default/docstring/text/returns_void.erb +1 -0
- data/templates/default/fulldoc/html/css/style.css +4 -2
- data/templates/default/fulldoc/html/full_list.erb +2 -2
- data/templates/default/fulldoc/html/js/app.js +1 -1
- data/templates/default/fulldoc/html/setup.rb +14 -6
- data/templates/default/layout/dot/setup.rb +1 -1
- data/templates/default/layout/html/breadcrumb.erb +2 -2
- data/templates/default/layout/html/index.erb +2 -2
- data/templates/default/layout/html/setup.rb +5 -5
- data/templates/default/method/html/header.erb +6 -4
- data/templates/default/method_details/html/method_signature.erb +2 -1
- data/templates/default/method_details/html/source.erb +1 -1
- data/templates/default/method_details/setup.rb +2 -1
- data/templates/default/method_details/text/setup.rb +1 -1
- data/templates/default/module/html/attribute_details.erb +4 -4
- data/templates/default/module/html/attribute_summary.erb +3 -3
- data/templates/default/module/html/box_info.erb +2 -2
- data/templates/default/module/html/defines.erb +1 -1
- data/templates/default/module/html/inherited_constants.erb +1 -1
- data/templates/default/module/html/inherited_methods.erb +1 -1
- data/templates/default/module/html/item_summary.erb +13 -4
- data/templates/default/module/html/method_details_list.erb +5 -4
- data/templates/default/module/html/method_summary.erb +5 -4
- data/templates/default/module/html/methodmissing.erb +1 -1
- data/templates/default/module/setup.rb +14 -5
- data/templates/default/tags/html/overload.erb +3 -2
- data/templates/default/tags/setup.rb +4 -0
- metadata +23 -2
data/ChangeLog
CHANGED
@@ -1,6 +1,590 @@
|
|
1
|
+
2009-12-14 Loren Segal <lsegal@soen.ca>
|
2
|
+
|
3
|
+
* ChangeLog, README.md, docs/WhatsNew.md, lib/yard.rb, yard.gemspec: Bump
|
4
|
+
version to 0.5.0
|
5
|
+
|
6
|
+
* lib/yard/parser/c_parser.rb: Add auto-type support for Class in native code
|
7
|
+
|
8
|
+
2009-12-13 Loren Segal <lsegal@soen.ca>
|
9
|
+
|
10
|
+
* lib/yard/cli/yardoc.rb, lib/yard/logging.rb, lib/yard/registry.rb: When
|
11
|
+
yardoc --use-cache is specified, generate only the objects parsed from
|
12
|
+
changed files
|
13
|
+
|
14
|
+
* lib/yard/cli/yardoc.rb, lib/yard/registry.rb: Update behaviour for
|
15
|
+
--build-gems, Registry.yardoc_file_for_gem, add --re-build-gems to force
|
16
|
+
building of all gems
|
17
|
+
|
18
|
+
* lib/yard/registry_store.rb: Document RegistryStore
|
19
|
+
|
20
|
+
* lib/yard/cli/base.rb: Document CLI::Base
|
21
|
+
|
22
|
+
* lib/rubygems_plugin.rb, lib/yard/core_ext/file.rb,
|
23
|
+
lib/yard/handlers/base.rb, lib/yard/parser/ruby/legacy/ruby_lex.rb,
|
24
|
+
lib/yard/parser/source_parser.rb: Fix various warnings in ruby -w Closes
|
25
|
+
gh-55
|
26
|
+
|
27
|
+
* lib/yard/core_ext/hash.rb, spec/core_ext/hash_spec.rb: Backport Hash[arr]
|
28
|
+
1.8.7+ behaviour to 1.8.6
|
29
|
+
|
30
|
+
* lib/yard/registry_store.rb, spec/registry_store_spec.rb: Add more specs to
|
31
|
+
RegistryStore
|
32
|
+
|
33
|
+
* lib/yard/parser/source_parser.rb, lib/yard/registry.rb,
|
34
|
+
spec/parser/source_parser_spec.rb: Move checksum code into
|
35
|
+
Registry#checksum_for
|
36
|
+
|
37
|
+
* lib/yard/cli/yri.rb, spec/cli/yri_spec.rb: Don't cache Registry.yardoc_file
|
38
|
+
in yri lookups
|
39
|
+
|
40
|
+
* lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb: Add
|
41
|
+
checking of checksum cache when parsing files
|
42
|
+
|
43
|
+
* lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Streamline merge/cache
|
44
|
+
options into -c (--use-cache) to reload existing yardoc db and merge the
|
45
|
+
results. Adding -c will also do incremental parsing on files using against a
|
46
|
+
SHA1 checksum of the file contents to speed up parse time. TODO: incremental
|
47
|
+
generation of HTML files.
|
48
|
+
|
49
|
+
* lib/yard/registry.rb, lib/yard/registry_store.rb,
|
50
|
+
lib/yard/serializers/yardoc_serializer.rb, spec/registry_store_spec.rb: Add
|
51
|
+
loading/saving of RegistryStore#checksums
|
52
|
+
|
53
|
+
* lib/yard/parser/c_parser.rb: Add extra types recognition for Array
|
54
|
+
|
55
|
+
* lib/yard/parser/c_parser.rb: Improve types recognition for C call-seqs
|
56
|
+
|
57
|
+
* spec/templates/examples/method003.html,
|
58
|
+
spec/templates/examples/method005.html,
|
59
|
+
spec/templates/examples/module001.html,
|
60
|
+
templates/default/method_details/setup.rb: Fix source not showing for
|
61
|
+
overloaded methods
|
62
|
+
|
63
|
+
* lib/yard/templates/helpers/html_helper.rb: Fix linking of default return
|
64
|
+
type in signature
|
65
|
+
|
66
|
+
* lib/yard/templates/helpers/html_helper.rb: Properly linkify default return
|
67
|
+
type
|
68
|
+
|
69
|
+
* lib/yard/tags/overload_tag.rb, spec/tags/overload_tag_spec.rb: Fix
|
70
|
+
OverloadTag when parsing signature starting with 'def'
|
71
|
+
|
72
|
+
* lib/yard/parser/c_parser.rb: Improve parsing of native call-seq
|
73
|
+
|
74
|
+
2009-12-12 Loren Segal <lsegal@soen.ca>
|
75
|
+
|
76
|
+
* spec/templates/examples/method001.html,
|
77
|
+
spec/templates/examples/method002.html,
|
78
|
+
spec/templates/examples/method003.html,
|
79
|
+
spec/templates/examples/method004.html,
|
80
|
+
spec/templates/examples/method005.html,
|
81
|
+
templates/default/method/html/header.erb: Fix view source link not showing
|
82
|
+
for individual method page
|
83
|
+
|
84
|
+
* lib/yard/code_objects/class_object.rb, lib/yard/parser/c_parser.rb,
|
85
|
+
spec/code_objects/class_object_spec.rb,
|
86
|
+
templates/default/module/html/box_info.erb: Add support for BasicObject class
|
87
|
+
as parent of Object
|
88
|
+
|
89
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
90
|
+
templates/default/fulldoc/html/setup.rb,
|
91
|
+
templates/default/layout/html/index.erb,
|
92
|
+
templates/default/layout/html/setup.rb: Fix displaying of README filenames in
|
93
|
+
the form README.lang.ext
|
94
|
+
|
95
|
+
* lib/yard/serializers/yardoc_serializer.rb: Remove unique object
|
96
|
+
serialization tricks in YardocSerializer (marshal handles this)
|
97
|
+
|
98
|
+
* lib/yard/registry_store.rb, spec/registry_store_spec.rb: Add specs for
|
99
|
+
RegistryStore#load returning true/false
|
100
|
+
|
101
|
+
* lib/yard/registry_store.rb: Registry.load_yardoc should return true if
|
102
|
+
.yardoc loads
|
103
|
+
|
104
|
+
* lib/yard/registry_store.rb, spec/registry_store_spec.rb: Always load root
|
105
|
+
object first when loading .yardoc
|
106
|
+
|
107
|
+
* lib/yard/registry_store.rb: Treat :root and empty string as equivalent in
|
108
|
+
RegistryStore#get
|
109
|
+
|
110
|
+
* lib/yard/handlers/processor.rb, lib/yard/logging.rb,
|
111
|
+
templates/default/fulldoc/html/setup.rb: Add Logger#backtrace to show
|
112
|
+
backtraces only if Logger#show_backtraces is set. Enables --backtrace in CLI
|
113
|
+
classes.
|
114
|
+
|
115
|
+
* lib/yard/code_objects/base.rb, lib/yard/code_objects/proxy.rb,
|
116
|
+
lib/yard/code_objects/root_object.rb, lib/yard/handlers/base.rb,
|
117
|
+
lib/yard/parser/c_parser.rb, lib/yard/templates/helpers/html_helper.rb,
|
118
|
+
templates/default/fulldoc/html/full_list.erb,
|
119
|
+
templates/default/layout/dot/setup.rb,
|
120
|
+
templates/default/layout/html/breadcrumb.erb,
|
121
|
+
templates/default/layout/html/index.erb,
|
122
|
+
templates/default/layout/html/setup.rb,
|
123
|
+
templates/default/method_details/text/setup.rb,
|
124
|
+
templates/default/module/html/box_info.erb: Don't test against actual
|
125
|
+
Registry.root, instead check if object is a RootObject (through #root?)
|
126
|
+
|
127
|
+
* lib/yard/code_objects/method_object.rb: Make sure parent of method is a
|
128
|
+
namespace
|
129
|
+
|
130
|
+
* lib/yard/cli/yri.rb: Current path's .yardoc should be first in the search
|
131
|
+
path for yri
|
132
|
+
|
133
|
+
* lib/yard/autoload.rb, lib/yard/cli/base.rb, lib/yard/cli/yard_graph.rb,
|
134
|
+
lib/yard/cli/yardoc.rb, lib/yard/cli/yri.rb: Refactor CLI classes into
|
135
|
+
subclass of CLI::Base to get common options
|
136
|
+
|
137
|
+
2009-12-11 Loren Segal <lsegal@soen.ca>
|
138
|
+
|
139
|
+
* lib/yard/docstring.rb, lib/yard/tags/library.rb: Docstring object should
|
140
|
+
not keep tag factory instance in an instance variable
|
141
|
+
|
142
|
+
* lib/yard/serializers/yardoc_serializer.rb: Better dumping on a
|
143
|
+
StubProxy/CodeObject
|
144
|
+
|
145
|
+
* lib/yard/registry_store.rb, lib/yard/serializers/yardoc_serializer.rb: Load
|
146
|
+
entire yardoc db before calling keys/values
|
147
|
+
|
148
|
+
* lib/yard/registry.rb, lib/yard/registry_store.rb: get('') and get(:root)
|
149
|
+
should both get root object
|
150
|
+
|
151
|
+
* lib/yard/serializers/yardoc_serializer.rb: Cache object that StubProxy is
|
152
|
+
pointing to (saves a lookup) but don't serialize cached object.
|
153
|
+
|
154
|
+
* lib/yard/serializers/yardoc_serializer.rb: Minor refactoring
|
155
|
+
|
156
|
+
* benchmarks/yri_cache.rb, lib/yard/cli/yri.rb: Add caching to yri with a
|
157
|
+
benchmark to illustrate speedup results
|
158
|
+
|
159
|
+
* lib/yard/registry.rb, spec/registry_spec.rb, spec/registry_store_spec.rb:
|
160
|
+
Add specs for RegistryStore
|
161
|
+
|
162
|
+
* spec/registry_spec.rb: Refactor Registry specs
|
163
|
+
|
164
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
165
|
+
.../helpers/html_syntax_highlight_helper.rb,
|
166
|
+
.../helpers/html_syntax_highlight_helper18.rb,
|
167
|
+
spec/templates/helpers/html_helper_spec.rb: Can now opt out of syntax
|
168
|
+
highlighting on an indented block by putting "!!!plain" alone on the first
|
169
|
+
line of the block. For example: !!!plain non-ruby code here Also allows
|
170
|
+
adding support for highlighting multiple languages. The prefix !!!NAME will
|
171
|
+
call the method "html_syntax_highlight_NAME" with the source. This is how
|
172
|
+
"!!!ruby" works, for instance. Thanks lriesterer for the initial patch.
|
173
|
+
|
174
|
+
2009-12-10 Loren Segal <lsegal@soen.ca>
|
175
|
+
|
176
|
+
* lib/yard/handlers/ruby/attribute_handler.rb,
|
177
|
+
spec/handlers/attribute_handler_spec.rb: Handle attr* call with no arguments
|
178
|
+
|
179
|
+
* lib/yard/code_objects/class_object.rb: Fix handling of
|
180
|
+
ClassObject#superclass
|
181
|
+
|
182
|
+
* lib/yard/code_objects/class_object.rb: Fix handling of
|
183
|
+
ClassObject#superclass
|
184
|
+
|
185
|
+
* lib/yard/handlers/ruby/attribute_handler.rb,
|
186
|
+
spec/handlers/attribute_handler_spec.rb: Handle attr* call with no arguments
|
187
|
+
|
188
|
+
* lib/yard/cli/yardoc.rb: Change message for --build-gems
|
189
|
+
|
190
|
+
* lib/yard/cli/yri.rb: yri can now use the new .yardoc format for index
|
191
|
+
|
192
|
+
* lib/yard/cli/yardoc.rb, lib/yard/registry.rb: Fix --build-gem to use new
|
193
|
+
.yardoc format for index
|
194
|
+
|
195
|
+
2009-12-09 Loren Segal <lsegal@soen.ca>
|
196
|
+
|
197
|
+
* spec/parser/source_parser_spec.rb: Fix specs for YARD.parse and directories
|
198
|
+
|
199
|
+
* spec/parser/source_parser_spec.rb: Fix specs for YARD.parse and directories
|
200
|
+
|
201
|
+
2009-12-08 Loren Segal <lsegal@soen.ca>
|
202
|
+
|
203
|
+
* lib/yard/cli/yardoc.rb, lib/yard/cli/yri.rb, lib/yard/registry.rb: Add
|
204
|
+
implementation to write index for YRI. Should be merged into .yardoc /
|
205
|
+
Registry
|
206
|
+
|
207
|
+
* lib/yard.rb, spec/yard_spec.rb: Only load latest version of any Gem plugin
|
208
|
+
|
209
|
+
* lib/yard/cli/yri.rb: Add debugging messages to YRI
|
210
|
+
|
211
|
+
* lib/yard/cli/yardoc.rb: Add --merge to merge parsed data into existing
|
212
|
+
.yardoc file (specified with -b)
|
213
|
+
|
214
|
+
* lib/yard/cli/yardoc.rb: Add --build-gems to build .yardoc file for gems
|
215
|
+
|
216
|
+
* lib/yard/cli/yri.rb, lib/yard/registry.rb: Add Registry.yardoc_file_for_gem
|
217
|
+
|
218
|
+
* bin/yri, lib/yard/autoload.rb, lib/yard/cli/yri.rb: Refactor yri bin into
|
219
|
+
CLI::YRI
|
220
|
+
|
221
|
+
* templates/default/fulldoc/html/setup.rb: Handle errors during HTML
|
222
|
+
generation
|
223
|
+
|
224
|
+
* lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Fix call-seq
|
225
|
+
handling
|
226
|
+
|
227
|
+
* lib/yard/code_objects/base.rb: Fix exception being thrown for source with
|
228
|
+
no spaces
|
229
|
+
|
230
|
+
* lib/yard/cli/yardoc.rb: Ignore comments in .document file
|
231
|
+
|
232
|
+
* lib/yard/code_objects/base.rb, lib/yard/parser/c_parser.rb,
|
233
|
+
.../helpers/html_syntax_highlight_helper.rb,
|
234
|
+
.../helpers/html_syntax_highlight_helper18.rb,
|
235
|
+
spec/code_objects/base_spec.rb,
|
236
|
+
templates/default/method_details/html/source.erb: Add
|
237
|
+
CodeObjects::Base#source_type to set source type (:ruby or :c), only
|
238
|
+
highlight for Ruby code
|
239
|
+
|
240
|
+
2009-12-07 Loren Segal <lsegal@soen.ca>
|
241
|
+
|
242
|
+
* lib/yard/parser/c_parser.rb: Add support for one-line call-seq:
|
243
|
+
|
244
|
+
* lib/yard/cli/yardoc.rb, lib/yard/parser/source_parser.rb,
|
245
|
+
spec/cli/yardoc_spec.rb: Add ext/**/*.c to default parse glob
|
246
|
+
|
247
|
+
* spec/parser/source_parser_spec.rb: Remove warning spec for C/C++ files
|
248
|
+
|
249
|
+
* lib/yard/autoload.rb, lib/yard/parser/c_parser.rb,
|
250
|
+
lib/yard/parser/source_parser.rb, spec/parser/c_parser_spec.rb,
|
251
|
+
spec/parser/examples/array.c.txt, spec/spec_helper.rb: Initial C parser
|
252
|
+
implementation
|
253
|
+
|
254
|
+
2009-12-08 Loren Segal <lsegal@soen.ca>
|
255
|
+
|
256
|
+
* lib/yard/cli/yardoc.rb, lib/yard/cli/yri.rb, lib/yard/registry.rb: Add
|
257
|
+
implementation to write index for YRI. Should be merged into .yardoc /
|
258
|
+
Registry
|
259
|
+
|
260
|
+
* lib/yard.rb, spec/yard_spec.rb: Only load latest version of any Gem plugin
|
261
|
+
|
262
|
+
* lib/yard/cli/yri.rb: Add debugging messages to YRI
|
263
|
+
|
264
|
+
* lib/yard/cli/yardoc.rb: Add --merge to merge parsed data into existing
|
265
|
+
.yardoc file (specified with -b)
|
266
|
+
|
267
|
+
* lib/yard/cli/yardoc.rb: Add --build-gems to build .yardoc file for gems
|
268
|
+
|
269
|
+
* lib/yard/cli/yri.rb, lib/yard/registry.rb: Add Registry.yardoc_file_for_gem
|
270
|
+
|
271
|
+
* bin/yri, lib/yard/autoload.rb, lib/yard/cli/yri.rb: Refactor yri bin into
|
272
|
+
CLI::YRI
|
273
|
+
|
274
|
+
* templates/default/fulldoc/html/setup.rb: Handle errors during HTML
|
275
|
+
generation
|
276
|
+
|
277
|
+
* lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Fix call-seq
|
278
|
+
handling
|
279
|
+
|
280
|
+
* lib/yard/code_objects/base.rb: Fix exception being thrown for source with
|
281
|
+
no spaces
|
282
|
+
|
283
|
+
* lib/yard/cli/yardoc.rb: Ignore comments in .document file
|
284
|
+
|
285
|
+
* lib/yard/code_objects/base.rb, lib/yard/parser/c_parser.rb,
|
286
|
+
.../helpers/html_syntax_highlight_helper.rb,
|
287
|
+
.../helpers/html_syntax_highlight_helper18.rb,
|
288
|
+
spec/code_objects/base_spec.rb,
|
289
|
+
templates/default/method_details/html/source.erb: Add
|
290
|
+
CodeObjects::Base#source_type to set source type (:ruby or :c), only
|
291
|
+
highlight for Ruby code
|
292
|
+
|
293
|
+
2009-12-07 Loren Segal <lsegal@soen.ca>
|
294
|
+
|
295
|
+
* lib/yard/parser/c_parser.rb: Add support for one-line call-seq:
|
296
|
+
|
297
|
+
* lib/yard/cli/yardoc.rb, lib/yard/parser/source_parser.rb,
|
298
|
+
spec/cli/yardoc_spec.rb: Add ext/**/*.c to default parse glob
|
299
|
+
|
300
|
+
* spec/parser/source_parser_spec.rb: Remove warning spec for C/C++ files
|
301
|
+
|
302
|
+
* lib/yard/autoload.rb, lib/yard/parser/c_parser.rb,
|
303
|
+
lib/yard/parser/source_parser.rb, spec/parser/c_parser_spec.rb,
|
304
|
+
spec/parser/examples/array.c.txt, spec/spec_helper.rb: Initial C parser
|
305
|
+
implementation
|
306
|
+
|
307
|
+
2009-12-08 Loren Segal <lsegal@soen.ca>
|
308
|
+
|
309
|
+
* lib/yard/parser/source_parser.rb: If a directory is given to YARD.parse,
|
310
|
+
make it a file glob instead.
|
311
|
+
|
312
|
+
* lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Add better tokenization
|
313
|
+
support in .yardoc file (support quoted multi-space tokens) You should now
|
314
|
+
be able to set a long title with: --title "Foo Bar"
|
315
|
+
|
316
|
+
* lib/yard/core_ext/string.rb, spec/core_ext/string_spec.rb: Add
|
317
|
+
String#shell_split to split text into tokens like a shell does (respecting
|
318
|
+
quoted tokens)
|
319
|
+
|
320
|
+
* spec/core_ext/string_spec.rb: Refactor string specifications
|
321
|
+
|
322
|
+
2009-12-07 Loren Segal <lsegal@soen.ca>
|
323
|
+
|
324
|
+
* spec/templates/examples/class001.html,
|
325
|
+
spec/templates/examples/method004.html,
|
326
|
+
spec/templates/examples/method004.txt,
|
327
|
+
spec/templates/examples/method005.html,
|
328
|
+
spec/templates/examples/method005.txt, spec/templates/examples/module001.dot,
|
329
|
+
spec/templates/examples/module001.html,
|
330
|
+
spec/templates/examples/module001.txt, spec/templates/module_spec.rb: Correct
|
331
|
+
all template specs
|
332
|
+
|
333
|
+
* lib/yard/templates/helpers/html_helper.rb: Only show overload as signature
|
334
|
+
if there is one overload
|
335
|
+
|
336
|
+
* lib/yard/tags/overload_tag.rb: Improve robustness of OverloadTag signature
|
337
|
+
parsing
|
338
|
+
|
339
|
+
* templates/default/tags/html/overload.erb: Don't show empty overload
|
340
|
+
sections
|
341
|
+
|
342
|
+
* lib/yard/templates/helpers/method_helper.rb,
|
343
|
+
spec/templates/helpers/method_helper_spec.rb: Show yield block in signature
|
344
|
+
for method with no params
|
345
|
+
|
346
|
+
* lib/yard/templates/helpers/method_helper.rb,
|
347
|
+
templates/default/method_details/setup.rb: Add extra robustness for method
|
348
|
+
with no source attached
|
349
|
+
|
350
|
+
* lib/yard/templates/helpers/html_helper.rb: htmlify method names in
|
351
|
+
signature
|
352
|
+
|
353
|
+
* lib/yard/templates/helpers/html_helper.rb: Fix typewriter text for
|
354
|
+
unmatched ++
|
355
|
+
|
356
|
+
* lib/yard/cli/yardoc.rb, lib/yard/templates/helpers/html_helper.rb,
|
357
|
+
lib/yard/templates/helpers/text_helper.rb, spec/cli/yardoc_spec.rb,
|
358
|
+
spec/templates/helpers/html_helper_spec.rb,
|
359
|
+
.../templates/helpers/shared_signature_examples.rb,
|
360
|
+
spec/templates/helpers/text_helper_spec.rb: Revert hiding of (Object) and
|
361
|
+
(void) return types in signature by default, but add switches to re-enable
|
362
|
+
the behaviour. New switches are --default-return and --hide-void-return.
|
363
|
+
--default-return can take the empty string to show no return type. Also port
|
364
|
+
behaviour over to text_helper.rb and refactor specs to test both helpers at
|
365
|
+
the same time.
|
366
|
+
|
367
|
+
* lib/yard/code_objects/method_object.rb: Better handling of methods in proxy
|
368
|
+
namespaces.
|
369
|
+
|
370
|
+
* lib/yard/code_objects/base.rb: Fix method match for #<=>
|
371
|
+
|
372
|
+
2009-12-06 Loren Segal <lsegal@soen.ca>
|
373
|
+
|
374
|
+
* lib/yard/tags/overload_tag.rb: Fix OverloadTag#name for instance methods
|
375
|
+
|
376
|
+
* lib/yard/tags/overload_tag.rb,
|
377
|
+
spec/serializers/file_system_serializer_spec.rb,
|
378
|
+
spec/tags/overload_tag_spec.rb, spec/templates/examples/module001.html,
|
379
|
+
spec/templates/helpers/html_helper_spec.rb: Fix the way object lookups are
|
380
|
+
done inside overload tags. Closes gh-51
|
381
|
+
|
382
|
+
* lib/yard/code_objects/base.rb, spec/templates/helpers/base_helper_spec.rb:
|
383
|
+
Change the way Base#=== tests equality (call #is_a? on other)
|
384
|
+
|
385
|
+
* spec/serializers/file_system_serializer_spec.rb: Refactor
|
386
|
+
FileSystemSerializer specs
|
387
|
+
|
388
|
+
2009-12-05 Loren Segal <lsegal@soen.ca>
|
389
|
+
|
390
|
+
* templates/default/module/setup.rb: Fix sort_listing for Ruby1.8
|
391
|
+
|
392
|
+
* templates/default/module/setup.rb: Refactor method listing behaviour for
|
393
|
+
special methods
|
394
|
+
|
395
|
+
* templates/default/module/html/item_summary.erb: Only show constructor note
|
396
|
+
inside a class
|
397
|
+
|
398
|
+
* lib/yard/code_objects/method_object.rb,
|
399
|
+
spec/code_objects/method_object_spec.rb: Only show #initialize as constructor
|
400
|
+
if defined in a class
|
401
|
+
|
402
|
+
* templates/default/module/setup.rb: Only sort method summary by scope/name,
|
403
|
+
not visibility
|
404
|
+
|
405
|
+
* lib/yard/code_objects/method_object.rb,
|
406
|
+
spec/code_objects/method_object_spec.rb: Add MethodObject#constructor? to
|
407
|
+
return if method is #initialize
|
408
|
+
|
409
|
+
* lib/yard/templates/helpers/html_helper.rb,
|
410
|
+
lib/yard/templates/helpers/method_helper.rb,
|
411
|
+
spec/templates/helpers/html_helper_spec.rb,
|
412
|
+
spec/templates/helpers/method_helper_spec.rb: Show multiple types in
|
413
|
+
signature return types and add heuristics for nullable/splat returns Summary
|
414
|
+
of the new heuristics are as follows: * Single return type: (Type) * Two
|
415
|
+
return types: (TypeA, TypeB) * More than two: (TypeA, ...) * @return [Type,
|
416
|
+
nil]: (Type?) [? is superscripted] * @return [Type, Array<Type>]: (Type+) [+
|
417
|
+
is superscripted] * @return [void]: no return type shown Closes gh-49
|
418
|
+
|
419
|
+
* spec/templates/examples/method003.html,
|
420
|
+
templates/default/tags/html/overload.erb: Don't show extra text in overload
|
421
|
+
signatures
|
422
|
+
|
423
|
+
* templates/default/fulldoc/html/css/style.css: Display paragraphs as block
|
424
|
+
elements in overload tags Closes gh-50
|
425
|
+
|
426
|
+
2009-12-04 Loren Segal <lsegal@soen.ca>
|
427
|
+
|
428
|
+
* lib/yard/handlers/ruby/legacy/method_handler.rb,
|
429
|
+
lib/yard/handlers/ruby/method_handler.rb, lib/yard/tags/tag.rb,
|
430
|
+
spec/handlers/examples/method_handler_001.rb.txt,
|
431
|
+
spec/handlers/method_handler_spec.rb: Add @return [Boolean] to methods ending
|
432
|
+
in '?' unless they have a return type set
|
433
|
+
|
434
|
+
* spec/templates/examples/class001.html,
|
435
|
+
spec/templates/examples/method001.html,
|
436
|
+
spec/templates/examples/method002.html,
|
437
|
+
spec/templates/examples/method002.txt,
|
438
|
+
spec/templates/examples/method003.html,
|
439
|
+
spec/templates/examples/method003.txt,
|
440
|
+
spec/templates/examples/method004.html,
|
441
|
+
spec/templates/examples/method004.txt,
|
442
|
+
spec/templates/examples/method005.html,
|
443
|
+
spec/templates/examples/method005.txt, spec/templates/examples/module001.dot,
|
444
|
+
spec/templates/examples/module001.html,
|
445
|
+
spec/templates/examples/module001.txt, spec/templates/method_spec.rb,
|
446
|
+
spec/templates/module_spec.rb, spec/templates/spec_helper.rb: Add tests for
|
447
|
+
void return types and overloaded attributes
|
448
|
+
|
449
|
+
* lib/yard/templates/helpers/text_helper.rb: Fix signature for text helper
|
450
|
+
(don't show return for void/undocumented meths)
|
451
|
+
|
452
|
+
* templates/default/fulldoc/html/css/style.css,
|
453
|
+
templates/default/module/html/item_summary.erb: Add constructor button next
|
454
|
+
to #initialize method in summary
|
455
|
+
|
456
|
+
* templates/default/docstring/html/returns_void.erb,
|
457
|
+
templates/default/docstring/setup.rb,
|
458
|
+
templates/default/docstring/text/returns_void.erb,
|
459
|
+
templates/default/fulldoc/html/css/style.css,
|
460
|
+
templates/default/tags/setup.rb: Don't show @return for void, but show note
|
461
|
+
in a void method
|
462
|
+
|
463
|
+
* lib/yard/cli/yardoc.rb, lib/yard/code_objects/base.rb,
|
464
|
+
lib/yard/code_objects/class_object.rb, lib/yard/code_objects/proxy.rb,
|
465
|
+
lib/yard/core_ext/symbol_hash.rb, lib/yard/handlers/base.rb,
|
466
|
+
lib/yard/handlers/processor.rb, lib/yard/parser/ruby/ast_node.rb,
|
467
|
+
lib/yard/parser/source_parser.rb, lib/yard/rake/yardoc_task.rb,
|
468
|
+
lib/yard/registry.rb, lib/yard/serializers/base.rb,
|
469
|
+
lib/yard/templates/engine.rb, lib/yard/verifier.rb: Documentation: change to
|
470
|
+
@return [void] instead of [nil]
|
471
|
+
|
472
|
+
* lib/yard/templates/helpers/html_helper.rb: Don't show return type if none
|
473
|
+
specified or void
|
474
|
+
|
475
|
+
* lib/yard/handlers/ruby/legacy/method_handler.rb,
|
476
|
+
lib/yard/handlers/ruby/method_handler.rb,
|
477
|
+
spec/handlers/method_handler_spec.rb: #initialize should return [void]
|
478
|
+
|
479
|
+
* lib/yard/templates/helpers/html_helper.rb: Use first @overload tag for
|
480
|
+
return type in signature if no other return tag is present
|
481
|
+
|
482
|
+
* templates/default/fulldoc/html/setup.rb: Add attributes to method listing
|
483
|
+
|
484
|
+
* lib/yard/tags/overload_tag.rb, spec/handlers/method_handler_spec.rb: Allow
|
485
|
+
@overload to change name in signature
|
486
|
+
|
487
|
+
* lib/yard/code_objects/method_object.rb,
|
488
|
+
spec/code_objects/method_object_spec.rb: Fix MethodObject#is_attribute? when
|
489
|
+
attr exists but not for both read/write Closes gh-48
|
490
|
+
|
491
|
+
* spec/templates/examples/class001.html,
|
492
|
+
spec/templates/examples/module001.html,
|
493
|
+
.../default/class/html/constructor_details.erb,
|
494
|
+
templates/default/fulldoc/html/js/app.js,
|
495
|
+
.../default/module/html/attribute_details.erb,
|
496
|
+
.../default/module/html/attribute_summary.erb,
|
497
|
+
.../default/module/html/method_details_list.erb,
|
498
|
+
templates/default/module/html/method_summary.erb,
|
499
|
+
templates/default/module/html/methodmissing.erb,
|
500
|
+
templates/default/module/setup.rb: Split attr/method summary/details by into
|
501
|
+
separate class/instance sections
|
502
|
+
|
503
|
+
2009-12-01 Loren Segal <lsegal@soen.ca>
|
504
|
+
|
505
|
+
* lib/yard/templates/helpers/html_helper.rb: Sort tag attributes so tests can
|
506
|
+
pass across 1.8/1.9 without modification
|
507
|
+
|
508
|
+
* lib/yard.rb: Remove Encoding declaration (breaks in 1.9 and isn't
|
509
|
+
necessary)
|
510
|
+
|
511
|
+
* lib/yard/tags/overload_tag.rb, spec/templates/examples/module001.dot,
|
512
|
+
spec/templates/examples/module001.html,
|
513
|
+
spec/templates/examples/module001.txt, spec/templates/module_spec.rb,
|
514
|
+
templates/default/docstring/setup.rb,
|
515
|
+
templates/default/module/html/item_summary.erb: Fix duplicate docstring for
|
516
|
+
single @overload tag. Also add overloaded signature to method summary listing
|
517
|
+
in this case. Closes gh-39
|
518
|
+
|
519
|
+
2009-12-01 postmodern <postmodern.mod3@gmail.com>
|
520
|
+
|
521
|
+
* templates/default/fulldoc/html/css/style.css: Used a unicode hex-escape
|
522
|
+
sequence in the CSS instead.
|
523
|
+
|
524
|
+
2009-12-01 Loren Segal <lsegal@soen.ca>
|
525
|
+
|
526
|
+
* lib/yard.rb: Force UTF-8 encoding for templates and files. Closes gh-47
|
527
|
+
|
528
|
+
* templates/default/method/html/header.erb,
|
529
|
+
templates/default/module/html/defines.erb: Fix 1.8.6 incompatibility issue
|
530
|
+
(missing Symbol#to_proc)
|
531
|
+
|
532
|
+
* spec/templates/examples/method001.html,
|
533
|
+
spec/templates/examples/module001.html,
|
534
|
+
.../method_details/html/method_signature.erb: Permalink aliases Closes gh-44
|
535
|
+
|
536
|
+
* spec/templates/examples/module001.html, spec/templates/module_spec.rb,
|
537
|
+
.../default/module/html/inherited_constants.erb,
|
538
|
+
.../default/module/html/inherited_methods.erb: Hide private inherited
|
539
|
+
methods/constants. Closes gh-43
|
540
|
+
|
541
|
+
* lib/yard/handlers/ruby/attribute_handler.rb,
|
542
|
+
lib/yard/handlers/ruby/legacy/attribute_handler.rb,
|
543
|
+
lib/yard/handlers/ruby/legacy/method_handler.rb,
|
544
|
+
lib/yard/handlers/ruby/method_handler.rb,
|
545
|
+
spec/handlers/method_handler_spec.rb, spec/templates/examples/class001.html,
|
546
|
+
spec/templates/examples/module001.html: Remove RDoc specific markup for
|
547
|
+
auto-generated meta-tags. Closes gh-45
|
548
|
+
|
549
|
+
2009-11-29 Loren Segal <lsegal@soen.ca>
|
550
|
+
|
551
|
+
* templates/default/fulldoc/html/setup.rb, templates/default/module/setup.rb:
|
552
|
+
Ignore @private classes/modules. Closes gh-46
|
553
|
+
|
554
|
+
2009-11-26 Loren Segal <lsegal@soen.ca>
|
555
|
+
|
556
|
+
* lib/yard/handlers/base.rb: Add no-continuation warning for Rubinius and
|
557
|
+
only warn once
|
558
|
+
|
559
|
+
2009-11-21 Loren Segal <lsegal@soen.ca>
|
560
|
+
|
561
|
+
* lib/yard/core_ext/module.rb, spec/core_ext/module_spec.rb: Resolve
|
562
|
+
collision with Module#namespace and Rake, renamed to #namespace_name Closes
|
563
|
+
gh-42
|
564
|
+
|
565
|
+
2009-11-17 Loren Segal <lsegal@soen.ca>
|
566
|
+
|
567
|
+
* templates/default/layout/html/index.erb: Sort index listing in 1.8
|
568
|
+
|
569
|
+
2009-11-16 Loren Segal <lsegal@soen.ca>
|
570
|
+
|
571
|
+
* templates/default/module/dot/info.erb: Fix broken dot template in Ruby1.8
|
572
|
+
(due to hash ordering)
|
573
|
+
|
574
|
+
* lib/yard/parser/ruby/legacy/statement_list.rb,
|
575
|
+
spec/parser/source_parser_spec.rb: Legacy parser should prioritize prepended
|
576
|
+
comments over appended ones. Closes gh-38
|
577
|
+
|
1
578
|
2009-11-15 Loren Segal <lsegal@soen.ca>
|
2
579
|
|
3
|
-
*
|
580
|
+
* .../helpers/html_syntax_highlight_helper.rb,
|
581
|
+
.../helpers/html_syntax_highlight_helper18.rb: Add sanity checks for methods
|
582
|
+
with no source
|
583
|
+
|
584
|
+
* lib/yard/templates/helpers/method_helper.rb: Sanity check for methods with
|
585
|
+
no source
|
586
|
+
|
587
|
+
* ChangeLog, lib/yard.rb, yard.gemspec: Bump version to 0.4.0
|
4
588
|
|
5
589
|
* ChangeLog: Update changelog
|
6
590
|
|