So verweisen Sie auf eine typisierte Klasse in der ScalaDoc-Dokumentation (Version 2.10.6)

Question

Entschuldigung, wenn das eine dumme Frage ist, aber ich bleibe einfach dran, wie man diese typisierte Klasse am besten dokumentiert.

Ich arbeite seit kurzem in Scala und arbeite daran, Code aufzuräumen und Dokumentation hinzuzufügen.

Ich habe eine API in meinem Projekt, die eine Anfrage an APIs anderer Dienste stellt und die Antwort von der API dieses Dienstes in ein zukünftiges Ergebnis für die API meines Projekts übersetzt.

Beispielstruktur:

object RequestClient { 
    def Request(method: String, path: String, queryString: String, body: String = ""): Future[Result] = { 
     // Do work here 
     return Future[Result] 
    } 
} 

Ich versuche, die Request-Methode zu dokumentieren, wie folgt:

/** 
    * Returns [[scala.concurrent.future]] of Response to Some service's API. 
    */ 

Aber es scheint, dass dies Referenz nur die Zukunft Klasse ohne erwähnen, dass es speziell ist ein Future [] vom Typ Result.

Es scheint irgendwie ein wichtiges Detail, dass dies ein Ergebnis Typ ist (im Gegensatz zu einem Int String oder etwas anderes), aber wenn ich es spezifizieren war wie:

/** 
    * Returns [[play.api.mvc.Result]] of Response to Some service's API. 
    */ 

Dann verliert sie den Verweis auf die Tatsache, dass es eine Zukunft ist [Ergebnis].

Es scheint so, als könnte man so etwas tun, aber es riecht daran.

/** 
    * Returns [[scala.concurrent.future]] `[` [[play.api.mvc.Result]] `]` of Response to Some service's API. 
    */ 

Irgendwelche Vorschläge oder bin ich nur Pech und muss einen auswählen?

Vielen Dank im Voraus für jede Hilfe.

** Update

Zur Klarstellung ich für etwas Hoffnung, bin, der liest:

Zukunft [Ergebnis]

wo die Zukunft Text klicken für scala.concurrent.future auf die docs verbinden würde und Klicken Sie auf den Ergebnistext würde Link zu den Dokumenten für play.api.mvc.Result

Answer 1

Wenn ich verstanden, was Sie wollen, eine Verknüpfung mit benutzerdefinierten Text, können Sie einen gültigen Link mit einem Leerzeichen folgen und dann Ihren Text:

* Returns [[scala.concurrent.future play.api.mvc.Result]] 

Edit:

Re-Lektüre der Frage, meine Antwort ist nicht das, was Sie wollen. Ich denke deine Lösung ist richtig.