Скаладок проглотил теги @throws и @note - PullRequest
5 голосов
/ 13 сентября 2011

При создании документации Scala я также использую теги @throws и @note, например документированные здесь (Scaladoc Wiki - Теги и аннотации) .

К сожалению, я не могу найти их в сгенерированном Scaladoc .

Нужно ли устанавливать определенные переключатели, учитывать что-то конкретное или это известная проблема?

Кстати: с помощью задачи scaladoc Ant в Scala 2.9.0.1, которая также не выдает предупреждений.

РЕДАКТИРОВАТЬ: BTW2 и уточнить: я не имею в виду @throws аннотация

@throws(classOf[RuntimeException])
def dispatch: Nothing = throw new RuntimeException

, который задокументирован в разделе аннотаций этого def, но тег @throws для Scaladoc похож на

/** @throws RuntimeException
 */
def dispatch: Nothing = throw new RuntimeException

Ответы [ 2 ]

3 голосов
/ 13 сентября 2011

I добавлена ​​поддержка @note полгода назад.

Если вы посмотрите здесь, похоже, он работает правильно: scala.util.matching.Regex

Остальным является тег @throws ScalaDoc.На самом деле я подумываю об удалении его поддержки в пользу аннотации @throws, которая поддерживается, потому что я не вижу ни одного варианта использования, в котором можно было бы предпочесть тег ScalaDoc аннотации.

Есливам действительно нужно, пожалуйста, дайте мне нет, дайте мне знать!

Редактировать: М-м-м-м.Глядя на scala.Array , на самом деле все выглядит так, как будто все наоборот ...

3 голосов
/ 13 сентября 2011

Это комбинация ошибки и чего-то, что еще не вошло в релиз.

@ note не работает, это известная ошибка, см. @ todo, @note и @example не работают?

@ throws был добавлен только недавно, см. Этот запрос на получение от Simon Ochsenreither , который был объединен в июле 2011 года. Это еще не вошло в релиз 2.9. 0.1 был выпущен в мае 2011 года, а 2.9.1 - в июле 2011 года.

...