[
https://jira.jboss.org/jira/browse/RFPL-221?page=com.atlassian.jira.plugi...
]
Jay Balunas commented on RFPL-221:
----------------------------------
Comments from jboss-dev list on javadoc requirements.
All of our code, especially SPI or API classes must have javadoc which explains in detail
the following things:
1) How the module is supposed to be used (and how it is actually used if known)
2) The intended behavior, and any aspect of it that is known to be broken or a hack (so
that someone can differentiate between a design problem and just an unimplemented section
that needs to be fixed)
3) Crticial preconditions (e.g. "this class expects that the same vfs handle instance
be reused during a redeploy")
4) Thread-access design (e.g. "this class is thread-safe and can be accessed from
multiple threads", "this class is not thread-safe, and all callers must use a
shared lock to access", "this class is intended to have an
instance-per-thread")
Create a javadoc guidelines wiki page
-------------------------------------
Key: RFPL-221
URL:
https://jira.jboss.org/jira/browse/RFPL-221
Project: RichFaces Planning
Issue Type: Task
Components: administration, site
Affects Versions: Site
Reporter: Jay Balunas
Fix For: Site
Like =
http://seamframework.org/Weld/WeldJavaDocGuidelines
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira