We are going to clean up javadoc comments in the SDK so that there are no warnings in the build, no broken links, ... We have to improve our processes so that these problems don't come back.


There are lots of issues with keeping javadoc comments in good shape:
- If we ever actually get to a state where all javadoc warnings have been
  fixed, maybe we could change the makefile to grep for warnings and
  have the make fail if any are found. Or add a
  -treat_warning_as_error option to javadoc and use that.

- Docs has a link checker that seems to do a pretty good
  job. Don't know how feasible it would be to run it as part of
  a docs build but we should investigate.

- I too kind of think we are out of luck on typos. I see your point
  that everyone must have this problem, so maybe there is a tool,
  but it seems to me that it would be really a challenge to write such
  a tool

- We should also do the html validation checks. I don't know what
  that entails, but Anne has said that properly formed html can
  be important for search.