如何在 ScalaDoc 文档（版本 2.10.6）中引用类型化的 class

Question

抱歉，如果这是一个愚蠢的问题，但我只是停留在如何最好地记录这个类型 class。

我最近开始使用 Scala 工作，正在清理一些代码并添加文档。

我的项目中有一个 API 向其他服务的 API 发出请求，并将该服务的 API 的响应转换为我项目的 API.

示例结构：

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

我正在尝试按如下方式记录 Request 方法：

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

但这似乎只是引用了未来 class 而没有提及它是一个 Result 类型的 Future[]。

这是一个结果类型（与 Int String 或其他类型相反）似乎有点重要，但如果我将其指定为：

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

然后它失去了对它是 Future[Result] 的引用。

似乎可以做这样的事情，但有点味道。

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

有什么建议吗？还是我运气不好，需要选择一个？

在此先感谢您的帮助。

**更新

为了澄清，我希望看到这样的内容：

未来[结果]

单击“未来”文本将 link 转到 scala.concurrent.future 的文档，单击“结果”文本将 link 转到 play.api.mvc.Result

的文档

Answer 1

如果我明白你想要什么，一个带有自定义文本的 link，你可以在有效的 link 后面加上一个 space，然后是你的文本：

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

编辑：

重读题目，我的回答不是你想要的。我认为你的解决方案是正确的。

如何在 ScalaDoc 文档（版本 2.10.6）中引用类型化的 class

How to reference a typed class in ScalaDoc Documentation (version 2.10.6)

documentation

scala

scaladoc