Menu

#54 Published API errors in javadoc

v1.0 (example)
closed
Javadoc (1)
7
2018-03-10
2018-02-14
John11
No

The current version of the published Javadoc for the opencsv api has errors presumably due to some flag in generation.

Much of what should be useful information has been replaced by "Silence Javadoc warnings" in the
CsvToBeanBuilder class.

Discussion

  • Andrew Rucker Jones

    • assigned_to: Andrew Rucker Jones
     
  • Andrew Rucker Jones

    Actually, this was intentional. Yes, the text "Silence Javadoc warnings" could be better, but did you see the "See also" section underneath that? We don't wish to document the same thing twice, because the documentation in the two places can start to drift apart. However, if we do nothing but add the @see tag to the Javadoc of the methods in question, we get lots of warnings about missing Javadoc, which makes it very difficult to see where we truly need to correct the Javadoc.

    I'm open to suggestions or to a good replacement for the text "Silence Javadoc warnings".

     
  • Andrew Rucker Jones

    • status: open --> closed
     
  • Andrew Rucker Jones

    I have replaced "Silence Javadoc warnings" with "Please see the 'See Also' section to make clearer what the purpose of the documentation is.

     

Log in to post a comment.