Menu

#12 -Xdoclint:none needed to compile with java 1.8+

v1.0 (example)
open
nobody
None
5
2016-05-04
2016-05-04
ilovezfs
No

Due to doclint in JDK 8, the build fails. The quick fix workaround is to pass -Xdoclint:none to javadoc in the Makefile. A more complete fix would mean updating the javadocs in the project to be conformant with doclint's requirements. More info here: http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html

Workaround looks like this:

+    inreplace "Makefile",
+      "-version -author org.gnu.readline test",
+      "-version -author org.gnu.readline -Xdoclint:none test"

Build failure looks like this:

Constructing Javadoc information...
Standard Doclet version 1.8.0_92
Building tree for all the packages and classes...
Generating ./api/org/gnu/readline/Readline.html...
src/org/gnu/readline/Readline.java:152: error: unexpected end tag: </p>
     </p>
     ^
cd ./build ; jar -cvmf ../etc/manifest.stub ../libreadline-java.jar *
src/org/gnu/readline/Readline.java:181: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:187: error: reference not found
     @see #addHistory()
          ^
src/org/gnu/readline/Readline.java:189: warning: no @throws for java.io.UnsupportedEncodingException
  public static String readline(String prompt) throws EOFException,
                       ^
src/org/gnu/readline/Readline.java:189: warning - Tag @see: can't find addHistory() in org.gnu.readline.Readline
src/org/gnu/readline/Readline.java:209: error: reference not found
     @see #addHistory()
          ^
src/org/gnu/readline/Readline.java:212: warning: no @throws for java.io.UnsupportedEncodingException
  public static String readline(String prompt, boolean addToHist)
                       ^
src/org/gnu/readline/Readline.java:212: warning - Tag @see: can't find addHistory() in org.gnu.readline.Readline
src/org/gnu/readline/Readline.java:248: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:251: error: reference not found
     @throws UnsupportOperationException if underlying library doesn't support
     ^
src/org/gnu/readline/Readline.java:274: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:277: error: reference not found
     @throws UnsupportOperationException if underlying library doesn't support
     ^
src/org/gnu/readline/Readline.java:299: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:323: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:345: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:375: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:378: error: invalid use of @return
     @return void
     ^
src/org/gnu/readline/Readline.java:381: warning: no @throws for java.io.IOException
  public static void readInitFile(String filename) throws IOException {
                     ^
src/org/gnu/readline/Readline.java:398: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:423: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:428: warning: no @throws for java.io.EOFException
  public static void readHistoryFile(String filename)
                     ^
src/org/gnu/readline/Readline.java:428: warning: no @throws for java.io.UnsupportedEncodingException
  public static void readHistoryFile(String filename)
                     ^
src/org/gnu/readline/Readline.java:447: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:452: warning: no @throws for java.io.EOFException
  public static void writeHistoryFile(String filename)
                     ^
src/org/gnu/readline/Readline.java:452: warning: no @throws for java.io.UnsupportedEncodingException
  public static void writeHistoryFile(String filename)
                     ^
src/org/gnu/readline/Readline.java:473: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:509: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:533: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:537: warning: no @return
   public static boolean hasTerminal() {
                         ^
src/org/gnu/readline/Readline.java:555: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:559: warning: no @return
  public static String getWordBreakCharacters() {
                       ^
src/org/gnu/readline/Readline.java:581: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:584: warning: no @return
  public static String getLineBuffer() {
                       ^
src/org/gnu/readline/Readline.java:604: error: unexpected end tag: </p>
     </p>
     ^
src/org/gnu/readline/Readline.java:610: warning: no @throws for java.io.UnsupportedEncodingException
    setWordBreakCharacters(String wordBreakCharacters)
    ^
src/org/gnu/readline/Readline.java:52: error: bad use of '>'
         line = Readline.readline("myprompt> ");
                                           ^
added manifest
adding: org/(in = 0) (out= 0)(stored 0%)
adding: org/gnu/(in = 0) (out= 0)(stored 0%)
adding: org/gnu/readline/(in = 0) (out= 0)(stored 0%)
adding: org/gnu/readline/Readline.class(in = 5392) (out= 2371)(deflated 56%)
adding: org/gnu/readline/ReadlineCompleter.class(in = 194) (out= 138)(deflated 28%)
adding: org/gnu/readline/ReadlineLibrary.class(in = 1004) (out= 553)(deflated 44%)
adding: org/gnu/readline/ReadlineReader.class(in = 3236) (out= 1644)(deflated 49%)
adding: test/(in = 0) (out= 0)(stored 0%)
adding: test/ReadlineTest.class(in = 2388) (out= 1363)(deflated 42%)
adding: test/TestCompleter.class(in = 560) (out= 384)(deflated 31%)
Generating ./api/org/gnu/readline/ReadlineCompleter.html...
Generating ./api/org/gnu/readline/ReadlineLibrary.html...
src/org/gnu/readline/ReadlineLibrary.java:93: warning: no @param for name
  public static ReadlineLibrary byName(String name) {
                                ^
Generating ./api/org/gnu/readline/ReadlineReader.html...
src/org/gnu/readline/ReadlineReader.java:77: warning: no @return
  public String getPrompt() {
                ^
src/org/gnu/readline/ReadlineReader.java:85: warning: no @param for prompt
  public void setPrompt(String prompt) {
              ^
src/org/gnu/readline/ReadlineReader.java:20: error: malformed HTML
 * @author Shane Celis <shane@terrapsring.com>
                       ^
src/org/gnu/readline/ReadlineReader.java:20: error: bad use of '>'
 * @author Shane Celis <shane@terrapsring.com>
                                             ^
src/org/gnu/readline/ReadlineReader.java:56: warning: no @param for history
  public ReadlineReader(File history,ReadlineLibrary lib) throws IOException {
         ^
src/org/gnu/readline/ReadlineReader.java:56: warning: no @param for lib
  public ReadlineReader(File history,ReadlineLibrary lib) throws IOException {
         ^
src/org/gnu/readline/ReadlineReader.java:56: warning: no @throws for java.io.IOException
  public ReadlineReader(File history,ReadlineLibrary lib) throws IOException {
         ^
src/org/gnu/readline/ReadlineReader.java:47: warning: no @param for lib
  public ReadlineReader(ReadlineLibrary lib) {
         ^
src/org/gnu/readline/ReadlineReader.java:67: warning: no @param for prompt
  public ReadlineReader(String prompt, File history,ReadlineLibrary lib)
         ^
src/org/gnu/readline/ReadlineReader.java:67: warning: no @param for history
  public ReadlineReader(String prompt, File history,ReadlineLibrary lib)
         ^
src/org/gnu/readline/ReadlineReader.java:67: warning: no @param for lib
  public ReadlineReader(String prompt, File history,ReadlineLibrary lib)
         ^
src/org/gnu/readline/ReadlineReader.java:67: warning: no @throws for java.io.IOException
  public ReadlineReader(String prompt, File history,ReadlineLibrary lib)
         ^
src/org/gnu/readline/ReadlineReader.java:35: warning: no @param for prompt
  public ReadlineReader(String prompt,ReadlineLibrary lib) { 
         ^
src/org/gnu/readline/ReadlineReader.java:35: warning: no @param for lib
  public ReadlineReader(String prompt,ReadlineLibrary lib) { 
         ^
Generating ./api/test/ReadlineTest.html...
src/test/ReadlineTest.java:54: warning: no @param for args
  public static void main(String[] args) {
                     ^
Generating ./api/test/TestCompleter.html...
Generating ./api/overview-frame.html...
Generating ./api/org/gnu/readline/package-frame.html...
Generating ./api/org/gnu/readline/package-summary.html...
Generating ./api/org/gnu/readline/package-tree.html...
Generating ./api/test/package-frame.html...
Generating ./api/test/package-summary.html...
Generating ./api/test/package-tree.html...
Generating ./api/constant-values.html...
Building index for all the packages and classes...
Generating ./api/overview-tree.html...
Generating ./api/index-all.html...
Generating ./api/deprecated-list.html...
Building index for all classes...
Generating ./api/allclasses-frame.html...
Generating ./api/allclasses-noframe.html...
Generating ./api/index.html...
Generating ./api/overview-summary.html...
Generating ./api/help-doc.html...
25 errors
27 warnings
make: *** [apidoc] Error 1

Discussion


Log in to post a comment.