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.

Sign up for GitHub

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

Jump to bottom

Usage of yard for documentation with alias_native? #69

Closed
ylluminate opened this issue Mar 24, 2015 · 1 comment
Closed

Usage of yard for documentation with alias_native? #69

ylluminate opened this issue Mar 24, 2015 · 1 comment

Comments

@ylluminate
Copy link

Hey @adambeynon @elia do we need to update yard so that it groks alias_native for wrappers and therefore includes them in the documentation output properly? Or how have you guys dealt with this deficiency hitherto?
@ylluminate
Copy link
Author

Okay, so we did a little more digging it appears that you just followed the following guide with forcing method definition on the docs:
http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md#Documenting_DSL_Methods

Eg, https://github.com/opal/opal-jquery/blob/master/lib/opal/jquery/element.rb#L145-L151

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ylluminate