Fix/cleanup code to ensure it is well documented
------------------------------------------------
Key: DS-864
URL: https://jira.duraspace.org/browse/DS-864
Project: DSpace
Issue Type: Documentation
Components: DSpace API, JSPUI, LNI, OAI-PMH, REST API (experimental),
Solr, SWORD, XMLUI
Reporter: Peter Dietz
Fix For: 1.8.0
Some classes in DSpace code are undocumented, some have little documentation,
and other sections have misleading documentation. This on occasion requires the
programmer who is using a class as a client to "Go To Source" to find out how
something is implemented so understand what it is expecting for valid input.
There are other sections of code, particularly portions of code
This ticket is a placeholder for improvements that improve the Javadoc comment
blocks that are read by intelli-sense IDE's, or perhaps documenting areas of
code frequented by user interface customizations.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.duraspace.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
------------------------------------------------------------------------------
Enable your software for Intel(R) Active Management Technology to meet the
growing manageability and security demands of your customers. Businesses
are taking advantage of Intel(R) vPro (TM) technology - will your software
be a part of the solution? Download the Intel(R) Manageability Checker
today! http://p.sf.net/sfu/intel-dev2devmar
_______________________________________________
Dspace-devel mailing list
Dspace-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/dspace-devel
