yard 0.9.9 → 0.9.10

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.

Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +207 -61
  3. data/docs/Templates.md +1 -1
  4. data/lib/yard/cli/stats.rb +3 -2
  5. data/lib/yard/cli/yardoc.rb +10 -0
  6. data/lib/yard/docstring_parser.rb +1 -0
  7. data/lib/yard/gem_index.rb +1 -1
  8. data/lib/yard/handlers/c/class_handler.rb +1 -1
  9. data/lib/yard/handlers/ruby/constant_handler.rb +1 -0
  10. data/lib/yard/i18n/pot_generator.rb +2 -2
  11. data/lib/yard/i18n/text.rb +2 -2
  12. data/lib/yard/logging.rb +9 -1
  13. data/lib/yard/parser/c/comment_parser.rb +1 -1
  14. data/lib/yard/parser/ruby/ast_node.rb +8 -1
  15. data/lib/yard/parser/ruby/ruby_parser.rb +1 -1
  16. data/lib/yard/rubygems/specification.rb +11 -3
  17. data/lib/yard/tags/directives.rb +8 -0
  18. data/lib/yard/tags/types_explainer.rb +3 -1
  19. data/lib/yard/templates/helpers/html_helper.rb +7 -0
  20. data/lib/yard/templates/helpers/markup_helper.rb +4 -0
  21. data/lib/yard/version.rb +1 -1
  22. data/spec/cli/stats_spec.rb +4 -4
  23. data/spec/cli/yardoc_spec.rb +21 -2
  24. data/spec/examples.txt +1785 -1777
  25. data/spec/handlers/c/class_handler_spec.rb +2 -1
  26. data/spec/handlers/constant_handler_spec.rb +8 -0
  27. data/spec/handlers/examples/constant_handler_001.rb.txt +6 -1
  28. data/spec/logging_spec.rb +9 -0
  29. data/spec/parser/c_parser_spec.rb +10 -0
  30. data/spec/parser/examples/array.c.txt +3521 -1141
  31. data/spec/parser/ruby/ruby_parser_spec.rb +13 -0
  32. data/spec/parser/source_parser_spec.rb +1 -1
  33. data/spec/tags/types_explainer_spec.rb +4 -1
  34. data/spec/templates/helpers/html_helper_spec.rb +2 -1
  35. data/spec/templates/helpers/markup_helper_spec.rb +1 -0
  36. data/templates/default/fulldoc/html/setup.rb +1 -1
  37. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 842b57c19d9ac23361a8e537d5cc57ab3038c3b8
4
- data.tar.gz: ea040049a97c03f575fcf417909f7b797eb22eab
3
+ metadata.gz: f8961acf82be41a766241377ba703433d670edb6
4
+ data.tar.gz: 01cfe7bd94366ada4c61c074ef1b6864fe92fccb
5
5
  SHA512:
6
- metadata.gz: 4c798c9f62558283cd39a93f867cd0f98cd21e02ea13e0cf7650a0d08c22c048bba9ed7f33228cb270cf60072a04e991b88890fa1939725b68f1f92dbe41a19e
7
- data.tar.gz: 99be4acd86b021b3e6aa6bb9868bac47c882a7c5c4a6506614432d8ceea098b0a4b508d37aab40bf942add3e0353b6c2fad3b040396b432d621591c65c29d69f
6
+ metadata.gz: f62d88b582921e1c61fe4ccb7d56f2367c676f8fb72e87ece5d0dbf29561016f5f472b0628a77ce3a22e862f1dcacd31481cb825778bce10fa8789fc7c35d14b
7
+ data.tar.gz: 7a9fef5a8ec73958a87f137c6411215588d5d320a57562222ccb3916d48bdaa65cd6fcfe444fcc9f6c156ee16fe1229cfff1a037861f5cc563dba1ce1f7c69fe
data/CHANGELOG.md CHANGED
@@ -1,13 +1,41 @@
1
- # 0.9.8 - January 13th, 2017
1
+ # [0.9.10] - November 18th, 2017
2
+
3
+ [0.9.10]: https://github.com/lsegal/yard/compare/v0.9.9...v0.9.10
4
+
5
+ - Added `--fail-on-warning` option for `yard doc` which exits with a non-zero
6
+ code if there are any warnings (#1093).
7
+ - Added support for parsing inside `Struct.new` blocks (#1099).
8
+ - Added support new ripper AST tokens (#1104, #1124).
9
+ - Fixed an issue where `@see (obj)` reference tags would fail (#1111)
10
+ - Fix sorting in `yard stats` (#1123).
11
+
12
+ # [0.9.9] - April 23rd, 2017
13
+
14
+ [0.9.9]: https://github.com/lsegal/yard/compare/v0.9.8...v0.9.9
15
+
16
+ - Added `gem uninstall` hooks to remove YARD documentation files. (#1083)
17
+ - Added support for C++ namespaces. (#809)
18
+ - Fixed issue where loading a .html page via an anchor would not scroll to
19
+ the anchor section. (#1082)
20
+ - Hide some Ruby warnings.
21
+ - Improve progress indicator icons in terminal.
22
+
23
+ # [0.9.8] - January 13th, 2017
24
+
25
+ [0.9.8]: https://github.com/lsegal/yard/compare/v0.9.7...v0.9.8
2
26
 
3
27
  - Fixed installed gems not being correctly found in `yard server` and by plugins.
4
28
  - Fixed tokenization of `%w(...)` array syntax.
5
29
 
6
- # 0.9.7 - January 9th, 2017
30
+ # [0.9.7] - January 9th, 2017
31
+
32
+ [0.9.7]: https://github.com/lsegal/yard/compare/v0.9.6...v0.9.7
7
33
 
8
34
  - Fixed resolution of absolute object paths with ambiguous names. (#1029)
9
35
 
10
- # 0.9.6 - January 7th, 2017
36
+ # [0.9.6] - January 7th, 2017
37
+
38
+ [0.9.6]: https://github.com/lsegal/yard/compare/v0.9.5...v0.9.6
11
39
 
12
40
  - Removed official support for Ruby 1.x (1.8/1.9). YARD can still be installed
13
41
  in these versions, but support is not guaranteed. Simple bug fixes may still
@@ -28,7 +56,9 @@
28
56
  - Use RubyGems 2.x+ API to query gems when available instead of using backport.
29
57
  - Various bug fixes
30
58
 
31
- # 0.9.5 - July 22nd, 2016
59
+ # [0.9.5] - July 22nd, 2016
60
+
61
+ [0.9.5]: https://github.com/lsegal/yard/compare/v0.9.4...v0.9.5
32
62
 
33
63
  - `yard doc` will now generate `.yardoc/processing` and `.yardoc/complete` files
34
64
  to allow other tools to properly detect when YARD is in the middle of parsing
@@ -39,11 +69,15 @@
39
69
  - Added warning for macros attached to non-method objects.
40
70
  - Fixed a few more parsing errors.
41
71
 
42
- # 0.9.4 - July 21st, 2016
72
+ # [0.9.4] - July 21st, 2016
73
+
74
+ [0.9.4]: https://github.com/lsegal/yard/compare/v0.9.3...v0.9.4
43
75
 
44
76
  - Minor Ruby file parsing and CSS bug fixes.
45
77
 
46
- # 0.9.3 - July 20th, 2016
78
+ # [0.9.3] - July 20th, 2016
79
+
80
+ [0.9.3]: https://github.com/lsegal/yard/compare/v0.9.2...v0.9.3
47
81
 
48
82
  - Added support for {YARD::Server::RackAdapter} to be mounted under prefix URIs.
49
83
  - Fixed regression in `yard server -g` that caused static file assets on index
@@ -51,7 +85,9 @@
51
85
  - Fixed regression in `yard server -g` index page that disabled scrolling and
52
86
  caused other HTML rendering glitches.
53
87
 
54
- # 0.9.2 - July 19th, 2016
88
+ # [0.9.2] - July 19th, 2016
89
+
90
+ [0.9.2]: https://github.com/lsegal/yard/compare/v0.9.1...v0.9.2
55
91
 
56
92
  - Added `yard config --gem-install-[yri|yard]` commands which auto-configure
57
93
  your `~/.gemrc` file to run yri/yard instead of ri/rdoc on a `gem install`.
@@ -62,7 +98,9 @@
62
98
  - YRI will now search across all gem versions (latest first) for the .yardoc
63
99
  database.
64
100
 
65
- # 0.9.1 - July 18th, 2016
101
+ # [0.9.1] - July 18th, 2016
102
+
103
+ [0.9.1]: https://github.com/lsegal/yard/compare/v0.9.0...v0.9.1
66
104
 
67
105
  - Added "Attributes" section to `yard stats`.
68
106
  - Added support for RubyGems 2.x `--document=yri,yard` flags. You can now run
@@ -95,7 +133,9 @@
95
133
  - {YARD::CodeObjects::Base#format} now passes the :type parameter to templates.
96
134
  - Hide methods with filtered namespaces in Method Listing.
97
135
 
98
- # 0.9.0 - July 4th, 2016
136
+ # [0.9.0] - July 4th, 2016
137
+
138
+ [0.9.0]: https://github.com/lsegal/yard/compare/v0.8.7.6...v0.9.0
99
139
 
100
140
  Special thanks to Alex Dowad, MSP-Greg, and Alex McLain for their extended
101
141
  contributions to this version.
@@ -114,12 +154,16 @@ contributions to this version.
114
154
  - Fixed deprecation warnings from Rake 10.x.
115
155
  - Tests updated for RSpec 3.
116
156
 
117
- # 0.8.7.6 - October 26, 2014
157
+ # [0.8.7.6] - October 26, 2014
158
+
159
+ [0.8.7.6]: https://github.com/lsegal/yard/compare/v0.8.7.5...v0.8.7.6
118
160
 
119
161
  - Support using `@option` tag on keyword arg splat parameter. (#729)
120
162
  - Add `.stats_options` for `YardocTask`. (#800, #801)
121
163
 
122
- # 0.8.7.5 - October 26, 2014
164
+ # [0.8.7.5] - October 26, 2014
165
+
166
+ [0.8.7.5]: https://github.com/lsegal/yard/compare/v0.8.7.4...v0.8.7.5
123
167
 
124
168
  - Fix linking of methods in top level namespace in method listing. (#776)
125
169
  - Support using C macros in function declarations. (#810)
@@ -138,6 +182,8 @@ contributions to this version.
138
182
 
139
183
  # 0.8.7.4 - March 22, 2014
140
184
 
185
+ [0.8.7.4]: https://github.com/lsegal/yard/compare/v0.8.7.3...v0.8.7.4
186
+
141
187
  - Mark C methods as explicit but also remove explicit check in stats. (#727)
142
188
  - Report unresolved parent namespaces as undocumentable errors instead. (#753)
143
189
  - No longer ignore overridden methods from documentation check in stats (#719)
@@ -151,7 +197,9 @@ contributions to this version.
151
197
  - Fixed a typo that was causing Windows detection to always fail. (#715)
152
198
  - Add debug information when loading a plugin fails. (#711)
153
199
 
154
- # 0.8.7.3 - November 1, 2013
200
+ # [0.8.7.3] - November 1, 2013
201
+
202
+ [0.8.7.3]: https://github.com/lsegal/yard/compare/v0.8.7.2...v0.8.7.3
155
203
 
156
204
  - Handle Unicode method/class/file names in server URL encoding (lsegal/rubydoc.info#69).
157
205
  - Style keyword style hashes with same symbol color in code highlighting (#707).
@@ -161,34 +209,46 @@ contributions to this version.
161
209
  - Add support for extra Ruby 2 symbol types in Ripper (#701).
162
210
  - Ensure config directory exists before saving config file (#700).
163
211
 
164
- # 0.8.7.2 - September 18, 2013
212
+ # [0.8.7.2] - September 18, 2013
213
+
214
+ [0.8.7.2]: https://github.com/lsegal/yard/compare/v0.8.7.1...v0.8.7.2
165
215
 
166
216
  - Disallow absolute URLs when using frame anchor support.
167
217
  - Support casted functions in CRuby method declarations (#697)
168
218
 
169
- # 0.8.7.1 - September 11, 2013
219
+ # [0.8.7.1] - September 11, 2013
220
+
221
+ [0.8.7.1]: https://github.com/lsegal/yard/compare/v0.8.7...v0.8.7.1
170
222
 
171
223
  - Fix potential XSS issue with frame anchor support.
172
224
  - Add support for gettext 3.x gem.
173
225
 
174
- # 0.8.7 - July 26, 2013
226
+ # [0.8.7] - July 26, 2013
227
+
228
+ [0.8.7]: https://github.com/lsegal/yard/compare/v0.8.6.2...v0.8.7
175
229
 
176
230
  - Added `--hide-api API` option to hide objects with a given `@api` tag (#685).
177
231
  - Added "Returns ...." prefix to summary when a lone @return tag is used.
178
232
  - Fixed issue that caused ref tags to be added to a docstring twice (#678).
179
233
  - Fixed formatting issue in docstring summaries (#686)
180
234
 
181
- # 0.8.6.2 - June 27, 2013
235
+ # [0.8.6.2] - June 27, 2013
236
+
237
+ [0.8.6.2]: https://github.com/lsegal/yard/compare/v0.8.6.1...v0.8.6.2
182
238
 
183
239
  - Fixed issue where `yard graph` was not displaying methods
184
240
 
185
- # 0.8.6.1 - April 14, 2013
241
+ # [0.8.6.1] - April 14, 2013
242
+
243
+ [0.8.6.1]: https://github.com/lsegal/yard/compare/v0.8.6...v0.8.6.1
186
244
 
187
245
  - Fixed broken links in File menu on default HTML template
188
246
  - Added --layout switch to `yard display` to wrap output in layout template.
189
247
  - See {file:docs/WhatsNew.md} for more information on added features.
190
248
 
191
- # 0.8.6 - April 13, 2013
249
+ # [0.8.6] - April 13, 2013
250
+
251
+ [0.8.6]: https://github.com/lsegal/yard/compare/v0.8.5.2...v0.8.6
192
252
 
193
253
  - Various fixes and improved Ruby 2.x compatibility support
194
254
  - Added support for `asciidoc` markup type
@@ -196,24 +256,34 @@ contributions to this version.
196
256
  - Added `yard display` command to display and format an individual object
197
257
  - See {file:docs/WhatsNew.md} for more information on added features.
198
258
 
199
- # 0.8.5.2 - February 26, 2013
259
+ # [0.8.5.2] - February 26, 2013
260
+
261
+ [0.8.5.2]: https://github.com/lsegal/yard/compare/v0.8.5.1...v0.8.5.2
200
262
 
201
263
  - Support new keyword argument syntax in method signatures (Ruby 2.x)
202
264
 
203
- # 0.8.5.1 - February 25, 2013
265
+ # [0.8.5.1] - February 25, 2013
266
+
267
+ [0.8.5.1]: https://github.com/lsegal/yard/compare/v0.8.5...v0.8.5.1
204
268
 
205
269
  - Fix `yard diff` of gem files with RubyGems 2.x
206
270
 
207
- # 0.8.5 - February 24, 2013
271
+ # [0.8.5] - February 24, 2013
272
+
273
+ [0.8.5]: https://github.com/lsegal/yard/compare/v0.8.4.1...v0.8.5
208
274
 
209
275
  - Basic support for Ruby 2.0 (fix compat issues in RDoc 4.0, RubyGems 2.0)
210
276
  - Add CSS styling for tables in default HTML template
211
277
 
212
- # 0.8.4.1 - February 5, 2013
278
+ # [0.8.4.1] - February 5, 2013
279
+
280
+ [0.8.4.1]: https://github.com/lsegal/yard/compare/v0.8.4...v0.8.4.1
213
281
 
214
282
  - Fix regression that broke loading of existing yardoc dbs (#648)
215
283
 
216
- # 0.8.4 - February 4, 2013
284
+ # [0.8.4] - February 4, 2013
285
+
286
+ [0.8.4]: https://github.com/lsegal/yard/compare/v0.8.3...v0.8.4
217
287
 
218
288
  - Add `-B/--bind` switch to yard server (#593, #608)
219
289
  - Add CodeObjects::Base#title for plugins to customize how object
@@ -225,7 +295,9 @@ contributions to this version.
225
295
  - Fix line range for class/module node bodies (#626)
226
296
  - Search extended modules for attached DSL macros (#553)
227
297
 
228
- # 0.8.3 - October 14, 2012
298
+ # [0.8.3] - October 14, 2012
299
+
300
+ [0.8.3]: https://github.com/lsegal/yard/compare/v0.8.2.1...v0.8.3
229
301
 
230
302
  - Add `--non-transitive-tag` to disable tag transitivity (#571)
231
303
  - Support --db inside .yardopts for graph/server commands (#583, #586)
@@ -236,11 +308,15 @@ contributions to this version.
236
308
  - Fix to `--api` and `--no-api` support (#559)
237
309
  - Fix class nesting issues when path starts with "::" (#552)
238
310
 
239
- # 0.8.2.1 - June 9, 2012
311
+ # [0.8.2.1] - June 9, 2012
312
+
313
+ [0.8.2.1]: https://github.com/lsegal/yard/compare/v0.8.2...v0.8.2.1
240
314
 
241
315
  - Fix a set of regressions in yard server search and dynamic generation
242
316
 
243
- # 0.8.2 - June 7, 2012
317
+ # [0.8.2] - June 7, 2012
318
+
319
+ [0.8.2]: https://github.com/lsegal/yard/compare/v0.8.1...v0.8.2
244
320
 
245
321
  - Added progress style output in tty terminals
246
322
  - Embedded mixins should ignore methods defined on module (#539)
@@ -250,14 +326,18 @@ contributions to this version.
250
326
  - Fixed regression that caused various commands to not show output (#548)
251
327
  - Respect current visibility when parsing class conditions (#551)
252
328
 
253
- # 0.8.1 - May 2, 2012
329
+ # [0.8.1] - May 2, 2012
330
+
331
+ [0.8.1]: https://github.com/lsegal/yard/compare/v0.8.0...v0.8.1
254
332
 
255
333
  - Added `--[no-]api` switch to generate docs for API sets (see {file:docs/WhatsNew.md} for details) (#532)
256
334
  - The `yard list` command now uses cache by default (#533)
257
335
  - Fix `yardoc` generating incorrectly named method list file (#528)
258
336
  - Fix HTML output occasionally showing trailing mdash on options list (#522)
259
337
 
260
- # 0.8.0 - April 30, 2012
338
+ # [0.8.0] - April 30, 2012
339
+
340
+ [0.8.0]: https://github.com/lsegal/yard/compare/v0.7.5...v0.8.0
261
341
 
262
342
  - See {file:docs/WhatsNew.md} for a list of added features
263
343
  - Over 20 bug fixes:
@@ -286,11 +366,15 @@ contributions to this version.
286
366
  - Fix search bar not redirecting to method page. (#509)
287
367
  - Fix server returning exception message bodies as String (#518)
288
368
 
289
- # 0.7.5 - January 31, 2012
369
+ # [0.7.5] - January 31, 2012
370
+
371
+ [0.7.5]: https://github.com/lsegal/yard/compare/v0.7.4...v0.7.5
290
372
 
291
373
  - Various minor bug fixes
292
374
 
293
- # 0.7.4 - December 2, 2011
375
+ # [0.7.4] - December 2, 2011
376
+
377
+ [0.7.4]: https://github.com/lsegal/yard/compare/v0.7.3...v0.7.4
294
378
 
295
379
  - Redcarpet is now the default Markdown formatting library. GFM now works out-of-box (#404)
296
380
  - Fix server side searching for elements that are marked private (#420)
@@ -303,14 +387,18 @@ contributions to this version.
303
387
  - Improve support for has_rdoc in RubyGems 1.8.x (#401)
304
388
  - See the {file:docs/WhatsNew.md} document for details on added features
305
389
 
306
- # 0.7.3 - October 15, 2011
390
+ # [0.7.3] - October 15, 2011
391
+
392
+ [0.7.3]: https://github.com/lsegal/yard/compare/v0.7.2...v0.7.3
307
393
 
308
394
  - Improve support for parsing under Ruby 1.9.2p290 and 1.9.3 (#365, #370)
309
395
  - Add support for SWIG generated CRuby code (#369)
310
396
  - Add support for `rb_define_attr` calls in CRuby code (#362)
311
397
  - Handle file pointers in CRuby code (#358)
312
398
 
313
- # 0.7.2 - June 14, 2011
399
+ # [0.7.2] - June 14, 2011
400
+
401
+ [0.7.2]: https://github.com/lsegal/yard/compare/v0.7.1...v0.7.2
314
402
 
315
403
  - Fix `yard --help` not showing proper output
316
404
  - YARD now expands path to `.yardoc` file in daemon mode for server (#328)
@@ -320,11 +408,15 @@ contributions to this version.
320
408
  - Fix bug in constant documentation when using `%w()` (#348)
321
409
  - Fix YARD style URL links when using autolinking markdown (#353)
322
410
 
323
- # 0.7.1 - May 18, 2011
411
+ # [0.7.1] - May 18, 2011
412
+
413
+ [0.7.1]: https://github.com/lsegal/yard/compare/v0.7.0...v0.7.1
324
414
 
325
415
  - Fixes a bug in `yard server` not displaying class list properly.
326
416
 
327
- # 0.7.0 - May 17, 2011
417
+ # [0.7.0] - May 17, 2011
418
+
419
+ [0.7.0]: https://github.com/lsegal/yard/compare/v0.6.8...v0.7.0
328
420
 
329
421
  - See the {file:docs/WhatsNew.md} document for details on added features
330
422
  - Make sure that Docstring#line_range is filled when possible (#243)
@@ -335,23 +427,31 @@ contributions to this version.
335
427
  - Ignore keyboard shortcuts when an input is active (#312)
336
428
  - And more...
337
429
 
338
- # 0.6.8 - April 14, 2011
430
+ # [0.6.8] - April 14, 2011
431
+
432
+ [0.6.8]: https://github.com/lsegal/yard/compare/v0.6.7...v0.6.8
339
433
 
340
434
  - Fix regression in RDoc 1.x markup loading
341
435
  - Fix regression in loading of markup libraries for `yard server`
342
436
 
343
- # 0.6.7 - April 6, 2011
437
+ # [0.6.7] - April 6, 2011
438
+
439
+ [0.6.7]: https://github.com/lsegal/yard/compare/v0.6.6...v0.6.7
344
440
 
345
441
  - Fix has_rdoc gem specification issue with new RubyGems plugin API (oops!)
346
442
 
347
- # 0.6.6 - April 6, 2011
443
+ # [0.6.6] - April 6, 2011
444
+
445
+ [0.6.6]: https://github.com/lsegal/yard/compare/v0.6.5...v0.6.6
348
446
 
349
447
  - Fix error message when RDoc is not present (#270)
350
448
  - Add markup type 'none' to perform basic HTML translation (fallback when RDoc is not present)
351
449
  - Add support for RubyGems 1.7.x (#272)
352
450
  - Fix rendering of `{url description}` syntax when description contains newline
353
451
 
354
- # 0.6.5 - March 13, 2011
452
+ # [0.6.5] - March 13, 2011
453
+
454
+ [0.6.5]: https://github.com/lsegal/yard/compare/v0.6.4...v0.6.5
355
455
 
356
456
  - Support `ripper` gem in Ruby 1.8.7
357
457
  - Upgrade jQuery to 1.5.1
@@ -374,7 +474,9 @@ contributions to this version.
374
474
  - Support `private_constant` class method for 1.9.3 (#219)
375
475
  - Do not assume RDoc is installed (#214)
376
476
 
377
- # 0.6.4 - December 21, 2010
477
+ # [0.6.4] - December 21, 2010
478
+
479
+ [0.6.4]: https://github.com/lsegal/yard/compare/v0.6.3...v0.6.4
378
480
 
379
481
  - Fix yri tool crashing with new Config class (gh-217)
380
482
  - Fix support for ::TopLevelConstants (gh-216)
@@ -386,11 +488,15 @@ contributions to this version.
386
488
  - Disallow `extend self` inside of a class (gh-202)
387
489
  - Constants now recognized in C extensions (gh-201)
388
490
 
389
- # 0.6.3 - November 21, 2010
491
+ # [0.6.3] - November 21, 2010
492
+
493
+ [0.6.3]: https://github.com/lsegal/yard/compare/v0.6.2...v0.6.3
390
494
 
391
495
  - Fixed regression that caused `yardoc --markup` to silently exit
392
496
 
393
- # 0.6.2 - November 15, 2010
497
+ # [0.6.2] - November 15, 2010
498
+
499
+ [0.6.2]: https://github.com/lsegal/yard/compare/v0.6.1...v0.6.2
394
500
 
395
501
  - **Plugins no longer automatically load, use `--plugin` to load a plugin**
396
502
  - Added YARD::Config and ~/.yard/config YAML configuration file
@@ -405,7 +511,9 @@ contributions to this version.
405
511
  - Improved support for JRuby 1.6.4+. YARD now passes all specs in JRuby (gh-185)
406
512
  - Improved YARD documentation (gh-172,191,196)
407
513
 
408
- # 0.6.1 - September 06, 2010
514
+ # [0.6.1] - September 06, 2010
515
+
516
+ [0.6.1]: https://github.com/lsegal/yard/compare/v0.6.0...v0.6.1
409
517
 
410
518
  - Fixed TOC showing on top of class/method list in no-frames view
411
519
  - A message now displays when running `yard server` with Rack/Mongrel installed
@@ -415,7 +523,9 @@ contributions to this version.
415
523
  - Fixed support for loading .yardoc files under Windows
416
524
  - Fixed inheritance tree arrows not displaying in certain environments
417
525
 
418
- # 0.6.0 - August 29, 2010
526
+ # [0.6.0] - August 29, 2010
527
+
528
+ [0.6.0]: https://github.com/lsegal/yard/compare/v0.5.8...v0.6.0
419
529
 
420
530
  - Added dynamic local documentation server
421
531
  - Added @group/@endgroup declarations to organize methods into groups
@@ -429,11 +539,15 @@ contributions to this version.
429
539
  - Removed `yard-graph` executable
430
540
  - See more changes in the {file:docs/WhatsNew.md what's new document}
431
541
 
432
- # 0.5.8 - June 22, 2010
542
+ # [0.5.8] - June 22, 2010
543
+
544
+ [0.5.8]: https://github.com/lsegal/yard/compare/v0.5.7...v0.5.8
433
545
 
434
546
  - Merge fix from 0.6 branch for --no-private visibility checking
435
547
 
436
- # 0.5.7 - June 21, 2010
548
+ # [0.5.7] - June 21, 2010
549
+
550
+ [0.5.7]: https://github.com/lsegal/yard/compare/v0.5.6...v0.5.7
437
551
 
438
552
  - Fixed visibility flag parsing in `yardoc`
439
553
  - Updated Parser Architecture documentation with new SourceParser API
@@ -441,36 +555,52 @@ contributions to this version.
441
555
  - Fix loading of .yardoc file as cache (and preserving aliases)
442
556
  - Fix "lib" directory missing when running YARD on installed gems
443
557
 
444
- # 0.5.6 - June 12, 2010
558
+ # [0.5.6] - June 12, 2010
559
+
560
+ [0.5.6]: https://github.com/lsegal/yard/compare/v0.5.5...v0.5.6
445
561
 
446
562
  - Bug fixes for RubyGems plugin, `has_rdoc=false` should now work
447
563
  - New API for registering custom parsers. See {file:docs/WhatsNew.md}
448
564
 
449
- # 0.5.5 - May 22, 2010
565
+ # [0.5.5] - May 22, 2010
566
+
567
+ [0.5.5]: https://github.com/lsegal/yard/compare/v0.5.4...v0.5.5
450
568
 
451
569
  - Various bug fixes
452
570
 
453
- # 0.5.4 - March 22, 2010
571
+ # [0.5.4] - March 22, 2010
572
+
573
+ [0.5.4]: https://github.com/lsegal/yard/compare/v0.5.3...v0.5.4
454
574
 
455
575
  - See {file:docs/WhatsNew.md what's new document} for changes
456
576
 
457
- # 0.5.3 - January 11, 2010
577
+ # [0.5.3] - January 11, 2010
578
+
579
+ [0.5.3]: https://github.com/lsegal/yard/compare/v0.5.2...v0.5.3
458
580
 
459
581
  - See {file:docs/WhatsNew.md what's new document} for changes
460
582
 
461
- # 0.5.2 - December 16, 2009
583
+ # [0.5.2] - December 16, 2009
584
+
585
+ [0.5.2]: https://github.com/lsegal/yard/compare/v0.5.1...v0.5.2
462
586
 
463
587
  - See {file:docs/WhatsNew.md what's new document} for changes
464
588
 
465
- # 0.5.1 - December 15, 2009
589
+ # [0.5.1] - December 15, 2009
590
+
591
+ [0.5.1]: https://github.com/lsegal/yard/compare/v0.5.0...v0.5.1
466
592
 
467
593
  - See {file:docs/WhatsNew.md what's new document} for changes
468
594
 
469
- # 0.5.0 - December 13, 2009
595
+ # [0.5.0] - December 13, 2009
596
+
597
+ [0.5.0]: https://github.com/lsegal/yard/compare/v0.4.0...v0.5.0
470
598
 
471
599
  - See {file:docs/WhatsNew.md what's new document} for changes
472
600
 
473
- # 0.4.0 - November 15, 2009
601
+ # [0.4.0] - November 15, 2009
602
+
603
+ [0.4.0]: https://github.com/lsegal/yard/compare/v0.2.3.5...v0.4.0
474
604
 
475
605
  - Added new templating engine based on [tadpole](http://github.com/lsegal/tadpole)
476
606
  - Added YARD queries (`--query` CLI argument to yardoc)
@@ -480,19 +610,27 @@ contributions to this version.
480
610
  - Changed default rake task to `rake yard`
481
611
  - Read about changes in {file:docs/WhatsNew.md}
482
612
 
483
- # 0.2.3.5 - August 13, 2009
613
+ # [0.2.3.5] - August 13, 2009
614
+
615
+ [0.2.3.5]: https://github.com/lsegal/yard/compare/v0.2.3.4...v0.2.3.5
484
616
 
485
617
  - Minor bug fixes.
486
618
 
487
- # 0.2.3.4 - August 07, 2009
619
+ # [0.2.3.4] - August 07, 2009
620
+
621
+ [0.2.3.4]: https://github.com/lsegal/yard/compare/v0.2.3.3...v0.2.3.4
488
622
 
489
623
  - Minor bug fixes.
490
624
 
491
- # 0.2.3.3 - July 26, 2009
625
+ # [0.2.3.3] - July 26, 2009
626
+
627
+ [0.2.3.3]: https://github.com/lsegal/yard/compare/v0.2.3.2...v0.2.3.3
492
628
 
493
629
  - Minor bug fixes.
494
630
 
495
- # 0.2.3.2 - July 06, 2009
631
+ # [0.2.3.2] - July 06, 2009
632
+
633
+ [0.2.3.2]: https://github.com/lsegal/yard/compare/v0.2.3.1...v0.2.3.2
496
634
 
497
635
  - Fix Textile hard-break issues
498
636
  - Add description for @see tag to use as link title in HTML docs.
@@ -506,23 +644,31 @@ contributions to this version.
506
644
 
507
645
  yardoc --private lib/**/*.rb - FAQ LICENSE
508
646
 
509
- # 0.2.3.1 - June 13, 2009
647
+ # [0.2.3.1] - June 13, 2009
648
+
649
+ [0.2.3.1]: https://github.com/lsegal/yard/compare/v0.2.3...v0.2.3.1
510
650
 
511
651
  - Add a RubyGems 1.3.2+ plugin to generate YARD documentation instead of
512
652
  RDoc. To take advantage of this plugin, set `has_rdoc = 'yard'` in your
513
653
  .gemspec file.
514
654
 
515
- # 0.2.3 - June 07, 2009
655
+ # [0.2.3] - June 07, 2009
656
+
657
+ [0.2.3]: https://github.com/lsegal/yard/compare/v0.2.2...v0.2.3
516
658
 
517
659
  - See the {file:docs/WhatsNew.md} file for a list of important new features.
518
660
 
519
- # 0.2.2 - Jun 16, 2008
661
+ # [0.2.2] - Jun 16, 2008
662
+
663
+ [0.2.2]: https://github.com/lsegal/yard/compare/v0.2.1...v0.2.2
520
664
 
521
665
  - This is the largest changset since yard's conception and involves a complete
522
666
  overhaul of the parser and API to make it more robust and far easier to
523
667
  extend and use for the developer.
524
668
 
525
- # 0.2.1 - February 20, 2008
669
+ # [0.2.1] - February 20, 2008
670
+
671
+ [0.2.1]: https://github.com/lsegal/yard/compare/v0.1a...v0.2.1
526
672
 
527
673
  - See the {file:docs/WhatsNew.md} file for a list of important new features.
528
674