Pertanyaan Scaladoc menelan @throws dan @note tags


Saat membuat dokumentasi Scala, saya juga menggunakan @throws dan @note tag seperti yang didokumentasikan di sini (Scaladoc Wiki - Tag dan Anotasi).

Sayangnya saya tidak dapat menemukan ini di yang dihasilkan Scaladoc.

Apakah seseorang harus mengatur switch tertentu, mempertimbangkan sesuatu yang spesifik atau apakah ini masalah yang diketahui?

BTW: menggunakan scaladoc  Tugas semut dari Scala 2.9.0.1 yang mengeluarkan peringatan juga.

EDIT: BTW2 dan untuk memperjelas: Saya tidak bermaksud @throws anotasi

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

yang didokumentasikan di bagian anotasi ini def tetapi @throws tag untuk Scaladoc suka

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

5
2017-09-13 07:42


asal


Jawaban:


Ini adalah kombinasi dari bug dan sesuatu yang belum membuatnya menjadi rilis.

@note tidak berfungsi, ini adalah bug yang dikenal, lihat @todo, @note dan @example tidak berfungsi?

@throws baru saja ditambahkan baru-baru ini, lihat ini tarik permintaan dari Simon Ochsenreither, yang digabung pada Juli 2011. Ini belum membuatnya menjadi rilis, 2.9.0.1 dirilis pada Mei 2011, dan 2.9.1 dimulai pada Juli 2011.


3
2017-09-13 11:12



saya menambahkan dukungan untuk @note setengah tahun lalu.

Jika Anda melihat di sini, tampaknya berfungsi dengan benar: scala.util.matching.Regex

Hal lainnya adalah @throws Tag ScalaDoc. Sebenarnya saya berpikir tentang menghapus dukungan untuk mendukung @throws anotasi, yang didukung, karena saya tidak bisa melihat use case di mana seseorang lebih suka tag ScalaDoc ke anotasi.

Jika Anda memiliki kebutuhan nyata tolong beri tahu saya tidak, beri tahu saya!

Edit: Mhhh. Melihat ke scala.Array sebenarnya terlihat seperti itu adalah sebaliknya ...


3
2017-09-13 11:13