Skip to content

Releases: lsegal/yard

Release v0.9.6

07 Jan 19:40
Compare
Choose a tag to compare
  • 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.
  • Various bug fixes

Release v0.9.5

22 Jul 23:22
Compare
Choose a tag to compare
  • 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.

Release v0.9.4

21 Jul 19:06
Compare
Choose a tag to compare
  • Minor Ruby file parsing and CSS bug fixes.

Release v0.9.3

20 Jul 22:38
Compare
Choose a tag to compare
  • Added support for {YARD::Server::RackAdapter} to be mounted under prefix URIs.
  • Fixed regression in yard server -g that caused static file assets on index
    page to return 404 errors.
  • Fixed regression in yard server -g index page that disabled scrolling and
    caused other HTML rendering glitches.

Release v0.9.2

19 Jul 21:27
Compare
Choose a tag to compare
  • Added yard config --gem-install-[yri|yard] commands which auto-configure
    your ~/.gemrc file to run yri/yard instead of ri/rdoc on a gem install.
  • Added support for gemspec metadata key "yard.run", which can be either
    "yard" or "yri" to run the respective commands on a gem install.
  • Added yard doc --no-progress to hide the progress bar.
  • Fix resolution error for compound proxy namespaces.
  • YRI will now search across all gem versions (latest first) for the .yardoc
    database.

Release v0.8.7.6

26 Oct 22:30
Compare
Choose a tag to compare
  • Support using @option tag on keyword arg splat parameter. (#729)
  • Add .stats_options for YardocTask. (#800, #801)

Release v0.8.7.5

26 Oct 10:40
Compare
Choose a tag to compare
  • 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)
  • Add .stats_options for YardocTask. (#800)
  • 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)