README.md in yard-0.5.5 vs README.md in yard-0.5.6

- old
+ new

@@ -1,29 +1,30 @@ -YARD Release 0.5.4 "The Longest" (Mar 22nd 2010) -================================================ +YARD: Yay! A Ruby Documentation Tool +==================================== **Homepage**: [http://yardoc.org](http://yardoc.org) -**IRC**: **Join us on IRC in #yard on irc.freenode.net!** +**IRC**: [irc://irc.freenode.net/yard](irc.freenode.net / #yard) **Git**: [http://github.com/lsegal/yard](http://github.com/lsegal/yard) **Author**: Loren Segal **Contributors**: Nathan Weizenbaum, Yehuda Katz, Denis Defreyne, Postmodern, - Michael Edgar +Michael Edgar **Copyright**: 2007-2010 **License**: MIT License +**Latest Version**: 0.5.6 (codename "The Longest") +**Release Date**: May 22nd 2010 - -SYNOPSIS +Synopsis -------- 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. Below is a
 summary of some of YARD's notable features. -FEATURE LIST +Feature List ------------ **1. RDoc/SimpleMarkup Formatting Compatibility**: YARD is made to be compatible
 with RDoc formatting. In fact, YARD does no processing on RDoc documentation
 strings, and leaves this up to the output generation tool to decide how to
 @@ -35,20 +36,19 @@ documentation, but provide a much more consistent and usable way to describe
 important information about objects, such as what parameters they take and what types they are expected to be, what type a
method should return, what exceptions it can raise, if it is deprecated, etc.. It also allows information to be better (and more consistently) organized
during the output generation phase. You can find a list -of tags in the {file:GettingStarted.md#taglist GettingStarted.md} file. +of tags in the {file:Tags.md#taglist Tags.md} file. YARD also supports an optional "types" declarations for certain tags.
 This allows the developer to document type signatures for ruby methods and
 parameters in a non intrusive but helpful and consistent manner. Instead of
 describing this data in the body of the description, a developer may formally
 declare the parameter or return type(s) in a single line. Consider the
 following Yardoc'd method:
 - ## # Reverses the contents of a String or IO object. # # @param [String, #read] contents the contents to reverse # @return [String] the contents reversed lexically def reverse(contents) @@ -95,11 +95,11 @@ as throwing all the documentation into a database. Another useful way of
 exploiting this raw data format would be to write tools that can auto generate test cases, for example, or show possible unhandled exceptions in code.
 -USAGE +Usage ----- There are a couple of ways to use YARD. The first is via command-line, and the second is the Rake task. There are also the `yard-graph` and `yri` binaries to look at, if you want to poke around. @@ -219,13 +219,17 @@ More options can be seen by typing `yard-graph --help`, but here is an example: $ yard-graph --protected --full --dependencies -CHANGELOG +Changelog --------- +- **June.12.10**: 0.5.6 release + - Bug fixes for RubyGems plugin, `has_rdoc=false` should now work + - New API for registering custom parsers. See {file:WhatsNew.md} + - **May.22.10**: 0.5.5 release - Various bug fixes - **March.22.10**: 0.5.4 release - See {file:docs/WhatsNew.md what's new document} for changes @@ -291,10 +295,10 @@ to get people testing YARD on their code because there are too many possible code styles to fit into a sane amount of test cases. It also demonstrates the power of YARD and what to expect from the syntax (Yardoc style meta tags). -COPYRIGHT +Copyright --------- YARD © 2007-2010 by [Loren Segal](mailto:lsegal@soen.ca). YARD is licensed under the MIT license except for some files which come from the RDoc/Ruby distributions. Please see the {file:LICENSE} and {file:LEGAL}