How do I suppress links to code names in rdoc documentation?

Discussion in 'Ruby' started by billmcn, Jun 8, 2006.

  1. billmcn

    billmcn Guest

    I am using rdoc to generate documentation for my ruby module. My
    module contains a class called Treebank. In the README I use the word
    "Treebank", but this isn't in reference to the class, so I don't want
    rdoc to generate a link to it. Is it possible to suppress this link
    generation?

    I'm imagining some kind of "don't link to this" markup I can put around
    the word "Treebank" in the README. I searched the rdoc markup
    documentaion but couldn't find anything.

    Thanks.
    -wpm
    billmcn, Jun 8, 2006
    #1
    1. Advertising

Want to reply to this thread or ask your own question?

It takes just 2 minutes to sign up (and it's free!). Just click the sign up button to choose a username and then you can ask your own questions on the forum.
Similar Threads
  1. Andreas Schwarz
    Replies:
    6
    Views:
    242
    Randy W. Sims
    Jan 1, 2004
  2. Brian Schröder
    Replies:
    5
    Views:
    128
    Dave Thomas
    Sep 18, 2004
  3. Daniel Berger
    Replies:
    1
    Views:
    138
    Dave Thomas
    Nov 2, 2004
  4. Iwan van der Kleyn

    rdoc: how to add readme.rdoc as index.html?

    Iwan van der Kleyn, Apr 26, 2005, in forum: Ruby
    Replies:
    1
    Views:
    219
    Stefan Lang
    Apr 26, 2005
  5. Paul Van Delst

    How to use rdoc parsers outside of rdoc?

    Paul Van Delst, Jul 27, 2006, in forum: Ruby
    Replies:
    0
    Views:
    95
    Paul Van Delst
    Jul 27, 2006
Loading...

Share This Page