cantiere e collegamenti a classi / moduli nel doc

Question

Attualmente sto passaggio da rdoc al cantiere per il mio documentaion software rubino.

Nel mio documento ho spesso riferimento alcune classi / moduli dai commenti, per esempio:

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

rdoc crea correttamente un link alla pagina di documentazione di classe Mysoft :: MioPackage :: :: Utility Logger, mentre cantiere ignora il tag e considera il nome della classe come semplice stringa.

So che cantiere ha il tag @see, tuttavia questo creerà un separato "Vedere anche" la sezione nella documentazione, mentre ho bisogno di fare riferimento alla classe / moduli con dentro la mia descrizione del testo.

Sono sicuramente manca qualcosa, ma se avete esempi di come questo dovrebbe essere fatto con cortile, mi piacerebbe davvero apprezzare.

Grazie per advace,

dl

Answer 1

la documentazione :

  

YARD supporta una sintassi speciale per collegamento ad altri oggetti di codice o file. La sintassi è {ObjectName#method OPTIONAL_TITLE}. Questa sintassi è ovunque accettabile nella documentazione con l'eccezione del tag @see, che collega automaticamente i suoi dati.

Quindi, si vuole

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