[
https://issues.jboss.org/browse/TEIIDDES-1025?page=com.atlassian.jira.plu...
]
Paul Richardson edited comment on TEIIDDES-1025 at 7/23/12 9:26 AM:
--------------------------------------------------------------------
With all warnings switched on eclipse reports 19500+ warnings for documentation.
Categories include:
* Description expected after @return
* Missing tag for method
This number is too large for a single cleanup and the description cannot be
auto-generated. Thus, suggest developers should fix warnings on a commit-by-commit basis,
ie. if a class is modified then all its javadoc warnings must be cleared before
committing.
was (Author: phantomjinx):
Consideration for remaining 16000+ documentation warnings
Fix Teiid Designer's Javadoc errors
-----------------------------------
Key: TEIIDDES-1025
URL:
https://issues.jboss.org/browse/TEIIDDES-1025
Project: Teiid Designer
Issue Type: Bug
Components: Housekeeping
Affects Versions: 8.0
Reporter: Barry LaFond
Assignee: Paul Richardson
Priority: Critical
Fix For: Pre-8.0
An upgrade to our build system for 7.5 release exposed a number of broken Javadoc {@link
xxxx.xxx.xxx} entries.
Enabling the Javadoc validation and rebuilding will find a few thousand errors/warnings.
Some from copying/pasting over the years, others from refactoring by hand, etc...
We should take some time to clean this up.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see:
http://www.atlassian.com/software/jira