0.9.27 (2021-11-29)
* Add support for Ruby 3.0 endless method definitions. (#1376, #1381)
* Add existence check for README file (#1367)
* Support module_function decorator (#1365)
* Add CommonMarker markup support (-m commonmarker) (#1157, #1388)
* Fix nested array parsing (#1389)
* Add WEBrick as a runtime dependency for Ruby 3.0 support (#1400)
* Support fail_on_warning option in yard stats command (#1392)
* Better integration with Sorbet (#1401)
* Handle include mixins on complex paths (#1386)
* Fix @!scope maintaining state in lone comment blocks (#1411)
* Remove support for Travis CI
All checksums have been double-checked against existing RMD160 and
SHA512 hashes
Unfetchable distfiles (fetched conditionally?):
./textproc/convertlit/distinfo clit18src.zip
Update ruby-yard to 0.9.24.
pkgsrc change: fix redundant CATEGORIES.
# 0.9.24 - January 8th, 2020
[0.9.24]: https://github.com/lsegal/yard/compare/v0.9.23...v0.9.24
- Add {YARD::CodeObjects::NamespaceMapper.on_invalidate} callback when separator
cache is changed.
- Fix issue where Registry fails to resolve first-time lookups on instance methods.
# 0.9.23 - January 5th, 2020
[0.9.23]: https://github.com/lsegal/yard/compare/v0.9.22...v0.9.23
- Fix issues with double encoded code blocks when highlighted from an extra
file.
# 0.9.22 - December 31st, 2019
[0.9.22]: https://github.com/lsegal/yard/compare/v0.9.21...v0.9.22
- Revert jquery update in last release since it requires more changes. (#1298)
# 0.9.21 - December 31st, 2019
[0.9.21]: https://github.com/lsegal/yard/compare/v0.9.20...v0.9.21
- Updates to add support for Ruby 2.7.0 (#1290, #1296)
- Fix parsing of multiline method signatures (#1220)
- Remove RubyGems post install message (#1269)
- Improve object deletion from RegistryStore (#1284)
- Improve memory usage performance (#1260)
- Handle include and extend calls with explicit receivers (#1274)
- Fix deep nesting of TOC items (#1288)
- Fix highlighting for Asciidoc markup code blocks (#1276)
- Fix HTML formatting of script tags (#1263)
- Update jquery to 3.4.1 (#1294)
- Test fixes (#1244)
Update ruby-yard to 0.9.20, fixing CVE-2019-14369.
# 0.9.20 - June 27th, 2019
[0.9.20]: https://github.com/lsegal/yard/compare/v0.9.19...v0.9.20
- Fix parsing of stringified Symbols in Ruby source (#1256).
- Fix path traversal vulnerability in `yard server`. This bug would allow
unsanitized HTTP requests to access arbitrary files on the machine of a
`yard server` host under certain conditions. Thanks to CuongMX from
Viettel Cyber Security for discovering this vulnerability.
# 0.9.19 - April 2nd, 2019
[0.9.19]: https://github.com/lsegal/yard/compare/v0.9.16...v0.9.19
- Fixed bug in browser back button (#1071, #1228)
- Fixed handling of ArgumentError in ExtraFileObject (#1198)
- Fixed double return tag displaying on boolean methods (#1226)
- Removed unused `Module#namespace_name` function (#1229)
- Fixed parsing order of README files. YARD will now prefer README over
README.md over README.x.md or README-x.md (and the like). READMEs will now
also be ordered by filename; the first README is still chosen unless
`--readme` is provided.
- Updated AsciiDoc markup support to use non-deprecated calls.
# [0.9.12] - November 26th, 2017
[0.9.12]: https://github.com/lsegal/yard/compare/v0.9.11...v0.9.12
- Be more explicit about lack of support for absolute paths in extra files
specified by `yard doc` command.
# [0.9.11] - November 23rd, 2017
[0.9.11]: https://github.com/lsegal/yard/compare/v0.9.10...v0.9.11
- Fixed security issue in `--readme` that allowed for arbitrary file reads on
disk. Credit to ztz <ztz@ztz.me> for discovering this issue.
- Improved styling for inline code blocks (#1142).
# [0.9.10] - November 18th, 2017
[0.9.10]: https://github.com/lsegal/yard/compare/v0.9.9...v0.9.10
- Added `--fail-on-warning` option for `yard doc` which exits with a non-zero
code if there are any warnings (#1093).
- Added support for parsing inside `Struct.new` blocks (#1099).
- Added support new ripper AST tokens (#1104, #1124).
- Fixed an issue where `@see (obj)` reference tags would fail (#1111)
- Fix sorting in `yard stats` (#1123).
Unsorted entries in PLIST files have generated a pkglint warning for at
least 12 years. Somewhat more recently, pkglint has learned to sort
PLIST files automatically. Since pkglint 5.4.23, the sorting is only
done in obvious, simple cases. These have been applied by running:
pkglint -Cnone,PLIST -Wnone,plist-sort -r -F
Release v0.9.9 2017/04/23
* Added gem uninstall hooks to remove YARD documentation files. (#1083)
* Added support for C++ namespaces. (#809)
* Fixed issue where loading a .html page via an anchor would not scroll to
the anchor section. (#1082)
* Hide some Ruby warnings.
* Improve progress indicator icons in terminal.
# 0.9.8 - January 13th, 2017
- Fixed installed gems not being correctly found in `yard server` and by plugins.
- Fixed tokenization of `%w(...)` array syntax.
# 0.9.7 - January 9th, 2017
- Fix resolution of absolute object paths with ambiguous names. (#1029)
# 0.9.6 - January 7th, 2017
- Removed official support for Ruby 1.x (1.8/1.9). YARD can still be installed
in these versions, but support is not guaranteed. Simple bug fixes may still
be considered via pull request only. Issues without code will be automatically
closed.
- Added {YARD::Tags::Tag#explain_types} returning a plain English summary
of the type specification of a given tag. Also adds {YARD::Tags::TypesExplainer}
as an implementation class for the method.
- Added support for automatic linking of constants and method calls of
Ruby syntax highlighted source code in generated HTML. Also adds the
{YARD::Parser::Ruby::TokenResolver} implementation class to iterate over
tokenized code with extra resolved object information.
- Added support for compound constant assignments (`A::B::C = true`).
- Added `LibraryVersion#yardoc_file_for_SOURCE` callback method for sources with
a pre-determined yardoc file location. Implement this method instead of
manually setting `library.yardoc_file = ...` in your load method (you can
still assign the attribute manually).
- Use RubyGems 2.x+ API to query gems when available instead of using backport.
# 0.9.5 - July 22nd, 2016
- `yard doc` will now generate `.yardoc/processing` and `.yardoc/complete` files
to allow other tools to properly detect when YARD is in the middle of parsing
source files, and when it has completed writing the database.
- Added support for on-demand generation of LibraryVersion objects using the
`:disk` source type. LibraryVersion objects pointing to a .yardoc database
directory will now auto-generate if there is a `source_path` attached.
- Added warning for macros attached to non-method objects.
- Fixed a few more parsing errors.
Problems found locating distfiles:
Package cabocha: missing distfile cabocha-0.68.tar.bz2
Package convertlit: missing distfile clit18src.zip
Package php-enchant: missing distfile php-enchant/enchant-1.1.0.tgz
Otherwise, existing SHA1 digests verified and found to be the same on
the machine holding the existing distfiles (morden). All existing
SHA1 digests retained for now as an audit trail.
# 0.8.7.6
- Support using `@option` tag on keyword arg splat parameter. (#729)
- Add `.stats_options` for `YardocTask`. (#800, #801)
# 0.8.7.5 - October 26, 2014
- Fix linking of methods in top level namespace in method listing. (#776)
- Support using C macros in function declarations. (#810)
- YARD will no longer group comment blocks starting on the same column if they
are preceded by code. (#798)
- Handle anonymous lambda calls in toplevel scope. (#774)
- Support I18n in `@overload` tags. (#794)
- Support `yard stats` for objects with no file property. (#792)
- Support for named arguments in Ruby >= 2.1. (#785)
- Exclude README backup files from YARD generation. (#790)
- Turned on the lax spacing option in Redcarpet to comply with the
Markdown standard.
- Escape HTML in YARD server search placeholder template.
- Fix issue with `private_class_method` support. (#760, #767)
- Enable tables support by default in Redcarpet Markdown provider. (#765)
YARD is a documentation generation tool for the Ruby programming language. It
enables the user to generate consistent, usable documentation that can be
exported to a number of formats very easily, and also supports extending for
custom Ruby constructs such as custom class level definitions.
