Не удается получить RDoc для подавления перекрестных ссылок для конкретного слова - PullRequest
0 голосов
/ 06 октября 2010

Я использую ювелирный драгоценный камень при разработке новых драгоценных камней. Как часть скелета, он устанавливает набор связанных с RDoc задач по рейку, основной из которых является rake rdoc. Насколько я могу судить по Rakefile, эта задача использует библиотеку rake/rdoctask для генерации HTML-документации из моих комментариев RDoc.

Он пытается разумно делать ссылки на классы и методы внутри моих комментариев RDoc. Но так как у меня, например, есть метод с именем user, каждый раз, когда я пишу user, генератор RDoc думает, что я ссылаюсь на этот метод. В соответствии с руководством RDoc (в самом конце «Документирование исходного кода») это можно отключить, поставив перед словом обратный слеш (\) - например, \user.

Но в моем случае это не работает. Он просто выводит обратную косую черту в готовом HTML-документе и по-прежнему использует слово в качестве перекрестной ссылки.

Есть идеи, как мне заставить это работать?

1 Ответ

0 голосов
/ 08 апреля 2011

Скорее всего, у вас установлена ​​старая версия RDoc, попробуйте обновить до ветки 2.5 с помощью

gem install rdoc -v "~>2.5"

...