Как ссылаться на типизированный класс в документации ScalaDoc (версия 2.10.6)

Извините, если это глупый вопрос, но я просто застрял в том, как лучше всего документировать этот типизированный класс.

Недавно я начал работать в 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]
    }
}

Я пытаюсь документировать метод запроса следующим образом:

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

Но кажется, что это будет просто ссылка на будущий класс без какого-либо упоминания о том, что это конкретно Future[] типа Result.

Кажется важной деталью, что это тип результата (в отличие от Int String или чего-то еще), но если бы я указал его как:

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

Затем он теряет ссылку на тот факт, что это Будущее[Результат].

Кажется, что можно было бы сделать что-то подобное, но это пахнет.

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

Любые предложения или мне просто не повезло и нужно выбрать один?

Заранее благодарю за любую помощь.

**Обновить

Для разъяснения я надеюсь на что-то, что гласит:

Будущее[Результат]

Если щелчок по тексту Future будет ссылаться на документы для scala.concurrent.future, а щелчок по тексту Result будет ссылаться на документы для play.api.mvc.Result


scala documentation scaladoc
person DVS    schedule 27.06.2016    source источник
comment
Скаладок может иметь запах, но ваше решение выглядит именно так, как вы хотите.   -  person Keith Pinson    schedule 28.06.2016

Ответы (1)


arrow_upward
1
arrow_downward

Если я понял, что вы хотите, ссылку с произвольным текстом, вы можете перейти по действительной ссылке с пробелом, а затем ваш текст:

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

Редактировать:

Перечитывая вопрос, мой ответ не то, что вы хотите. Я думаю, что ваше решение правильное.

person Keith Pinson    schedule 28.06.2016
comment
Будет ли это ссылаться на типы будущего и результата соответственно или просто ссылаться на тип будущего и включать вторую часть в виде текста? - person DVS; 28.06.2016
comment
Элемент после [[ и перед пробелом является ссылкой, это должно быть что-то, что Scaladoc может преобразовать в http-ссылку. Все, что следует за пробелом, является текстом. Пример, который я привел, должен быть преобразован во что-то вроде <a src="http:\\ ... \scala.concurrent.future">play.api.mvc.Result</a> - person Keith Pinson; 28.06.2016
comment
Это имеет смысл. Зная, что он преобразуется в html, как вы описываете, похоже, мне придется просто выбрать один. - person DVS; 28.06.2016