Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
hedgehog opened this issue Jan 29, 2010 · 1 comment

Comments

@hedgehog
Copy link

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant