Fill out Javadoc for exposed classes/functions
Most consumers of this library will be using something that autofills intellisense from Javadoc comments, so it would make the library significantly easier to use if everything it exposed had Javadoc.
-
Classes and interfaces which are intended to be implemented by consumer code should have documentation detailing why things work the way they do. -
Public functions should have documentation detailing: - What the function is meant to do in prose
- Arguments, including restrictions and assumptions
- Return values, including edge cases
- Known exceptions
- Timing rules (I.E. Call this before postInit)
-
Classes that consumer code might instantiate should have documentation on how that object is expected to be used -
Classes that act as namespaces should just detail what they contain