eclipse-jdt / eclipse.jdt.core

Eclipse Public License 2.0
158 stars 125 forks source link

Various javadoc HTML related errors/warnings in CI build #3037

Closed srikanth-sankaran closed 2 hours ago

srikanth-sankaran commented 2 hours ago

https://ci.eclipse.org/jdt/job/eclipse.jdt.core-Github/job/PR-3024/6/console has these diagnostics. These errors are perhaps not causing the build error but given that build failed it is not super illuminating or helpful to have the build log cluttered with such errors:

00:04:38.799  [ERROR] MavenReportException: Error while generating Javadoc: 
00:04:38.799  Exit code: 1
00:04:38.799  /home/jenkins/agent/workspace/eclipse.jdt.core-Github_PR-3024/org.eclipse.jdt.core.compiler.batch/src/org/eclipse/jdt/internal/compiler/impl/JavaFeature.java:97: error: bad HTML entity
00:04:38.799     * <dd>Only if feature is actually supported, we will generate special synthetid args & fields<br>
00:04:38.799                                                                                          ^
00:04:38.799  /home/jenkins/agent/workspace/eclipse.jdt.core-Github_PR-3024/org.eclipse.jdt.core.compiler.batch/src/org/eclipse/jdt/internal/compiler/util/JrtFileSystem.java:329: warning: nested tag not allowed: <code>
00:04:38.799     * @return JDK release string (something like <code>1.8.0_05<code>) read from the "release" file from JDK home
00:04:38.799                                                                ^
00:04:38.799  /home/jenkins/agent/workspace/eclipse.jdt.core-Github_PR-3024/org.eclipse.jdt.core.compiler.batch/src/org/eclipse/jdt/internal/compiler/util/JrtFileSystem.java:329: error: element not closed: code
00:04:38.799     * @return JDK release string (something like <code>1.8.0_05<code>) read from the "release" file from JDK home
00:04:38.799                                                                ^
00:04:38.799  /home/jenkins/agent/workspace/eclipse.jdt.core-Github_PR-3024/org.eclipse.jdt.core.compiler.batch/src/org/eclipse/jdt/internal/compiler/util/JrtFileSystem.java:329: error: element not closed: code
00:04:38.799     * @return JDK release string (something like <code>1.8.0_05<code>) read from the "release" file from JDK home
00:04:38.799                                                  ^
00:04:38.799  3 errors
00:04:38.799  1 warning
srikanth-sankaran commented 2 hours ago

@jarthana - could these perhaps be related to the recent markdown changes ? Sorry if false blame. Thanks for taking a look.

akurtakov commented 2 hours ago

Isn't this https://github.com/eclipse-jdt/eclipse.jdt.core/pull/3033 ?

jarthana commented 2 hours ago

These errors are reported by Javadoc tool from the JDK and nothing to do with the compiler. We can simply fix the Javadoc in the source code and move on.

jarthana commented 2 hours ago

Isn't this #3033 ?

OK, I see we already have a fix. Closing this one.