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