# RDoc questions

**URL:** <https://www.ruby-forum.com/t/rdoc-questions/102479>\
**Category:** Ruby\
**Created:** [November 15, 2005, 6:09pm UTC](https://www.ruby-forum.com/t/rdoc-questions/102479 "2005-11-15T18:09:28Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![listrecv](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/l/f17d59/32.png) [@listrecv](https://www.ruby-forum.com/u/listrecv)\
**Post date:** [November 15, 2005, 6:09pm UTC](https://www.ruby-forum.com/t/rdoc-questions/102479/1 "2005-11-15T18:09:28Z")

</div>

I think RDoc is great. Three questions:

1. How do I put RDoc’s for an attribute?

2. Is there a way to tell RDoc to include htmlized source of the entire  
file as well (not the just the popup source - the entire file) - on a  
separate page. I find this tremendously useful. Ideally, the file  
pages should have the entire file in html - so I can click and see the  
whole thing in context.

3. Any chances of it hyperlinking part of the source code, not just  
from the comments? (I know this is hard to do in Ruby, but RDoc seems  
to do a good enough job of heuristicallty guessing…)

---

<div class="post-metadata">

**Author:** ![listrecv](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/l/f17d59/32.png) [@listrecv](https://www.ruby-forum.com/u/listrecv)\
**Post date:** [November 18, 2005, 3:52am UTC](https://www.ruby-forum.com/t/rdoc-questions/102479/2 "2005-11-18T03:52:57Z")

</div>

Can anyone help me with this?

---

<div class="post-metadata">

**Author:** ![listrecv](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/l/f17d59/32.png) [@listrecv](https://www.ruby-forum.com/u/listrecv)\
**Post date:** [November 18, 2005, 4:17am UTC](https://www.ruby-forum.com/t/rdoc-questions/102479/3 "2005-11-18T04:17:02Z")

</div>

removed\_email\_address@domain.invalid wrote:

> I think RDoc is great. Three questions:
> 
> 1. How do I put RDoc’s for an attribute?

class C

# Your doc here

attr\_reader :foo  
end

This produces docs that look like:

Attributes  
foo [R] Your doc here

> 1. Is there a way to tell RDoc to include htmlized source of the entire  
> file as well (not the just the popup source - the entire file) - on a  
> separate page. I find this tremendously useful. Ideally, the file  
> pages should have the entire file in html - so I can click and see the  
> whole thing in context.
> 
> 2. Any chances of it hyperlinking part of the source code, not just  
> from the comments? (I know this is hard to do in Ruby, but RDoc seems  
> to do a good enough job of heuristicallty guessing…)

Sorry, don’t know. Expect not.