yard 0.8.7.5 → 0.8.7.6
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +418 -0
- data/README.md +14 -13
- data/docs/WhatsNew.md +1 -0
- data/lib/yard/version.rb +1 -1
- data/templates/default/tags/html/option.erb +1 -1
- data/yard.gemspec +1 -1
- metadata +2 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2f723063cf267909777160a18d322d5dd78acace
|
|
4
|
+
data.tar.gz: 8ff1809f4067f82eafc3667601f75882b1a1aabc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: de4c7904f326053e2ad7dc88d3e63c2915689e74216b9f94df603fb20b39dd35a52d398882dfd3c8d73a2a0e7b74727a17420db745d05e1f6d732d265c65cddd
|
|
7
|
+
data.tar.gz: d75edfe99a18af7a74638c490501b328682f2aeb8d216624e8a4b1d48a25d2be66779eedca64d263b73addd6385af70782a672cb62087435a8a8dd9fd9a0e348
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,418 @@
|
|
|
1
|
+
# HEAD
|
|
2
|
+
|
|
3
|
+
- Support using `@option` tag on keyword arg splat parameter. (#729)
|
|
4
|
+
- Add `.stats_options` for `YardocTask`. (#800, #801)
|
|
5
|
+
|
|
6
|
+
# 0.8.7.5 - October 26, 2014
|
|
7
|
+
|
|
8
|
+
- Fix linking of methods in top level namespace in method listing. (#776)
|
|
9
|
+
- Support using C macros in function declarations. (#810)
|
|
10
|
+
- YARD will no longer group comment blocks starting on the same column if they
|
|
11
|
+
are preceded by code. (#798)
|
|
12
|
+
- Handle anonymous lambda calls in toplevel scope. (#774)
|
|
13
|
+
- Support I18n in `@overload` tags. (#794)
|
|
14
|
+
- Support `yard stats` for objects with no file property. (#792)
|
|
15
|
+
- Support for named arguments in Ruby >= 2.1. (#785)
|
|
16
|
+
- Exclude README backup files from YARD generation. (#790)
|
|
17
|
+
- Turned on the lax spacing option in Redcarpet to comply with the
|
|
18
|
+
Markdown standard.
|
|
19
|
+
- Escape HTML in YARD server search placeholder template.
|
|
20
|
+
- Fix issue with `private_class_method` support. (#760, #767)
|
|
21
|
+
- Enable tables support by default in Redcarpet Markdown provider. (#765)
|
|
22
|
+
|
|
23
|
+
# 0.8.7.4 - March 22, 2014
|
|
24
|
+
|
|
25
|
+
- Mark C methods as explicit but also remove explicit check in stats. (#727)
|
|
26
|
+
- Report unresolved parent namespaces as undocumentable errors instead. (#753)
|
|
27
|
+
- No longer ignore overridden methods from documentation check in stats (#719)
|
|
28
|
+
- Fix JRuby throwing exception when remove_method called on non-existent method. (#732)
|
|
29
|
+
- Add basic support for `private_class_method` (#747)
|
|
30
|
+
- Ensure namespace is always set when parent module is not found. (#753)
|
|
31
|
+
- Set overflow as auto on table of contents.
|
|
32
|
+
- Report 100% documented if nothing is undocumented. (#754)
|
|
33
|
+
- Added support for RubyGems 2.0.0+. (#742)
|
|
34
|
+
- Allow users to enter their own YARD RakeTask name. (#705)
|
|
35
|
+
- Fixed a typo that was causing Windows detection to always fail. (#715)
|
|
36
|
+
- Add debug information when loading a plugin fails. (#711)
|
|
37
|
+
|
|
38
|
+
# 0.8.7.3 - November 1, 2013
|
|
39
|
+
|
|
40
|
+
- Handle Unicode method/class/file names in server URL encoding (lsegal/rubydoc.info#69).
|
|
41
|
+
- Style keyword style hashes with same symbol color in code highlighting (#707).
|
|
42
|
+
- Fix broken JS when visiting docs in file:// scheme (#706).
|
|
43
|
+
- Add support for new AsciiDoc file extensions (#704).
|
|
44
|
+
- Fix issues where non-Ruby code blocks would not display in Ruby 2 (#702).
|
|
45
|
+
- Add support for extra Ruby 2 symbol types in Ripper (#701).
|
|
46
|
+
- Ensure config directory exists before saving config file (#700).
|
|
47
|
+
|
|
48
|
+
# 0.8.7.2 - September 18, 2013
|
|
49
|
+
|
|
50
|
+
- Disallow absolute URLs when using frame anchor support.
|
|
51
|
+
- Support casted functions in CRuby method declarations (#697)
|
|
52
|
+
|
|
53
|
+
# 0.8.7.1 - September 11, 2013
|
|
54
|
+
|
|
55
|
+
- Fix potential XSS issue with frame anchor support.
|
|
56
|
+
- Add support for gettext 3.x gem.
|
|
57
|
+
|
|
58
|
+
# 0.8.7 - July 26, 2013
|
|
59
|
+
|
|
60
|
+
- Added `--hide-api API` option to hide objects with a given `@api` tag (#685).
|
|
61
|
+
- Added "Returns ...." prefix to summary when a lone @return tag is used.
|
|
62
|
+
- Fixed issue that caused ref tags to be added to a docstring twice (#678).
|
|
63
|
+
- Fixed formatting issue in docstring summaries (#686)
|
|
64
|
+
|
|
65
|
+
# 0.8.6.2 - June 27, 2013
|
|
66
|
+
|
|
67
|
+
- Fixed issue where `yard graph` was not displaying methods
|
|
68
|
+
|
|
69
|
+
# 0.8.6.1 - April 14, 2013
|
|
70
|
+
|
|
71
|
+
- Fixed broken links in File menu on default HTML template
|
|
72
|
+
- Added --layout switch to `yard display` to wrap output in layout template.
|
|
73
|
+
- See {file:docs/WhatsNew.md} for more information on added features.
|
|
74
|
+
|
|
75
|
+
# 0.8.6 - April 13, 2013
|
|
76
|
+
|
|
77
|
+
- Various fixes and improved Ruby 2.x compatibility support
|
|
78
|
+
- Added support for `asciidoc` markup type
|
|
79
|
+
- Added `yard markups` command to list available markup types
|
|
80
|
+
- Added `yard display` command to display and format an individual object
|
|
81
|
+
- See {file:docs/WhatsNew.md} for more information on added features.
|
|
82
|
+
|
|
83
|
+
# 0.8.5.2 - February 26, 2013
|
|
84
|
+
|
|
85
|
+
- Support new keyword argument syntax in method signatures (Ruby 2.x)
|
|
86
|
+
|
|
87
|
+
# 0.8.5.1 - February 25, 2013
|
|
88
|
+
|
|
89
|
+
- Fix `yard diff` of gem files with RubyGems 2.x
|
|
90
|
+
|
|
91
|
+
# 0.8.5 - February 24, 2013
|
|
92
|
+
|
|
93
|
+
- Basic support for Ruby 2.0 (fix compat issues in RDoc 4.0, RubyGems 2.0)
|
|
94
|
+
- Add CSS styling for tables in default HTML template
|
|
95
|
+
|
|
96
|
+
# 0.8.4.1 - February 5, 2013
|
|
97
|
+
|
|
98
|
+
- Fix regression that broke loading of existing yardoc dbs (#648)
|
|
99
|
+
|
|
100
|
+
# 0.8.4 - February 4, 2013
|
|
101
|
+
|
|
102
|
+
- Add `-B/--bind` switch to yard server (#593, #608)
|
|
103
|
+
- Add CodeObjects::Base#title for plugins to customize how object
|
|
104
|
+
links display (#646)
|
|
105
|
+
- Disable linking objects filtered out by verifiers (#645)
|
|
106
|
+
- Allow macro expansion on class methods (#632)
|
|
107
|
+
- Expand newly attached macro on first DSL method call (#631)
|
|
108
|
+
- Disable RubyGems plugin in Ruby 2.0 (#627)
|
|
109
|
+
- Fix line range for class/module node bodies (#626)
|
|
110
|
+
- Search extended modules for attached DSL macros (#553)
|
|
111
|
+
|
|
112
|
+
# 0.8.3 - October 14, 2012
|
|
113
|
+
|
|
114
|
+
- Add `--non-transitive-tag` to disable tag transitivity (#571)
|
|
115
|
+
- Support --db inside .yardopts for graph/server commands (#583, #586)
|
|
116
|
+
- Fix handling for =begin/=end docstrings (#577, #578)
|
|
117
|
+
- Parser only sorts file lists when a glob is provided (#572)
|
|
118
|
+
- Fix formatting in `{include:Object#method}` syntax (#569)
|
|
119
|
+
- Fix @option tag inside of module functions (#563)
|
|
120
|
+
- Fix to `--api` and `--no-api` support (#559)
|
|
121
|
+
- Fix class nesting issues when path starts with "::" (#552)
|
|
122
|
+
|
|
123
|
+
# 0.8.2.1 - June 9, 2012
|
|
124
|
+
|
|
125
|
+
- Fix a set of regressions in yard server search and dynamic generation
|
|
126
|
+
|
|
127
|
+
# 0.8.2 - June 7, 2012
|
|
128
|
+
|
|
129
|
+
- Added progress style output in tty terminals
|
|
130
|
+
- Embedded mixins should ignore methods defined on module (#539)
|
|
131
|
+
- Fixed permalinks for embedded mixins in `yard server` (#540)
|
|
132
|
+
- Improve parsing in CRuby code (#543)
|
|
133
|
+
- Ensure Registry.resolve picks module when parsing mixins (#545)
|
|
134
|
+
- Fixed regression that caused various commands to not show output (#548)
|
|
135
|
+
- Respect current visibility when parsing class conditions (#551)
|
|
136
|
+
|
|
137
|
+
# 0.8.1 - May 2, 2012
|
|
138
|
+
|
|
139
|
+
- Added `--[no-]api` switch to generate docs for API sets (see {file:docs/WhatsNew.md} for details) (#532)
|
|
140
|
+
- The `yard list` command now uses cache by default (#533)
|
|
141
|
+
- Fix `yardoc` generating incorrectly named method list file (#528)
|
|
142
|
+
- Fix HTML output occasionally showing trailing mdash on options list (#522)
|
|
143
|
+
|
|
144
|
+
# 0.8.0 - April 30, 2012
|
|
145
|
+
|
|
146
|
+
- See {file:docs/WhatsNew.md} for a list of added features
|
|
147
|
+
- Over 20 bug fixes:
|
|
148
|
+
- Properly filter hidden setter/getter attributes (#394)
|
|
149
|
+
- Fix test failures in Linux environments (#397, #472, #473, #512, #513)
|
|
150
|
+
- Fix attribute inheritance and @private (#432)
|
|
151
|
+
- Fix attribute parsing (#435)
|
|
152
|
+
- Allow aliases for attributes (#436)
|
|
153
|
+
- Fix namespace fetching in `handle_alias()` (#437)
|
|
154
|
+
- Fix overwritten attributes marked as inherited (#442)
|
|
155
|
+
- Fix documenting constants defined from C code with `rb_define_const()` (#443)
|
|
156
|
+
- Do not escape snippets twice (#445)
|
|
157
|
+
- Ajax method/class search should not fire when a non-printable character is pressed (#446)
|
|
158
|
+
- Fix yard server crashing when RDoc is not installed (#456)
|
|
159
|
+
- Fix tags ignored when `(see #foo)` is used (#457)
|
|
160
|
+
- Fix three "Returns" for two `@overload` tags (#458)
|
|
161
|
+
- Do not auto-detect DSL methods as method objects if parameter name is not a valid method name (#464)
|
|
162
|
+
- Fix attaching of macros to Object (#465)
|
|
163
|
+
- Fix handling of `%w()` source in `[]/[]=` parsed context. (#461, pull in #468)
|
|
164
|
+
- Don't add default `@return` if `@overload` has `@return`. (#458, pull in #469)
|
|
165
|
+
- Don't discard tags by (see ...). (#457, pull in #470)
|
|
166
|
+
- Fix constants listed as inherited when overwritten (#474)
|
|
167
|
+
- Fix `yardoc --asset` behaving differently on first and subsequent calls. (#477)
|
|
168
|
+
- `!!!lang` code blocks should set the lang in `<pre>`'s class. (#478, #479)
|
|
169
|
+
- Fix "File List" search tab error. (#502)
|
|
170
|
+
- Fix search bar not redirecting to method page. (#509)
|
|
171
|
+
- Fix server returning exception message bodies as String (#518)
|
|
172
|
+
|
|
173
|
+
# 0.7.5 - January 31, 2012
|
|
174
|
+
|
|
175
|
+
- Various minor bug fixes
|
|
176
|
+
|
|
177
|
+
# 0.7.4 - December 2, 2011
|
|
178
|
+
|
|
179
|
+
- Redcarpet is now the default Markdown formatting library. GFM now works out-of-box (#404)
|
|
180
|
+
- Fix server side searching for elements that are marked private (#420)
|
|
181
|
+
- Add 'textile_strict' and 'pre' markup types, reorganize text and none (#416)
|
|
182
|
+
- Improve encoding line detection (#415)
|
|
183
|
+
- Add support for `rb_define_alias` in CRuby code (#413)
|
|
184
|
+
- Fix rendering of some keywords in source view (#410)
|
|
185
|
+
- Add support for RDoc 3.10+ (#406, #407)
|
|
186
|
+
- Fix typewriter text being processed in code blocks (#403)
|
|
187
|
+
- Improve support for has_rdoc in RubyGems 1.8.x (#401)
|
|
188
|
+
- See the {file:docs/WhatsNew.md} document for details on added features
|
|
189
|
+
|
|
190
|
+
# 0.7.3 - October 15, 2011
|
|
191
|
+
|
|
192
|
+
- Improve support for parsing under Ruby 1.9.2p290 and 1.9.3 (#365, #370)
|
|
193
|
+
- Add support for SWIG generated CRuby code (#369)
|
|
194
|
+
- Add support for `rb_define_attr` calls in CRuby code (#362)
|
|
195
|
+
- Handle file pointers in CRuby code (#358)
|
|
196
|
+
|
|
197
|
+
# 0.7.2 - June 14, 2011
|
|
198
|
+
|
|
199
|
+
- Fix `yard --help` not showing proper output
|
|
200
|
+
- YARD now expands path to `.yardoc` file in daemon mode for server (#328)
|
|
201
|
+
- Fix `@overload` tag linking to wrong method (#330)
|
|
202
|
+
- Fix incorrect return type when using `@macro` (#334)
|
|
203
|
+
- YARD now requires 'thread' to support RubyGems 1.7+ (#338)
|
|
204
|
+
- Fix bug in constant documentation when using `%w()` (#348)
|
|
205
|
+
- Fix YARD style URL links when using autolinking markdown (#353)
|
|
206
|
+
|
|
207
|
+
# 0.7.1 - May 18, 2011
|
|
208
|
+
|
|
209
|
+
- Fixes a bug in `yard server` not displaying class list properly.
|
|
210
|
+
|
|
211
|
+
# 0.7.0 - May 17, 2011
|
|
212
|
+
|
|
213
|
+
- See the {file:docs/WhatsNew.md} document for details on added features
|
|
214
|
+
- Make sure that Docstring#line_range is filled when possible (#243)
|
|
215
|
+
- Set #verifier in YardocTask (#282)
|
|
216
|
+
- Parse BOM in UTF-8 files (#288)
|
|
217
|
+
- Fix instance attributes not showing up in method list (#302)
|
|
218
|
+
- Fix rendering of %w() literals in constants (#306)
|
|
219
|
+
- Ignore keyboard shortcuts when an input is active (#312)
|
|
220
|
+
- And more...
|
|
221
|
+
|
|
222
|
+
# 0.6.8 - April 14, 2011
|
|
223
|
+
|
|
224
|
+
- Fix regression in RDoc 1.x markup loading
|
|
225
|
+
- Fix regression in loading of markup libraries for `yard server`
|
|
226
|
+
|
|
227
|
+
# 0.6.7 - April 6, 2011
|
|
228
|
+
|
|
229
|
+
- Fix has_rdoc gem specification issue with new RubyGems plugin API (oops!)
|
|
230
|
+
|
|
231
|
+
# 0.6.6 - April 6, 2011
|
|
232
|
+
|
|
233
|
+
- Fix error message when RDoc is not present (#270)
|
|
234
|
+
- Add markup type 'none' to perform basic HTML translation (fallback when RDoc is not present)
|
|
235
|
+
- Add support for RubyGems 1.7.x (#272)
|
|
236
|
+
- Fix rendering of `{url description}` syntax when description contains newline
|
|
237
|
+
|
|
238
|
+
# 0.6.5 - March 13, 2011
|
|
239
|
+
|
|
240
|
+
- Support `ripper` gem in Ruby 1.8.7
|
|
241
|
+
- Upgrade jQuery to 1.5.1
|
|
242
|
+
- Fix handling of alias statements with quoted symbols (#262)
|
|
243
|
+
- Add CSS styles (#260)
|
|
244
|
+
- Unhandled exception in YARD::Handlers::Ruby::MixinHandler indexing documentation for eventmachine (#248)
|
|
245
|
+
- Splice any alias references on method re-definitions into separate methods (#247)
|
|
246
|
+
- Fix "yard graph" (#245)
|
|
247
|
+
- Don't process ++ typewriter text inside of HTML attributes (#244)
|
|
248
|
+
- Prioritize loading of Kramdown before Maruku (#241)
|
|
249
|
+
- Skip shebang encoding in docstrings (#238)
|
|
250
|
+
- Fix truncation of references in @deprecated (#232)
|
|
251
|
+
- Show @api private note when no other tags are present (#231)
|
|
252
|
+
- Detect docstrings starting with "##" as `Docstring#hash_flag` (#230)
|
|
253
|
+
- Remove trailing whitespace from freeform tags (#229)
|
|
254
|
+
- Fix line through for deprecated methods (#225)
|
|
255
|
+
- Mistake in Tags.md (#223)
|
|
256
|
+
- Improve database storage by being more efficient with filesystem usage (#222)
|
|
257
|
+
- Make Registry thread local (#221)
|
|
258
|
+
- Support `private_constant` class method for 1.9.3 (#219)
|
|
259
|
+
- Do not assume RDoc is installed (#214)
|
|
260
|
+
|
|
261
|
+
# 0.6.4 - December 21, 2010
|
|
262
|
+
|
|
263
|
+
- Fix yri tool crashing with new Config class (gh-217)
|
|
264
|
+
- Fix support for ::TopLevelConstants (gh-216)
|
|
265
|
+
- YARD's test suite is now RSpec2 compatible (gh-215)
|
|
266
|
+
- Improved documentation for YARD::Server features (gh-207)
|
|
267
|
+
- Fix displaying of collaped method summary lists (gh-204)
|
|
268
|
+
- Fix automatic loading of markup providers (gh-206)
|
|
269
|
+
- Fix keyboard shortcuts for Chrome (gh-203)
|
|
270
|
+
- Disallow `extend self` inside of a class (gh-202)
|
|
271
|
+
- Constants now recognized in C extensions (gh-201)
|
|
272
|
+
|
|
273
|
+
# 0.6.3 - November 21, 2010
|
|
274
|
+
|
|
275
|
+
- Fixed regression that caused `yardoc --markup` to silently exit
|
|
276
|
+
|
|
277
|
+
# 0.6.2 - November 15, 2010
|
|
278
|
+
|
|
279
|
+
- **Plugins no longer automatically load, use `--plugin` to load a plugin**
|
|
280
|
+
- Added YARD::Config and ~/.yard/config YAML configuration file
|
|
281
|
+
- Added `yard config` command to view/edit YARD configuration file
|
|
282
|
+
- Fixes for YARD in 1.8.6 (gh-178)
|
|
283
|
+
- Various HTML template adjustments and fixes (gh-198,199,200)
|
|
284
|
+
- Improved `yard server -m` multi-project stability (gh-193)
|
|
285
|
+
- Fixed handling of `yardoc --no-private` with missing class definitions (gh-197)
|
|
286
|
+
- Added support for constants defined in C extensions (gh-177)
|
|
287
|
+
- Added support for Structs defined as "Klass = Struct.new(...)" (gh-187)
|
|
288
|
+
- Improved parsing support for third-party gems (gh-174,180)
|
|
289
|
+
- Improved support for JRuby 1.6.4+. YARD now passes all specs in JRuby (gh-185)
|
|
290
|
+
- Improved YARD documentation (gh-172,191,196)
|
|
291
|
+
|
|
292
|
+
# 0.6.1 - September 06, 2010
|
|
293
|
+
|
|
294
|
+
- Fixed TOC showing on top of class/method list in no-frames view
|
|
295
|
+
- A message now displays when running `yard server` with Rack/Mongrel installed
|
|
296
|
+
- Improved performance of JS inline search for large class/method lists
|
|
297
|
+
- Improved link titles for relative object links
|
|
298
|
+
- Removed `String#camelcase` and `String#underscore` for better Rails compat.
|
|
299
|
+
- Fixed support for loading .yardoc files under Windows
|
|
300
|
+
- Fixed inheritance tree arrows not displaying in certain environments
|
|
301
|
+
|
|
302
|
+
# 0.6.0 - August 29, 2010
|
|
303
|
+
|
|
304
|
+
- Added dynamic local documentation server
|
|
305
|
+
- Added @group/@endgroup declarations to organize methods into groups
|
|
306
|
+
- Added `yard` executable to serve as main CLI tool with pluggable commands
|
|
307
|
+
- Added `--asset` switch to `yardoc` to copy files/dirs to output dir
|
|
308
|
+
- Added ability to register/manipulate tags via CLI (`--tag`, etc.)
|
|
309
|
+
- Added `yard diff` command
|
|
310
|
+
- Added statistics to `yardoc` output (and `yard stats` command)
|
|
311
|
+
- Added Javascript generated Table of Contents to file pages
|
|
312
|
+
- Updated various APIs
|
|
313
|
+
- Removed `yard-graph` executable
|
|
314
|
+
- See more changes in the {file:docs/WhatsNew.md what's new document}
|
|
315
|
+
|
|
316
|
+
# 0.5.8 - June 22, 2010
|
|
317
|
+
|
|
318
|
+
- Merge fix from 0.6 branch for --no-private visibility checking
|
|
319
|
+
|
|
320
|
+
# 0.5.7 - June 21, 2010
|
|
321
|
+
|
|
322
|
+
- Fixed visibility flag parsing in `yardoc`
|
|
323
|
+
- Updated Parser Architecture documentation with new SourceParser API
|
|
324
|
+
- Improved Registry documentation for new load commands
|
|
325
|
+
- Fix loading of .yardoc file as cache (and preserving aliases)
|
|
326
|
+
- Fix "lib" directory missing when running YARD on installed gems
|
|
327
|
+
|
|
328
|
+
# 0.5.6 - June 12, 2010
|
|
329
|
+
|
|
330
|
+
- Bug fixes for RubyGems plugin, `has_rdoc=false` should now work
|
|
331
|
+
- New API for registering custom parsers. See {file:docs/WhatsNew.md}
|
|
332
|
+
|
|
333
|
+
# 0.5.5 - May 22, 2010
|
|
334
|
+
|
|
335
|
+
- Various bug fixes
|
|
336
|
+
|
|
337
|
+
# 0.5.4 - March 22, 2010
|
|
338
|
+
|
|
339
|
+
- See {file:docs/WhatsNew.md what's new document} for changes
|
|
340
|
+
|
|
341
|
+
# 0.5.3 - January 11, 2010
|
|
342
|
+
|
|
343
|
+
- See {file:docs/WhatsNew.md what's new document} for changes
|
|
344
|
+
|
|
345
|
+
# 0.5.2 - December 16, 2009
|
|
346
|
+
|
|
347
|
+
- See {file:docs/WhatsNew.md what's new document} for changes
|
|
348
|
+
|
|
349
|
+
# 0.5.1 - December 15, 2009
|
|
350
|
+
|
|
351
|
+
- See {file:docs/WhatsNew.md what's new document} for changes
|
|
352
|
+
|
|
353
|
+
# 0.5.0 - December 13, 2009
|
|
354
|
+
|
|
355
|
+
- See {file:docs/WhatsNew.md what's new document} for changes
|
|
356
|
+
|
|
357
|
+
# 0.4.0 - November 15, 2009
|
|
358
|
+
|
|
359
|
+
- Added new templating engine based on [tadpole](http://github.com/lsegal/tadpole)
|
|
360
|
+
- Added YARD queries (`--query` CLI argument to yardoc)
|
|
361
|
+
- Greatly expanded YARD documentation
|
|
362
|
+
- Added plugin support
|
|
363
|
+
- New `@abstract` and `@private` tags
|
|
364
|
+
- Changed default rake task to `rake yard`
|
|
365
|
+
- Read about changes in {file:docs/WhatsNew.md}
|
|
366
|
+
|
|
367
|
+
# 0.2.3.5 - August 13, 2009
|
|
368
|
+
|
|
369
|
+
- Minor bug fixes.
|
|
370
|
+
|
|
371
|
+
# 0.2.3.4 - August 07, 2009
|
|
372
|
+
|
|
373
|
+
- Minor bug fixes.
|
|
374
|
+
|
|
375
|
+
# 0.2.3.3 - July 26, 2009
|
|
376
|
+
|
|
377
|
+
- Minor bug fixes.
|
|
378
|
+
|
|
379
|
+
# 0.2.3.2 - July 06, 2009
|
|
380
|
+
|
|
381
|
+
- Fix Textile hard-break issues
|
|
382
|
+
- Add description for @see tag to use as link title in HTML docs.
|
|
383
|
+
- Add --title CLI option to specify a title for HTML doc files.
|
|
384
|
+
- Add custom.css file that can be overridden with various custom
|
|
385
|
+
styelsheet declarations. To use this, simply add `default/fulldoc/html/custom.css`
|
|
386
|
+
inside your code directory and use the `-t` template directory yardoc CLI
|
|
387
|
+
option to point to that template directory (the dir holding 'default').
|
|
388
|
+
- Add support in `yardoc` CLI to specify extra files (formerly --files)
|
|
389
|
+
by appending "- extra files here" after regular source files. Example:
|
|
390
|
+
|
|
391
|
+
yardoc --private lib/**/*.rb - FAQ LICENSE
|
|
392
|
+
|
|
393
|
+
# 0.2.3.1 - June 13, 2009
|
|
394
|
+
|
|
395
|
+
- Add a RubyGems 1.3.2+ plugin to generate YARD documentation instead of
|
|
396
|
+
RDoc. To take advantage of this plugin, set `has_rdoc = 'yard'` in your
|
|
397
|
+
.gemspec file.
|
|
398
|
+
|
|
399
|
+
# 0.2.3 - June 07, 2009
|
|
400
|
+
|
|
401
|
+
- See the {file:docs/WhatsNew.md} file for a list of important new features.
|
|
402
|
+
|
|
403
|
+
# 0.2.2 - Jun 16, 2008
|
|
404
|
+
|
|
405
|
+
- This is the largest changset since yard's conception and involves a complete
|
|
406
|
+
overhaul of the parser and API to make it more robust and far easier to
|
|
407
|
+
extend and use for the developer.
|
|
408
|
+
|
|
409
|
+
# 0.2.1 - February 20, 2008
|
|
410
|
+
|
|
411
|
+
- See the {file:docs/WhatsNew.md} file for a list of important new features.
|
|
412
|
+
|
|
413
|
+
# 0.1a - February 24, 2007
|
|
414
|
+
|
|
415
|
+
- Released 0.1a experimental version for testing. The goal here is
|
|
416
|
+
to get people testing YARD on their code because there are too many possible
|
|
417
|
+
code styles to fit into a sane amount of test cases. It also demonstrates the
|
|
418
|
+
power of YARD and what to expect from the syntax (Yardoc style meta tags).
|
data/README.md
CHANGED
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
# YARD: Yay! A Ruby Documentation Tool
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
**Release Date**: October 26, 2014
|
|
3
|
+
[](http://yardoc.org)
|
|
4
|
+
[](http://github.com/lsegal/yard)
|
|
5
|
+
[](http://rubydoc.org/gems/yard/frames)
|
|
6
|
+
[](https://gitter.im/lsegal/yard)
|
|
7
|
+
|
|
8
|
+
[](http://github.com/lsegal/yard/releases)
|
|
9
|
+
[](https://travis-ci.org/lsegal/yard)
|
|
10
|
+
[](#license)
|
|
12
11
|
|
|
13
12
|
## Synopsis
|
|
14
13
|
|
|
@@ -209,11 +208,13 @@ adding the following to your `Rakefile`:
|
|
|
209
208
|
YARD::Rake::YardocTask.new do |t|
|
|
210
209
|
t.files = ['lib/**/*.rb', OTHER_PATHS] # optional
|
|
211
210
|
t.options = ['--any', '--extra', '--opts'] # optional
|
|
211
|
+
t.stats_options = ['--list-undoc'] # optional
|
|
212
212
|
end
|
|
213
213
|
|
|
214
|
-
|
|
215
|
-
`lib/**/*.rb
|
|
216
|
-
to add
|
|
214
|
+
All the settings: `files`, `options` and `stats_options` are optional. `files` will default to
|
|
215
|
+
`lib/**/*.rb`, `options` will represents any options you might want
|
|
216
|
+
to add and `stats_options` will pass extra options to the stats command.
|
|
217
|
+
Again, a full list of options is available by typing `yardoc --help`
|
|
217
218
|
in a shell. You can also override the options at the Rake command-line with the
|
|
218
219
|
OPTS environment variable:
|
|
219
220
|
|
|
@@ -285,7 +286,7 @@ More options can be seen by typing `yard graph --help`, but here is an example:
|
|
|
285
286
|
|
|
286
287
|
See {file:CHANGELOG.md} for a list of changes.
|
|
287
288
|
|
|
288
|
-
##
|
|
289
|
+
## License
|
|
289
290
|
|
|
290
291
|
YARD © 2007-2014 by [Loren Segal](mailto:lsegal@soen.ca). YARD is
|
|
291
292
|
licensed under the MIT license except for some files which come from the
|
data/docs/WhatsNew.md
CHANGED
|
@@ -22,6 +22,7 @@
|
|
|
22
22
|
18. **Added `yard markups` command to list available markup types** (0.8.6)
|
|
23
23
|
19. **Added `yard display` command to display formatted objects** (0.8.6)
|
|
24
24
|
20. **Added `--layout` to `yard display` command** (0.8.6.1)
|
|
25
|
+
21. **Added `stats_options` for the rake task** (0.8.7.6)
|
|
25
26
|
|
|
26
27
|
## Directives (new behavioural tag syntax) (0.8.0)
|
|
27
28
|
|
data/lib/yard/version.rb
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<% if object.has_tag?(:option) %>
|
|
2
2
|
<% object.parameters.each do |param, default| %>
|
|
3
|
-
<% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s } %>
|
|
3
|
+
<% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s.sub(/^\*+/, '') } %>
|
|
4
4
|
<% next if tags.empty? %>
|
|
5
5
|
<p class="tag_title">Options Hash (<tt><%= param %></tt>):</p>
|
|
6
6
|
<ul class="option">
|
data/yard.gemspec
CHANGED
|
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
|
|
|
16
16
|
s.homepage = "http://yardoc.org"
|
|
17
17
|
s.platform = Gem::Platform::RUBY
|
|
18
18
|
s.files = Dir.glob("{docs,bin,lib,spec,templates,benchmarks}/**/*") +
|
|
19
|
-
['LICENSE', 'LEGAL', 'README.md', 'Rakefile', '.yardopts', __FILE__]
|
|
19
|
+
['CHANGELOG.md', 'LICENSE', 'LEGAL', 'README.md', 'Rakefile', '.yardopts', __FILE__]
|
|
20
20
|
s.require_paths = ['lib']
|
|
21
21
|
s.executables = ['yard', 'yardoc', 'yri']
|
|
22
22
|
s.has_rdoc = 'yard'
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: yard
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.8.7.
|
|
4
|
+
version: 0.8.7.6
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Loren Segal
|
|
@@ -24,6 +24,7 @@ extensions: []
|
|
|
24
24
|
extra_rdoc_files: []
|
|
25
25
|
files:
|
|
26
26
|
- ".yardopts"
|
|
27
|
+
- CHANGELOG.md
|
|
27
28
|
- LEGAL
|
|
28
29
|
- LICENSE
|
|
29
30
|
- README.md
|