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

Scaladoc #35

Closed
samuelgruetter opened this issue Oct 8, 2014 · 1 comment
Closed

Scaladoc #35

samuelgruetter opened this issue Oct 8, 2014 · 1 comment

Comments

@samuelgruetter
Copy link
Collaborator

The scaladoc needs some attention:

  • Some classes/methods don't have any documentation, eg Producer
  • Some links to other classes don't work, or are displayed in full length, eg "rx.lang.scala.Observer" instead of just "Observer"
  • Running sbt doc spits out a lot of warnings.

Some remarks:

  • The goal is not to ensure stupid regularity like, for instance, the requirement that every method has a @return -- the scaladoc guide says it shouldn't be added if it's just the same as the whole documentation. But rather, it should be helpful for someone reading it ;-)
  • Using variables, code duplication in the documentation can be avoided.
  • To avoid duplicate or unnecessary work, this should be the last thing we do before releasing 1.0.
@dhoepelman
Copy link
Collaborator

Due to project EOL status, this improvement will not be made.

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

No branches or pull requests

2 participants