versions icon indicating copy to clipboard operation
versions copied to clipboard

Published 20 hours ago • verified publisher icon mojohaus

Javadoc warning and errors

Open qualitesys opened this issue 5 years ago • 3 comments

qualitesys avatar Jan 16 '19 21:01 qualitesys

mvn site with maven-javadoc-plugin:2.10.4 still alerts on javadoc errors

  • AbstractVersionsDependencyUpdaterMojo.java:188: warning: no description for @param
  • AbstractVersionsDependencyUpdaterMojo.java:189: warning: no description for @return
  • AbstractVersionsDependencyUpdaterMojo.java:213: warning: no description for @param
  • AbstractVersionsDependencyUpdaterMojo.java:214: warning: no description for @return
  • AbstractVersionsDependencyUpdaterMojo.java:217: warning: no @throws for org.apache.maven.plugin.MojoExecutionException
  • AbstractVersionsUpdaterMojo.java:261: warning: no description for @param
  • AbstractVersionsUpdaterMojo.java:267: warning: no @throws for org.apache.maven.plugin.MojoExecutionException
  • AbstractVersionsUpdaterMojo.java:405: warning: no @throws for org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException
  • AbstractVersionsUpdaterMojo.java:455: warning: no description for @param
  • AbstractVersionsUpdaterMojo.java:456: warning: no description for @param
  • AbstractVersionsUpdaterMojo.java:457: warning: no description for @param etc... Is it possible to fix these small errors ? Thanks

qualitesys avatar Jan 16 '19 21:01 qualitesys

PR welcome

slachiewicz avatar Sep 11 '21 14:09 slachiewicz

Could you explain please ?

qualitesys avatar Sep 12 '21 15:09 qualitesys

The maven-javadoc-plugin has been upgraded in the meantime (it's 3.4.1), I don't see those errors when running mvn site, but most importantly they appear to be fixed in the source code. I believe it's ok to close this.

zaza avatar Sep 06 '22 15:09 zaza

@zaza thanks for info, there was added many javadocs last time.

slawekjaranowski avatar Sep 06 '22 15:09 slawekjaranowski

No errors, but plenty of warnings. I suggest that folks create a javadoc if they change/update a method. Good idea? @sultan

Can we reopen this and keep this item open? I've been working on this.

Or do we want to maintain that "code documents itself"? I think it doesn't as it's not always clear. Also, for example, the "segment selector" sometimes indicates the last unchanged segment, otherwise the first segment that can change, so it must always be clearly documented. That's only one of the issues.

jarmoniuk avatar Oct 21 '22 06:10 jarmoniuk

The code changed a lot. It would be ok to update the Java doc with each pr instead of Big Bang. I'll be Keeping that in mind

sultan avatar Oct 21 '22 16:10 sultan