rkh/yard-sinatra — Issue #6: Support @param?
Author: tomstrummer
Created: 2012-02-21 18:27:34+00:00
State: open

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:

# Retrieve child node IDs from a given node ID
#
# @param [Number] nodeID path arg the node identifier to search
# @return [Array] a list of child IDs
get '/node/:nodeID/children' do

And the generated doc looks like this:

- (Array) GET '/node/:nodeID/children'

Retrieve descendant node IDs from a given node ID

Returns:
* (Array) — a list of child IDs

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!