Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Release 0.5.6

  • Loading branch information...
commit 3a5cd0b2c858e9a21843df653ab3e98dbc367743 1 parent 76591c0
@lsegal lsegal authored
View
131 ChangeLog
@@ -1,5 +1,85 @@
+2010-06-12 Loren Segal <lsegal@soen.ca>
+
+ * ChangeLog, README.md, docs/WhatsNew.md, lib/yard.rb, yard.gemspec: Release
+ 0.5.6
+
+ * lib/rubygems_plugin.rb: Don't generate yri index if has_rdoc == false
+
+ * lib/yard/handlers/ruby/class_condition_handler.rb,
+ spec/handlers/class_condition_handler_spec.rb: Fix failing class condition
+ handling case in 1.9
+
+ * lib/rubygems_plugin.rb, lib/yard/cli/yardoc.rb,
+ lib/yard/code_objects/base.rb, lib/yard/code_objects/class_object.rb,
+ lib/yard/code_objects/constant_object.rb,
+ lib/yard/code_objects/method_object.rb,
+ lib/yard/code_objects/namespace_object.rb, lib/yard/code_objects/proxy.rb,
+ lib/yard/docstring.rb, lib/yard/handlers/base.rb,
+ lib/yard/parser/ruby/ast_node.rb, lib/yard/parser/ruby/ruby_parser.rb,
+ lib/yard/serializers/file_system_serializer.rb,
+ lib/yard/tags/default_factory.rb, lib/yard/tags/library.rb,
+ lib/yard/templates/template.rb, templates/default/tags/html/option.erb: Fix a
+ boatload of Ruby warnings
+
+ * lib/rubygems_plugin.rb: Fix warnings in RubyGems plugin Closes gh-108
+
+ * spec/cli/yardoc_spec.rb: Fix Yardoc CLI specs for new read_binary encoding
+ fixes
+
+ * lib/yard/autoload.rb, lib/yard/parser/base.rb, lib/yard/parser/c_parser.rb,
+ lib/yard/parser/ruby/legacy/ruby_parser.rb,
+ lib/yard/parser/ruby/legacy/statement_list.rb,
+ lib/yard/parser/ruby/ruby_parser.rb, lib/yard/parser/source_parser.rb,
+ spec/parser/base_spec.rb, spec/parser/source_parser_spec.rb: Refactor
+ SourceParser and create API to extend YARD with custom source parsers using
+ YARD::Parser::SourceParser.register_parser_type Closes gh-101
+
+2010-06-11 Loren Segal <lsegal@soen.ca>
+
+ * lib/yard/parser/source_parser.rb: Add .cc as C source filename extension
+
+ * .../ruby/legacy/class_condition_handler.rb,
+ spec/handlers/class_condition_handler_spec.rb: Fixes handling of class
+ conditionals in the form "defined?(A) && defined?(B)"
+
+2010-06-05 Loren Segal <lsegal@soen.ca>
+
+ * lib/yard/cli/yardoc.rb, lib/yard/templates/erb_cache.rb,
+ lib/yard/templates/helpers/html_helper.rb,
+ templates/default/layout/html/setup.rb: Various encoding related template
+ fixes. Closes gh-131
+
+2010-05-26 Loren Segal <lsegal@soen.ca>
+
+ * lib/yard/cli/yri.rb: Don't use less on Windows (non-cygwin)
+
+ * lib/yard/cli/yri.rb: yri should fail gracefully when no arguments are
+ supplied
+
+ * Rakefile: Better rake support for windows
+
+ * lib/yard/parser/ruby/ruby_parser.rb, spec/parser/source_parser_spec.rb: Fix
+ handling of docstrings in 1.9 parser when there are comments before and on
+ the same line of a code object
+
+ * README.md, docs/GettingStarted.md, docs/Tags.md: Move tag list from
+ GettingStarted to Tags and document syntax
+
+ * README.md: Update README formatting
+
+2010-05-25 Loren Segal <lsegal@soen.ca>
+
+ * lib/yard/autoload.rb, lib/yard/handlers/ruby/class_handler.rb,
+ lib/yard/handlers/ruby/legacy/class_handler.rb,
+ lib/yard/handlers/ruby/struct_handler_methods.rb: Various documentation and
+ style refactorings
+
2010-05-22 Loren Segal <lsegal@soen.ca>
+ * README.md: Fix release date/version in readme
+
+ * README.md: Fix contributors formatting in readme for github
+
* ChangeLog, README.md, lib/yard.rb, yard.gemspec: Bump version to 0.5.5
2010-05-21 Loren Segal <lsegal@soen.ca>
@@ -53,6 +133,11 @@
lib/yard/code_objects/proxy.rb, spec/code_objects/class_object_spec.rb: Fixes
an issue where mixins could appear twice in the class hierarchy
+2010-05-18 Michael Edgar <michael.j.edgar@dartmouth.edu>
+
+ * lib/yard/handlers/ruby/struct_handler_methods.rb: Made struct handler
+ directly add tags. Technical faux pas.
+
2010-05-15 postmodern <postmodern.mod3@gmail.com>
* lib/yard.rb: Only glob .rb files from yard/core_ext and do not strip the
@@ -71,6 +156,52 @@
spec/parser/ruby/legacy/statement_list_spec.rb: Fill .block for 'else' and
'elsif' statements in legacy parser.
+2010-05-09 Michael Edgar <michael.j.edgar@dartmouth.edu>
+
+ * lib/yard/handlers/ruby/legacy/class_handler.rb,
+ spec/handlers/class_handler_spec.rb,
+ spec/handlers/examples/class_handler_001.rb.txt: Added more specs for
+ attr_reader and attr_writer combinations.
+
+ * lib/yard/handlers/ruby/struct_handler_methods.rb,
+ spec/handlers/class_handler_spec.rb,
+ spec/handlers/examples/class_handler_001.rb.txt: Added some specs for the use
+ of attr_reader and attr_writer. Made them pass.
+
+ * lib/yard/handlers/ruby/struct_handler_methods.rb, lib/yard/tags/library.rb:
+ Added basic logic for the separation of reader/writer attributes. Specs pass,
+ but no new specs have been added.
+
+ * lib/yard/handlers/ruby/class_handler.rb,
+ lib/yard/handlers/ruby/legacy/class_handler.rb: Added support on the handler
+ side for defining constants for non-anonymous structs
+
+ * spec/handlers/class_handler_spec.rb: Added a spec to ensure that when a
+ non-anonymous struct is used, the appropriate constant is defined in
+ Struct::.
+
+ * lib/yard/handlers/ruby/class_handler.rb,
+ lib/yard/handlers/ruby/legacy/class_handler.rb: Added Ruby 1.8.x
+ compatibility, and fixed an error caused by OStruct.new (without parens).
+
+ * lib/yard/handlers/ruby/struct_handler_methods.rb, lib/yard/tags/library.rb,
+ spec/handlers/class_handler_spec.rb,
+ spec/handlers/examples/class_handler_001.rb.txt: Specifications added for the
+ @attr tag.
+
+ * lib/yard/handlers/ruby/class_handler.rb: Added basic support for
+ subclass-syntax with Structs. The newly-added specs pass.
+
+ * lib/yard/autoload.rb, lib/yard/handlers/ruby/struct_handler_methods.rb:
+ Added my struct_handler_methods.rb file from yard-struct, which will provide
+ shortcuts for adding attributes. This is a module (and not dropped into the
+ ClassHandler) because I want to reuse this code for the Constant-assignment
+ syntax as well.
+
+ * spec/handlers/class_handler_spec.rb,
+ spec/handlers/examples/class_handler_001.rb.txt: Added specs for the
+ superclass syntax for Struct usage.
+
2010-05-04 Denis Defreyne <denis.defreyne@stoneship.org>
* templates/default/docstring/html/private.erb,
View
6 README.md
@@ -9,7 +9,7 @@ YARD: Yay! A Ruby Documentation Tool
Michael Edgar
**Copyright**: 2007-2010
**License**: MIT License
-**Latest Version**: 0.5.5 (codename "The Longest")
+**Latest Version**: 0.5.6 (codename "The Longest")
**Release Date**: May 22nd 2010
Synopsis
@@ -224,6 +224,10 @@ More options can be seen by typing `yard-graph --help`, but here is an example:
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
View
13 docs/WhatsNew.md
@@ -170,6 +170,19 @@ You can now access the "Class List", "Method List" and "File List" with the
'c', 'm' and 'f' keyboard shortcuts in the default HTML template, allowing
for keyboard-only navigation around YARD documentation.
+API for registering custom parsers (0.5.6)
+------------------------------------------
+
+You can now register parsers for custom source languages by calling the
+following method:
+
+ SourceParser.register_parser_type(:java, MyJavaParser, 'java')
+
+The parser class MyJavaParser should be a subclass of {YARD::Parser::Base},
+and the last argument is a set of extensions (string, array or regexp). You
+can read more about registering parsers at the {YARD::Parser::SourceParser}
+class documentation.
+
What's New in 0.4.x?
====================
View
2  lib/yard.rb
@@ -1,5 +1,5 @@
module YARD
- VERSION = "0.5.5"
+ VERSION = "0.5.6"
ROOT = File.expand_path(File.dirname(__FILE__))
TEMPLATE_ROOT = File.join(ROOT, '..', 'templates')
CONFIG_DIR = File.expand_path('~/.yard')
View
2  yard.gemspec
@@ -9,7 +9,7 @@ SPEC = Gem::Specification.new do |s|
custom Ruby constructs such as custom class level definitions.
eof
s.version = YARD::VERSION
- s.date = "2010-05-22"
+ s.date = "2010-06-12"
s.author = "Loren Segal"
s.email = "lsegal@soen.ca"
s.homepage = "http://yardoc.org"
Please sign in to comment.
Something went wrong with that request. Please try again.