Velocity Reviews - Computer Hardware Reviews

Velocity Reviews > Newsgroups > Programming > Ruby > RDoc: How to link to a method description from other rdoc page?

Reply
Thread Tools

RDoc: How to link to a method description from other rdoc page?

 
 
Iñaki Baz Castillo
Guest
Posts: n/a
 
      07-28-2009
Hi, RDoc documentation says:

"Names of classes, source files, and any method names containing an
underscore or preceded by a hash character are automatically
hyperlinked from comment text to their description."

However, how to link to a method definition from a README.rdoc file?
I've tryed everything:

MyModule::MyClass#get
[MyModule::MyClass#get]
[link:MyModule::MyClass#get]

but nothing works

Any tip please? Thanks a lot.

--=20
I=C3=B1aki Baz Castillo
<>

 
Reply With Quote
 
 
 
 
Iñaki Baz Castillo
Guest
Posts: n/a
 
      07-28-2009
2009/7/28 I=C3=B1aki Baz Castillo <>:
> Hi, RDoc documentation says:
>
> "Names of classes, source files, and any method names containing an
> underscore or preceded by a hash character are automatically
> hyperlinked from comment text to their description."
>
> However, how to link to a method definition from a README.rdoc file?
> I've tryed everything:
>
> =C2=A0MyModule::MyClass#get
> =C2=A0[MyModule::MyClass#get]
> =C2=A0[link:MyModule::MyClass#get]


Ok, it works.

However, there must be some issue with my RDoc output since I have a
module "MyModule" with a class "MyClass". And methods of the class are
displayed as "MyModule#method" instead of
"MyModule::MyClass#method"...



--=20
I=C3=B1aki Baz Castillo
<>

 
Reply With Quote
 
 
 
 
Iñaki Baz Castillo
Guest
Posts: n/a
 
      07-28-2009
Why links to classes or methods documentation cannot be hidden with label?


The following:

Google[http://google.es]

is displayed as:

Google


But the following:

get[MyModule::Client#get]

is displayed as:

get[MyModule::Client#get]


Perhaps other bug?



--=20
I=C3=B1aki Baz Castillo
<>

 
Reply With Quote
 
Eric Hodel
Guest
Posts: n/a
 
      07-28-2009
On Jul 28, 2009, at 10:59, I=F1aki Baz Castillo wrote:

> Why links to classes or methods documentation cannot be hidden with =20=


> label?
>
>
> The following:
>
> Google[http://google.es]
>
> is displayed as:
>
> Google
>
>
> But the following:
>
> get[MyModule::Client#get]
>
> is displayed as:
>
> get[MyModule::Client#get]
>
>
> Perhaps other bug?


Perhaps.=

 
Reply With Quote
 
 
 
Reply

Thread Tools

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
Re: How include a large array? Edward A. Falk C Programming 1 04-04-2013 08:07 PM
rdoc, link to another class instance method Fernando Perez Ruby 1 03-23-2009 09:46 PM
RDoc question: How do I make a link from the README file to aspecific RDOC Page Jesper Rønn-Jensen Ruby 4 02-22-2008 10:58 PM
rdoc generates method description twice Lothar Scholz Ruby 0 07-21-2005 09:25 AM
rdoc: how to generate rdoc & ri documentation of standard library? Andreas Schwarz Ruby 6 01-01-2004 03:09 AM



Advertisments
 



1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57