search

Agilefreaks / Aquarium

An AOP library for Ruby
https://rubygems.org/gems/aquarium/
149 stars 24 forks source link

[RubyForge-19671] Figure out how to get RDocs generated for methods generated using metaprogramming #25

Open hedgehog opened 14 years ago

hedgehog commented 14 years ago

Date:2008-04-20 20:11 Priority:3 Submitted By:Dean Wampler (deanwampler) Assigned To:Dean Wampler (deanwampler) Category:Documentation State:Open Summary:Figure out how to get RDocs generated for methods generated using metaprogramming

Detailed description

For example, in some places, I iterated through an array of strings and use eval to create accessor methods (when the bodies need customization...). These methods don't show up in the rdocs.

JoinPoint is a good example.

This means that the rdocs aren't complete for the reader!

hedgehog commented 14 years ago

Just speculation at the moment: I think this will require switching to Yard (http://github.com/lsegal/yard) and unless an existing handler plugin can be made to suffice, possibly writing a yard-aquarium plugin?

Some examples: http://houseofpostmodern.wordpress.com/2010/01/16/document-your-datamapper-models-with-yard/ http://github.com/postmodern/parameters/blob/master/lib/parameters/yard/handlers/ruby/parameter_handler.rb