[
https://jira.duraspace.org/browse/DS-864?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Tim Donohue closed DS-864.
--------------------------
Resolution: Incomplete
Several Committers reviewed this old ticket today. We agree that this idea is
generally a good one. However, this ticket, as it stands is a bit too vague.
It doesn't seem possible to ever truly "close" or complete.
We suggest instead creating specific tickets for specific areas that need more
code documentation. That way we have a more actionable list that we can work
from, etc.
> 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
>
> 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, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:
Build for Windows Store.
http://p.sf.net/sfu/windows-dev2dev
_______________________________________________
Dspace-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/dspace-devel
