Hof und Links zu Klassen / Module im doc

Question

Ich bin derzeit von rdoc auf Hof für meine Rubin Software documentaion wechseln.

In meinem doc oft ich einige Klassen / Module aus den Kommentaren verweisen, 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 Dokumentationsseite, während Hof des Tag ignoriert und hält den Klassennamen als einfache Zeichenfolge.

Ich weiß, dass Hof den Tag @see hat jedoch wird dies über einen separate erstellen „Siehe auch“ in der Dokumentation, während ich die Klasse / Module mit in meinem Beschreibungstext verweisen muß.

Ich bin etwas sicher fehlen, aber wenn Sie Beispiele auf, wie dies sollte mit Hof getan werden, würde ich wirklich zu schätzen wissen.

Danke pro advace,

dl

Answer 1

die Dokumentation :

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

Also, Sie wollen

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