Yard und Links zu Klassen/Module in der doc

Question

Ich bin derzeit Wechsel von Rdoc zu Hof für meine Ruby-Software-Dokumentation.

In meinem doc ich häufig wird einige Klassen/Module aus den Kommentaren, zum Beispiel:

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

rdoc schafft richtig einen Link zum MySoft :: Mypackage :: utility :: Logger-Klasse Dokumentation Seite, während Yard ignoriert das Tag und betrachtet den Klassennamen als einfache Zeichenfolge.

Ich weiß, dass Yard das @see-Tag hat, aber dies wird einen separaten "Siehe auch" Abschnitt in der Dokumentation erstellen, während ich die Klasse/Module mit in meinem Beschreibungstext verweisen muss.

Ich vermisse sicherlich etwas, aber wenn Sie irgendwelche Beispiele haben, wie dies mit Yard getan werden sollte, würde ich wirklich schätzen.

Dank pro advace,

dl

Answer 1

Quoth the documentation:

YARD eine spezielle Syntax unterstützt zu anderen Codeobjekten oder Dateien zu verknüpfen. Die Syntax lautet {ObjectName#method OPTIONAL_TITLE}. Diese Syntax ist überall in der Dokumentation akzeptabel, mit Ausnahme des Tags @see, der seine Daten automatisch verknüpft. So

, möchten Sie

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