keenlabs / KeenClient-Java

Official Java client for the Keen IO API. Build analytics features directly into your Java apps.
https://keen.io/docs
MIT License
74 stars 43 forks source link

Javadoc syntax fixes #48

Closed claireyoung closed 9 years ago

claireyoung commented 9 years ago

Refers to PR #46 which was closed. This change only affects javadoc syntax and none of the code.

  1. Remove self closing

    to adhere to HTML 4.

  2. @param, @return, @throw fixes
  3. < and > need to either be in {@code…} or escaped from (<).
Geeber commented 9 years ago

:shipit: I still don't really understand why this was breaking for you (since it worked for me and worked with travis) but it seems like a good change either way.

claireyoung commented 9 years ago

It's required in JDK 8, so it will generate compile errors if you use JDK 8. I guess you can use the arg -Xdoclint:none, but I figured it's better to just fix the javadocs.