Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
scabug opened this issue Mar 30, 2011 · 12 comments
Closed

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

scabug opened this issue Mar 30, 2011 · 12 comments

Comments

@scabug
Copy link

scabug commented Mar 30, 2011

=== 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
Copy link
Author

scabug commented Mar 30, 2011

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
Copy link
Author

scabug commented May 20, 2011

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

@scabug
Copy link
Author

scabug commented May 30, 2011

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

@scabug
Copy link
Author

scabug commented Jun 21, 2011

@soc said:
Summary afaik:

Works:

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

Fix exists, but not merged:
@throws

Currently unsupported:
@todo

@scabug
Copy link
Author

scabug commented Jul 6, 2011

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

@scabug
Copy link
Author

scabug commented Jul 6, 2011

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
Copy link
Author

scabug commented Jul 6, 2011

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

@scabug
Copy link
Author

scabug commented Jul 26, 2011

@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
Copy link
Author

scabug commented Aug 5, 2011

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
Copy link
Author

scabug commented Aug 5, 2011

@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
Copy link
Author

scabug commented Mar 20, 2012

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

@scabug scabug closed this as completed Mar 20, 2012
@scabug
Copy link
Author

scabug commented Apr 19, 2012

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant