-
Type:
Suggestion
-
Resolution: Duplicate
-
None
-
Component/s: Documentation - All
I've browsed API Javadoc for quite some time now and I've noticed that most components (types, methods, etc.) have no description whatsoever. It is nice to have an API to work with and its Javadoc to see method signatures, etc, but it is awfully useful to have descriptions.
Most of all, since GenericValue is used quite often, it would be useful to have minimal documentation about components (issue for example) representated with GenericValue (keys and mapped values description).
For now, the only way to know how to use the different GenericValue oriented components is to loop within keys and print value and key names.
- is duplicated by
-
JRASERVER-9728 Poor javadoc in the exposed API
- Closed
- is related to
-
JRASERVER-9986 Add Javadoc to mostly used JIRA classes
- Closed
- relates to
-
JRASERVER-9474 Document all of the SOAP and XML-RPC interfaces
- Closed
-
JRASERVER-9493 Add javadoc to SearchParameter classes.
- Closed
-
JRASERVER-10095 Limit the number of characters per line in the API .html documentation files
- Closed