# Extending RDoc ( or Yard )

**URL:** <https://www.ruby-forum.com/t/extending-rdoc-or-yard/185457>\
**Category:** Ruby\
**Created:** [March 20, 2010, 1:57pm UTC](https://www.ruby-forum.com/t/extending-rdoc-or-yard/185457 "2010-03-20T13:57:52Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![bradphelan](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/aeb1de/32.png) [@bradphelan](https://www.ruby-forum.com/u/bradphelan)\
**Post date:** [March 20, 2010, 1:57pm UTC](https://www.ruby-forum.com/t/extending-rdoc-or-yard/185457/1 "2010-03-20T13:57:52Z")

</div>

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 P.  
[http://xtargets.heroku.com](http://xtargets.heroku.com)

---

<div class="post-metadata">

**Author:** ![bradphelan](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/aeb1de/32.png) [@bradphelan](https://www.ruby-forum.com/u/bradphelan)\
**Post date:** [March 20, 2010, 5:20pm UTC](https://www.ruby-forum.com/t/extending-rdoc-or-yard/185457/2 "2010-03-20T17:20:22Z")

</div>

[http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html](http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html)

---

<div class="post-metadata">

**Author:** ![bradphelan](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/aeb1de/32.png) [@bradphelan](https://www.ruby-forum.com/u/bradphelan)\
**Post date:** [March 25, 2010, 5:17pm UTC](https://www.ruby-forum.com/t/extending-rdoc-or-yard/185457/3 "2010-03-25T17:17:14Z")

</div>

On Mar 20, 9:29 pm, Ryan D. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> > ```
> > property :bing
> > 
> > ```
> 
> ## 
> 
> # blah blah
> 
> whatever :value

Thanks for the tip

---

<div class="post-metadata">

**Author:** ![bradphelan](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/aeb1de/32.png) [@bradphelan](https://www.ruby-forum.com/u/bradphelan)\
**Post date:** [March 20, 2010, 9:30pm UTC](https://www.ruby-forum.com/t/extending-rdoc-or-yard/185457/4 "2010-03-20T21:30:20Z")

</div>

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

> 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