-
Notifications
You must be signed in to change notification settings - Fork 32
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
Support @param? #6
Comments
I'd be interested in a working "param"-tag too |
Do you have an idea how to implement this, @tjeden? |
I've added a pull request that should fix this |
Well, I see this code based is getting outdated, but I'm noting that this issue is not fixed. |
Any news on this? |
No. I'm not using yard-sinatra myself and have (unsuccessfully) handed over On Thu, Nov 13, 2014 at 7:18 PM, Ronie Uliana [email protected]
|
Thank you for the reply, Konstantin. It happens I searched a little more for a solution and found this: https://github.com/lsegal/yard/wiki/SinatraRoutes. The route format in the final doc is a little awkward ('get("/my/route")), but it does the work. I'll leave this message here in case anybody have the same problem. |
Oh, that's pretty sweet, should maybe add it to the repo. On Fri, Nov 14, 2014 at 11:21 AM, Ronie Uliana [email protected]
|
The plugin seems to happily generate the doc (despite the
Undocumentable method, missing name
warnings mentioned in another issue.)So my source looks like this:
And the generated doc looks like this:
So it looks like my
@param
tags are getting dropped from the generated doc. This is even more important if@param
is documenting URL query parameters that aren't visible in the path route.Also, what would be the recommended method of documenting a POST body? A
@body
tag would be nice :) Thanks!The text was updated successfully, but these errors were encountered: