search

kaitai-io / kaitai_struct_java_runtime

Kaitai Struct: runtime for Java
MIT License
42 stars 18 forks source link

Fix mvn build javadoc errors #15

Closed ams-tschoening closed 6 years ago

ams-tschoening commented 6 years ago

Building the runtime using Maven with default settings that worked in the past before 0.8 leads to a build failure because of minor errors in JavaDoc now. I fixed those in this PR in addition to what I believe are minor spelling errors, because they were in the same comment.

I wasn't sure about how to properly deal with close, but in my opinion removing the comment is the easiest to do, as it doesn't add too much value.

    [exec] [INFO] ------------------------------------------------------------------------
    [exec] [INFO] BUILD FAILURE
    [exec] [INFO] ------------------------------------------------------------------------
    [exec] [INFO] Total time: 3.532 s
    [exec] [INFO] Finished at: 2018-02-14T19:13:49+01:00
    [exec] [INFO] Final Memory: 25M/503M
    [exec] [INFO] ------------------------------------------------------------------------
    [exec] [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:jar (attach-javadocs) on project kaitai-struct-runtime: MavenReportException: Error while creating archive:
    [exec] [ERROR] Exit code: 1 - C:\Users\tschoening\Documents\Eclipse\Java Sm-Mtg Bug 2461\Libs Java 3rd\Parsers\Generators\kaitai_struct\runtime\master\src\src\main\java\io\kaitai\struct\KaitaiStream.java:62: warning: no description for @throws
    [exec] [ERROR] * @throws IOException
    [exec] [ERROR] ^
    [exec] [ERROR] C:\Users\tschoening\Documents\Eclipse\Java Sm-Mtg Bug 2461\Libs Java 3rd\Parsers\Generators\kaitai_struct\runtime\master\src\src\main\java\io\kaitai\struct\RandomAccessFileKaitaiStream.java:20: error: bad use of '>'
    [exec] [ERROR] * <li>Accessing extra-long files (>31 bits positioning). Unfortunately, Java's
    [exec] [ERROR] ^
    [exec] [ERROR] 
    [exec] [ERROR] Command line was: "C:\Program Files\Java\jdk1.8\jre\..\bin\javadoc.exe" @options @packages
    [exec] [ERROR] 
    [exec] [ERROR] Refer to the generated Javadoc files in 'C:\Users\tschoening\Documents\Eclipse\Java Sm-Mtg Bug 2461\Libs Java 3rd\Parsers\Generators\kaitai_struct\runtime\master\src\target\apidocs' dir.
    [exec] [ERROR] -> [Help 1]
    [exec] [ERROR] 
    [exec] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
    [exec] [ERROR] Re-run Maven using the -X switch to enable full debug logging.
    [exec] [ERROR] 
    [exec] [ERROR] For more information about the errors and possible solutions, please read the following articles:
    [exec] [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
GreyCat commented 6 years ago

Thanks as always! I'm kind of puzzled why I'm not getting these errors during my maven build...