-
Bug
-
Resolution: Done
-
Major
-
None
-
3.0.4
-
None
-
fixed javadoc for modules plugin. also disabled missing tags for agent javadoc to allow for the failings of the parser generator.
$ mvn package on the master branch (current HEAD) fails javadoc lint validation with:
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.5:jar (javadoc-jar) on project byteman: MavenReportException: Error while creating archive:Exit code: 1 - /bin/sh: scl: line 1: syntax error: unexpected end of file
[ERROR] /bin/sh: error importing function definition for `BASH_FUNC_scl'
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/modules/ModuleSystem.java:12: error: @param name not found
[ERROR] * @param triggerClassLoader the class loader of the trigger class which has been matched with this
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/modules/ModuleSystem.java:14: error: @param name not found
[ERROR] * @param helperAdapterName the name of the helper adapter class to be loaded
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/modules/ModuleSystem.java:15: error: @param name not found
[ERROR] * @param classBytes the byte array defining the class
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/modules/ModuleSystem.java:18: warning: no @param for helperLoader
[ERROR] Class<?> loadHelperAdapter(CL helperLoader, String helperName, byte[] helperBytes);
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/modules/ModuleSystem.java:18: warning: no @param for helperName
[ERROR] Class<?> loadHelperAdapter(CL helperLoader, String helperName, byte[] helperBytes);
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/modules/ModuleSystem.java:18: warning: no @param for helperBytes
[ERROR] Class<?> loadHelperAdapter(CL helperLoader, String helperName, byte[] helperBytes);
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/agent/Retransformer.java:55: warning: no @param for moduleSystem
[ERROR] public Retransformer(Instrumentation inst, ModuleSystem moduleSystem, List<String> scriptPaths, List<String> scriptTexts, boolean isRedefine)
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/agent/RuleScript.java:121: warning: no @param for imports
[ERROR] public RuleScript(String name, String targetClass, boolean isInterface, boolean isOverride, String targetMethod, String targetHelper, String[] imports, Location targetLocation, String ruleText, int line, String file, boolean compileToBytecode)
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/rule/grammar/ECAGrammarParser.java:21: warning: no @param for s
[ERROR] public ECAGrammarParser(java_cup.runtime.Scanner s)
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/rule/grammar/ECAGrammarParser.java:24: warning: no @param for s
[ERROR] public ECAGrammarParser(java_cup.runtime.Scanner s, java_cup.runtime.SymbolFactory sf)
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/rule/grammar/ECAGrammarParser.java:24: warning: no @param for sf
[ERROR] public ECAGrammarParser(java_cup.runtime.Scanner s, java_cup.runtime.SymbolFactory sf) {super(s,sf);}
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/rule/grammar/ECATokenLexer.java:629: warning: no @throws for java.io.IOException
[ERROR] public final void yyclose() throws java.io.IOException {
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/rule/grammar/ECATokenLexer.java:663: warning: no @return
[ERROR] public final int yystate() {
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/rule/grammar/ECATokenLexer.java:681: warning: no @return
[ERROR] public final String yytext() {
[ERROR] ^
[ERROR] /home/sgehwolf/Documents/byteman/byteman-sourcode/agent/src/main/java/org/jboss/byteman/rule/grammar/ECATokenLexer.java:705: warning: no @return
[ERROR] public final int yylength() {
[ERROR] ^
[ERROR]
[ERROR] Command line was:/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.65-15.b17.fc23.x86_64/jre/../bin/javadoc @options @packages
[ERROR] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR]
[ERROR] After correcting the problems, you can resume the build with the command
[ERROR] mvn <goals> -rf :byteman