Двор и ссылки на классы / модули в док

Question

Я в настоящее время переключаюсь с RDOC во двор для моего программного обеспечения Ruby Documentaion.

В моем докторе я часто ссылаюсь на несколько классов / модулей из комментариев, например:

## == Provides various utility features
##
## == Features
##
## Logging : logging is provided by the Mysoft::Mypackage::Utility::Logger class
##

RDOC правильно создает ссылку на MySoft :: MyPackage :: Utility :: Страница документации класса Logger, в то время как двор игнорирует тег и рассматривает имя класса как простую строку.

Я знаю, что есть тег @see, однако это создаст отдельную «см. Также» раздел в документации, в то время как мне нужно ссылаться на класс / модули с помощью текста моего описания.

Я наверняка не хватает чего-то, но если у вас есть какие-либо примеры о том, как это должно быть сделано с двором, я бы очень ценю.

Спасибо за Advation,

дл

Answer 1

Овладеть Документация:

Двор поддерживает специальный синтаксис для ссылки на другие объекты или файлы кода. Синтаксис есть {ObjectName#method OPTIONAL_TITLE}. Отказ Этот синтаксис приемлема в любом месте документации за исключением @see Тег, который автоматически связывает свои данные.

Итак, вы хотите

## == Provides various utility features
##
## == Features
##
## Logging: logging is provided by the {Mysoft::Mypackage::Utility::Logger} class
##