@todo, @note and @example don't work?

[scabug]

=== What steps will reproduce the problem (please be specific and use wikiformatting)? ===

abstract class test
/**
 * TestA class
 * @example 2.0
 * @todo do something better than finding scaladoc bugs
 * @note blah blah */
class TestA extends test

=== What is the expected behavior? ===

I expect to generate notes, examples, and todos.

=== What do you see instead? ===

No notes, examples, or todos :( see attached.

=== Additional information ===
http://permalink.gmane.org/gmane.comp.lang.scala.user/37949

=== What versions of the following are you using? ===

• Scala: 2.8.1.final
• Java: 1.6.0_24
• Operating system: MacOS

[scabug]

Imported From: https://issues.scala-lang.org/browse/SI-4421?orig=1
Reporter: s wade (swadenator)
Attachments:

• note.png (created on Mar 30, 2011 10:30:56 PM UTC, 21494 bytes)

[scabug]

@soc said:
See scala/scala#21 (@note) and scala/scala#23 (@throws).

[scabug]

Commit Message Bot (anonymous) said:
(pedrofurla in r25042) Adds support for @note in ScalaDoc. Related to #4421. Contributed by Simon Ochsenreither. no review.

[scabug]

@soc said:
Summary afaik:

Works:

@example
@note
@return
@see
@SInCE
@Version

Fix exists, but not merged:
@throws

Currently unsupported:
@todo

[scabug]

@kzys said:
I'll merge scala/scala#23. Please wait a moment!

[scabug]

Commit Message Bot (anonymous) said:
(kzys in r25241) Adds support for @throws in ScalaDoc. Related to #4421. Contributed by Simon Ochsenreither. Review by dubochet.

[scabug]

Commit Message Bot (anonymous) said:
(kzys in r25242) Add a test for #4421 and clean up a little.

[scabug]

@dubochet said:
I am actually not sure "todos" should be in the generated documentation by default. I see those as notes left for developers of the code (who would be looking at the code itself), not for users of the library who use the documentation.

[scabug]

Commit Message Bot (anonymous) said:
(extempore in r25450) Adds support in Scaladoc for @todo tag. Contributed by Steven Tomcavage. Related to #4421. No review.

[scabug]

@heathermiller said:
I merged Steven's contribution, so now the status looks like everything listed works.

Works:

@example
@note
@return
@see
@SInCE
@Version
@throws
@todo

I'll leave this ticket open pending discussion of the role/need for the @todo tag.

[scabug]

@VladUreche said:
All of them are working on trunk. Closing.

[scabug]

Robin Green (robin.green) said:
Todos can be useful because they can tell the user what is expected to be coming in later versions, and hence also what is not yet implemented. Todos that you don't want to be visible in the scaladoc can be put in ordinary non-scaladoc comments.