[
https://issues.apache.org/jira/browse/ODFTOOLKIT-148?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13460154#comment-13460154
]
DaLi Liu commented on ODFTOOLKIT-148:
-------------------------------------
Verified status of this issue
2.not sure - I am not sure about this issue, maybe still need to be opened
> JavaDoc needs an overhaul
> -------------------------
>
> Key: ODFTOOLKIT-148
> URL: https://issues.apache.org/jira/browse/ODFTOOLKIT-148
> Project: ODF Toolkit
> Issue Type: Bug
> Components: java
> Affects Versions: 0.8.6
> Environment: Operating System: All
> Platform: All
> Reporter: kelvin
> Assignee: issues
> Fix For: 0.8.7
>
>
> In general I see a set of common issues with the Javadoc for every class I
> have looked at so far. One or more of the following applies in each case:
> 1. There is insufficient explanatory text at the start of the Class or method
> being looked at.
> 2. There are a large number of English grammatical errors.
> As an example see the text for getSlideByName() which says "Return the slide
> which have a specified slide name in this presentation." A better way to say
> this would be "Return the slide with a specified name in this presentation.".
> 3. The Javadoc is wrong and does not correctly describe what a specific
> method does.
> I am not sure how you want to address this. I could write an individual
> defect for each case I find but that would run into hundreds of defects very
> quickly.
> Perhaps I will collect everything I see in a text file and append it to this
> defect?
> Happy to help just not sure of the best way to do that. Please let me know.
--
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
