patio y enlaces a clases / módulos en el doc

Question

Actualmente estoy cambiando de rdoc al patio para mi documentaion software de rubí.

En mi doc me refiero a menudo algunas clases / módulos de los comentarios, por ejemplo:

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

rdoc correctamente crea un enlace a la página de documentación de la clase Mysoft :: mypackage :: :: Utilidad Logger, mientras que ignora patio de la etiqueta y considera que el nombre de la clase como cadena sencilla.

Yo sé que el patio tiene la etiqueta @see, sin embargo, esto creará una por separado "Vea también" sección de la documentación, mientras que necesito para hacer referencia a las clases / módulos con el interior de mi descripción de texto.

Estoy seguro que falta algo, pero si tiene alguna ejemplos de cómo esto debe hacerse con patio, apreciaría realmente.

Gracias por advace,

dl

Answer 1

la documentación :

YARD soporta una sintaxis especial para enlazar a otros objetos de código o archivos. La sintaxis es {ObjectName#method OPTIONAL_TITLE}. Esta sintaxis es aceptable en cualquier lugar en la documentación con la excepción de la etiqueta @see, que vincula automáticamente sus datos.

Por lo tanto, desea

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