From: bradphelan on
I'm using the excelent CouchRest gem and I would like to document my
models. For example I have a simple model.

class SearchEngines < CouchRest::ExtendedDocument

# Holds the link to the bing search engine
property :bing

# Holds the link to google search engine
property :google

end


Now if I want :bing and :google to turn up in the rdoc or yardoc what
would I have to do.

Regards

Brad Phelan
http://xtargets.heroku.com


From: Intransition on
http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html

On Mar 20, 8:41 am, bradphelan <bradphe...(a)gmail.com> wrote:
> I'm using the excelent CouchRest gem and I would like to document my
> models. For example I have a simple model.
>
>     class SearchEngines < CouchRest::ExtendedDocument
>
>         # Holds the link to the bing search engine
>         property :bing
>
>         # Holds the link to  google search engine
>         property :google
>
>     end
>
> Now if I want :bing and :google to turn up in the rdoc or yardoc what
> would I have to do.
>
> Regards
>
> Brad Phelanhttp://xtargets.heroku.com

From: Ryan Davis on

On Mar 20, 2010, at 05:41 , bradphelan wrote:

> I'm using the excelent CouchRest gem and I would like to document my
> models. For example I have a simple model.
>
> class SearchEngines < CouchRest::ExtendedDocument
>
> # Holds the link to the bing search engine
> property :bing
>
> # Holds the link to google search engine
> property :google
>
> end
>
>
> Now if I want :bing and :google to turn up in the rdoc or yardoc what
> would I have to do.

It already works. Put "##" on a line before your rdoc and it'll get picked up.

##
# blah blah
whatever :value


From: bradphelan on
On Mar 20, 9:29 pm, Ryan Davis <ryand-r...(a)zenspider.com> wrote:
> On Mar 20, 2010, at 05:41 , bradphelan wrote:
>
>
>
> > I'm using the excelent CouchRest gem and I would like to document my
> > models. For example I have a simple model.
>
> >    class SearchEngines < CouchRest::ExtendedDocument
>
> >        # Holds the link to the bing search engine
> >        property :bing
>
> >        # Holds the link to  google search engine
> >        property :google
>
> >    end
>
> > Now if I want :bing and :google to turn up in the rdoc or yardoc what
> > would I have to do.
>
> It already works. Put "##" on a line before your rdoc and it'll get picked up.
>
> ##
> # blah blah
> whatever :value

Thanks for the tip