Menu

#32 Return type documented as Collection but is array

v1.0 (example)
open
nobody
javadoc (1)
9
2013-11-16
2013-11-16
philipp
No

In Simple 2.7.1 the methods getNames() and getPaths() of the following classes and interfaces are documented (in javadoc) to return "a Collection" although they return an array of Strings (in signature).

  • org.simpleframework.xml.core.CacheLabel
  • org.simpleframework.xml.core.ElementListUnionLabel
  • org.simpleframework.xml.core.ElementMapUnionLabel
  • org.simpleframework.xml.core.Label
  • org.simpleframework.xml.core.TemplateLabel
  • org.simpleframework.xml.core.TextListLabel
  • org.simpleframework.xml.core.Variable

"Collection" is written in upper case and formatted as "code". Therefore it seems to refer to java.util.Collection which may be confusing (manifest typing helps).

Discussion


Log in to post a comment.