Releases: lsegal/yard
Releases · lsegal/yard
Release v0.9.17
Make test_doc Windows friendly
Release v0.9.16
Tag release v0.9.16
Release v0.9.15
0.9.15 - July 17th, 2018
- Fixed security issue in parsing of Ruby code that could allow for arbitrary
execution. Credit to Nelson Elhage nelhage@nelhage.com for discovering this
issue.
Release v0.9.14
- Fixed a regression in symbol parsing (#1170).
Release v0.9.13
Release v0.9.11
- Mark C methods as explicit but also remove explicit check in stats. (#727)
- Report unresolved parent namespaces as undocumentable errors instead. (#753)
- No longer ignore overridden methods from documentation check in stats (#719)
- Fix JRuby throwing exception when remove_method called on non-existent method. (#732)
- Add basic support for
private_class_method
(#747) - Ensure namespace is always set when parent module is not found. (#753)
- Set overflow as auto on table of contents.
- Report 100% documented if nothing is undocumented. (#754)
- Added support for RubyGems 2.0.0+. (#742)
- Allow users to enter their own YARD RakeTask name. (#705)
- Fixed a typo that was causing Windows detection to always fail. (#715)
- Add debug information when loading a plugin fails. (#711)
0.8.7.3 - November 1, 2013
- Handle Unicode method/class/file names in server URL encoding (docmeta/rubydoc.info#69).
- Style keyword style hashes with same symbol color in code highlighting (#707).
- Fix broken JS when visiting docs in file:// scheme (#706).
- Add support for new AsciiDoc file extensions (#704).
- Fix issues where non-Ruby code blocks would not display in Ruby 2 (#702).
- Add support for extra Ruby 2 symbol types in Ripper (#701).
- Ensure config directory exists before saving config file (#700).
0.8.7.2 - September 18, 2013
- Disallow absolute URLs when using frame anchor support.
- Support casted functions in CRuby method declarations (#697)
0.8.7.1 - September 11, 2013
- Fix potential XSS issue with frame anchor support.
- Add support for gettext 3.x gem.
0.8.7 - July 26, 2013
- Added
--hide-api API
option to hide objects with a given@api
tag (#685). - Added "Returns ...." prefix to summary when a lone @return tag is used.
- Fixed issue that caused ref tags to be added to a docstring twice (#678).
- Fixed formatting issue in docstring summaries (#686)
0.8.6.2 - June 27, 2013
- Fixed issue where
yard graph
was not displaying methods
0.8.6.1 - April 14, 2013
- Fixed broken links in File menu on default HTML template
- Added --layout switch to
yard display
to wrap output in layout template. - See {file:docs/WhatsNew.md} for more information on added features.
0.8.6 - April 13, 2013
- Various fixes and improved Ruby 2.x compatibility support
- Added support for
asciidoc
markup type - Added
yard markups
command to list available markup types - Added
yard display
command to display and format an individual object - See {file:docs/WhatsNew.md} for more information on added features.
0.8.5.2 - February 26, 2013
- Support new keyword argument syntax in method signatures (Ruby 2.x)
0.8.5.1 - February 25, 2013
- Fix
yard diff
of gem files with RubyGems 2.x
0.8.5 - February 24, 2013
- Basic support for Ruby 2.0 (fix compat issues in RDoc 4.0, RubyGems 2.0)
- Add CSS styling for tables in default HTML template
0.8.4.1 - February 5, 2013
- Fix regression that broke loading of existing yardoc dbs (#648)
0.8.4 - February 4, 2013
- Add
-B/--bind
switch to yard server (#593, #608) - Add CodeObjects::Base#title for plugins to customize how object
links display (#646) - Disable linking objects filtered out by verifiers (#645)
- Allow macro expansion on class methods (#632)
- Expand newly attached macro on first DSL method call (#631)
- Disable RubyGems plugin in Ruby 2.0 (#627)
- Fix line range for class/module node bodies (#626)
- Search extended modules for attached DSL macros (#553)
0.8.3 - October 14, 2012
- Add
--non-transitive-tag
to disable tag transitivity (#571) - Support --db inside .yardopts for graph/server commands (#583, #586)
- Fix handling for =begin/=end docstrings (#577, #578)
- Parser only sorts file lists when a glob is provided (#572)
- Fix formatting in
{include:Object#method}
syntax (#569) - Fix @option tag inside of module functions (#563)
- Fix to
--api
and--no-api
support (#559) - Fix class nesting issues when path starts with "::" (#552)
0.8.2.1 - June 9, 2012
- Fix a set of regressions in yard server search and dynamic generation
0.8.2 - June 7, 2012
- Added progress style output in tty terminals
- Embedded mixins should ignore methods defined on module (#539)
- Fixed permalinks for embedded mixins in
yard server
(#540) - Improve parsing in CRuby code (#543)
- Ensure Registry.resolve picks module when parsing mixins (#545)
- Fixed regression that caused various commands to not show output (#548)
- Respect current visibility when parsing class conditions (#551)
0.8.1 - May 2, 2012
- Added
--[no-]api
switch to generate docs for API sets (see {file:docs/WhatsNew.md} for details) (#532) - The
yard list
command now uses cache by default (#533) - Fix
yardoc
generating incorrectly named method list file (#528) - Fix HTML output occasionally showing trailing mdash on options list (#522)
0.8.0 - April 30, 2012
- See {file:docs/WhatsNew.md} for a list of added features
- Over 20 bug fixes:
- Properly filter hidden setter/getter attributes (#394)
- Fix test failures in Linux environments (#397, #472, #473, #512, #513)
- Fix attribute inheritance and @Private (#432)
- Fix attribute parsing (#435)
- Allow aliases for attributes (#436)
- Fix namespace fetching in
handle_alias()
(#437) - Fix overwritten attributes marked as inherited (#442)
- Fix documenting constants defined from C code with
rb_define_const()
(#443) - Do not escape snippets twice (#445)
- Ajax method/class search should not fire when a non-printable character is pressed (#446)
- Fix yard server crashing when RDoc is not installed (#456)
- Fix tags ignored when
(see #foo)
is used (#457) - Fix three "Returns" for two
@overload
tags (#458) - Do not auto-detect DSL methods as method objects if parameter name is not a valid method name (#464)
- Fix attaching of macros to Object (#465)
- Fix handling of
%w()
source in[]/[]=
parsed context. (#461, pull in #468) - Don't add default
@return
if@overload
has@return
. (#458, pull in #469) - Don't discard tags by (see ...). (#457, pull in #470)
- Fix constants listed as inherited when overwritten (#474)
- Fix
yardoc --asset
behaving differently on first and subsequent calls. (#477) !!!lang
code blocks should set the lang in<pre>
's class. (#478, #479)- Fix "File List" search tab error. (#502)
- Fix search bar not redirecting to method page. (#509)
- Fix server returning exception message bodies as String (#518)
0.7.5 - January 31, 2012
- Various minor bug fixes
0.7.4 - December 2, 2011
- Redcarpet is now the default Markdown formatting library. GFM now works out-of-box (#404)
- Fix server side searching for elements that are marked private (#420)
- Add 'textile_strict' and 'pre' markup types, reorganize text and none (#416)
- Improve encoding line detection (#415)
- Add support for
rb_define_alias
in CRuby code (#413) - Fix rendering of some keywords in source view (#410)
- Add support for RDoc 3.10+ (#406, #407)
- Fix typewriter text being processed in code blocks (#403)
- Improve support for has_rdoc in RubyGems 1.8.x (#401)
- See the {file:docs/WhatsNew.md} document for details on added features
0.7.3 - October 15, 2011
- Improve support for parsing under Ruby 1.9.2p290 and 1.9.3 (#365, #370)
- Add support for SWIG generated CRuby code (#369)
- Add support for
rb_define_attr
calls in CRuby code (#362) - Handle file pointers in CRuby code (#358)
0.7.2 - June 14, 2011
- Fix
yard --help
not showing proper output - YARD now expands path to
.yardoc
file in daemon mode for server (#328) - Fix
@overload
tag linking to wrong method (#330) - Fix incorrect return type when using
@macro
(#334) - YARD now requires 'thread' to support RubyGems 1.7+ (#338)
- Fix bug in constant documentation when using
%w()
(#348) - Fix YARD style URL links when using autolinking markdown (#353)
0.7.1 - May 18, 2011
- Fixes a bug in
yard server
not displaying class list properly.
0.7.0 - May 17, 2011
Release v0.9.10
- Mark C methods as explicit but also remove explicit check in stats. (#727)
- Report unresolved parent namespaces as undocumentable errors instead. (#753)
- No longer ignore overridden methods from documentation check in stats (#719)
- Fix JRuby throwing exception when remove_method called on non-existent method. (#732)
- Add basic support for
private_class_method
(#747) - Ensure namespace is always set when parent module is not found. (#753)
- Set overflow as auto on table of contents.
- Report 100% documented if nothing is undocumented. (#754)
- Added support for RubyGems 2.0.0+. (#742)
- Allow users to enter their own YARD RakeTask name. (#705)
- Fixed a typo that was causing Windows detection to always fail. (#715)
- Add debug information when loading a plugin fails. (#711)
0.8.7.3 - November 1, 2013
- Handle Unicode method/class/file names in server URL encoding (docmeta/rubydoc.info#69).
- Style keyword style hashes with same symbol color in code highlighting (#707).
- Fix broken JS when visiting docs in file:// scheme (#706).
- Add support for new AsciiDoc file extensions (#704).
- Fix issues where non-Ruby code blocks would not display in Ruby 2 (#702).
- Add support for extra Ruby 2 symbol types in Ripper (#701).
- Ensure config directory exists before saving config file (#700).
0.8.7.2 - September 18, 2013
- Disallow absolute URLs when using frame anchor support.
- Support casted functions in CRuby method declarations (#697)
0.8.7.1 - September 11, 2013
- Fix potential XSS issue with frame anchor support.
- Add support for gettext 3.x gem.
0.8.7 - July 26, 2013
- Added
--hide-api API
option to hide objects with a given@api
tag (#685). - Added "Returns ...." prefix to summary when a lone @return tag is used.
- Fixed issue that caused ref tags to be added to a docstring twice (#678).
- Fixed formatting issue in docstring summaries (#686)
0.8.6.2 - June 27, 2013
- Fixed issue where
yard graph
was not displaying methods
0.8.6.1 - April 14, 2013
- Fixed broken links in File menu on default HTML template
- Added --layout switch to
yard display
to wrap output in layout template. - See {file:docs/WhatsNew.md} for more information on added features.
0.8.6 - April 13, 2013
- Various fixes and improved Ruby 2.x compatibility support
- Added support for
asciidoc
markup type - Added
yard markups
command to list available markup types - Added
yard display
command to display and format an individual object - See {file:docs/WhatsNew.md} for more information on added features.
0.8.5.2 - February 26, 2013
- Support new keyword argument syntax in method signatures (Ruby 2.x)
0.8.5.1 - February 25, 2013
- Fix
yard diff
of gem files with RubyGems 2.x
0.8.5 - February 24, 2013
- Basic support for Ruby 2.0 (fix compat issues in RDoc 4.0, RubyGems 2.0)
- Add CSS styling for tables in default HTML template
0.8.4.1 - February 5, 2013
- Fix regression that broke loading of existing yardoc dbs (#648)
0.8.4 - February 4, 2013
- Add
-B/--bind
switch to yard server (#593, #608) - Add CodeObjects::Base#title for plugins to customize how object
links display (#646) - Disable linking objects filtered out by verifiers (#645)
- Allow macro expansion on class methods (#632)
- Expand newly attached macro on first DSL method call (#631)
- Disable RubyGems plugin in Ruby 2.0 (#627)
- Fix line range for class/module node bodies (#626)
- Search extended modules for attached DSL macros (#553)
0.8.3 - October 14, 2012
- Add
--non-transitive-tag
to disable tag transitivity (#571) - Support --db inside .yardopts for graph/server commands (#583, #586)
- Fix handling for =begin/=end docstrings (#577, #578)
- Parser only sorts file lists when a glob is provided (#572)
- Fix formatting in
{include:Object#method}
syntax (#569) - Fix @option tag inside of module functions (#563)
- Fix to
--api
and--no-api
support (#559) - Fix class nesting issues when path starts with "::" (#552)
0.8.2.1 - June 9, 2012
- Fix a set of regressions in yard server search and dynamic generation
0.8.2 - June 7, 2012
- Added progress style output in tty terminals
- Embedded mixins should ignore methods defined on module (#539)
- Fixed permalinks for embedded mixins in
yard server
(#540) - Improve parsing in CRuby code (#543)
- Ensure Registry.resolve picks module when parsing mixins (#545)
- Fixed regression that caused various commands to not show output (#548)
- Respect current visibility when parsing class conditions (#551)
0.8.1 - May 2, 2012
- Added
--[no-]api
switch to generate docs for API sets (see {file:docs/WhatsNew.md} for details) (#532) - The
yard list
command now uses cache by default (#533) - Fix
yardoc
generating incorrectly named method list file (#528) - Fix HTML output occasionally showing trailing mdash on options list (#522)
0.8.0 - April 30, 2012
- See {file:docs/WhatsNew.md} for a list of added features
- Over 20 bug fixes:
- Properly filter hidden setter/getter attributes (#394)
- Fix test failures in Linux environments (#397, #472, #473, #512, #513)
- Fix attribute inheritance and @Private (#432)
- Fix attribute parsing (#435)
- Allow aliases for attributes (#436)
- Fix namespace fetching in
handle_alias()
(#437) - Fix overwritten attributes marked as inherited (#442)
- Fix documenting constants defined from C code with
rb_define_const()
(#443) - Do not escape snippets twice (#445)
- Ajax method/class search should not fire when a non-printable character is pressed (#446)
- Fix yard server crashing when RDoc is not installed (#456)
- Fix tags ignored when
(see #foo)
is used (#457) - Fix three "Returns" for two
@overload
tags (#458) - Do not auto-detect DSL methods as method objects if parameter name is not a valid method name (#464)
- Fix attaching of macros to Object (#465)
- Fix handling of
%w()
source in[]/[]=
parsed context. (#461, pull in #468) - Don't add default
@return
if@overload
has@return
. (#458, pull in #469) - Don't discard tags by (see ...). (#457, pull in #470)
- Fix constants listed as inherited when overwritten (#474)
- Fix
yardoc --asset
behaving differently on first and subsequent calls. (#477) !!!lang
code blocks should set the lang in<pre>
's class. (#478, #479)- Fix "File List" search tab error. (#502)
- Fix search bar not redirecting to method page. (#509)
- Fix server returning exception message bodies as String (#518)
0.7.5 - January 31, 2012
- Various minor bug fixes
0.7.4 - December 2, 2011
- Redcarpet is now the default Markdown formatting library. GFM now works out-of-box (#404)
- Fix server side searching for elements that are marked private (#420)
- Add 'textile_strict' and 'pre' markup types, reorganize text and none (#416)
- Improve encoding line detection (#415)
- Add support for
rb_define_alias
in CRuby code (#413) - Fix rendering of some keywords in source view (#410)
- Add support for RDoc 3.10+ (#406, #407)
- Fix typewriter text being processed in code blocks (#403)
- Improve support for has_rdoc in RubyGems 1.8.x (#401)
- See the {file:docs/WhatsNew.md} document for details on added features
0.7.3 - October 15, 2011
- Improve support for parsing under Ruby 1.9.2p290 and 1.9.3 (#365, #370)
- Add support for SWIG generated CRuby code (#369)
- Add support for
rb_define_attr
calls in CRuby code (#362) - Handle file pointers in CRuby code (#358)
0.7.2 - June 14, 2011
- Fix
yard --help
not showing proper output - YARD now expands path to
.yardoc
file in daemon mode for server (#328) - Fix
@overload
tag linking to wrong method (#330) - Fix incorrect return type when using
@macro
(#334) - YARD now requires 'thread' to support RubyGems 1.7+ (#338)
- Fix bug in constant documentation when using
%w()
(#348) - Fix YARD style URL links when using autolinking markdown (#353)
0.7.1 - May 18, 2011
- Fixes a bug in
yard server
not displaying class list properly.
0.7.0 - May 17, 2011
Release v0.9.9
Release v0.9.8
- Fixed installed gems not being correctly found in
yard server
and by plugins. - Fixed tokenization of
%w(...)
array syntax.
Release v0.9.7
- Fix resolution of absolute object paths with ambiguous names. (#1029)