versions
versions copied to clipboard
Javadoc warning and errors
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
PR welcome
Could you explain please ?
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 thanks for info, there was added many javadocs last time.
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.
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