[erlang-bugs] jinterface - javadoc generation broken?

Vlad Dumitrescu <>
Sat Jun 7 22:07:23 CEST 2014


Hi Boris,

I believe that you have hit an issue on Java 8: a linter is now
enabled by default. Either disable it as per the link below, or use
Java 7.

See http://mail.openjdk.java.net/pipermail/build-infra-dev/2013-January/002899.html

regards,
Vlad


On Sat, Jun 7, 2014 at 8:46 AM, Boris Mühmer <> wrote:
> Today I did a (sort of automatic) build of the current maint branch (with my
> build scripts), when I noticed, that "make install-docs" failed with several
> errors at "jinterface". I haven't had a closer look at it, because I don't
> need the java stuff, but I just wanted to inform You about this "problem".
> Maybe it is just my setup?
>
>
> Regards
> Boris
>
>
> The rest of this mail is the output of the errors:
>
> make[4]: Entering directory
> `/home/FAMILY/bsmr/repositories/github.com/bsmr-erlang/otp/lib/jinterface/doc/src'
> make -w --jobserver-fds=3,13 -j
> RELEASE_PATH="/opt/erlang/otp/git/20140607/0543/lib/erlang"
> release_docs_spec
> make[5]: Entering directory
> `/home/FAMILY/bsmr/repositories/github.com/bsmr-erlang/otp/lib/jinterface/doc/src'
> (cd ../../java_src;javadoc -sourcepath . -d ../doc/html/java \
> -windowtitle 'Java-Erlang Interface Library' com.ericsson.otp.erlang)
> Loading source files for package com.ericsson.otp.erlang...
> Constructing Javadoc information...
> Standard Doclet version 1.8.0_05
> Building tree for all the packages and classes...
> Generating
> ../doc/html/java/com/ericsson/otp/erlang/AbstractConnection.html...
> ./com/ericsson/otp/erlang/AbstractConnection.java:213: warning: no @param
> for e
>     public abstract void deliver(Exception e);
>                          ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:218: warning: no @param
> for msg
>     public abstract void deliver(OtpMsg msg);
>                          ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:232: warning: no @param
> for from
>     protected void sendBuf(final OtpErlangPid from, final String dest,
>                    ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:269: error: @param name
> not found
>      * @param msg
>               ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:276: warning: no @param
> for from
>     protected void sendBuf(final OtpErlangPid from, final OtpErlangPid dest,
>                    ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:276: warning: no @param
> for payload
>     protected void sendBuf(final OtpErlangPid from, final OtpErlangPid dest,
>                    ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:382: warning: no @param
> for from
>     protected void sendLink(final OtpErlangPid from, final OtpErlangPid
> dest)
>                    ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:418: warning: no @param
> for from
>     protected void sendUnlink(final OtpErlangPid from, final OtpErlangPid
> dest)
>                    ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:460: warning: no @param
> for from
>     protected void sendExit2(final OtpErlangPid from, final OtpErlangPid
> dest,
>                    ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:42: warning: empty <p> tag
>  * <p>
>    ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:181: warning: no @param
> for self
>     protected AbstractConnection(final OtpLocalNode self, final OtpPeer
> other)
>               ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:181: warning: no @param
> for other
>     protected AbstractConnection(final OtpLocalNode self, final OtpPeer
> other)
>               ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:138: warning: no @param
> for self
>     protected AbstractConnection(final OtpLocalNode self, final Socket s)
>               ^
> ./com/ericsson/otp/erlang/AbstractConnection.java:138: warning: no @param
> for s
>     protected AbstractConnection(final OtpLocalNode self, final Socket s)
>               ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/AbstractNode.html...
> ./com/ericsson/otp/erlang/AbstractNode.java:246: warning: no @param for
> cookie
>     public String setCookie(final String cookie) {
>                   ^
> ./com/ericsson/otp/erlang/AbstractNode.java:150: warning: no @param for node
>     protected AbstractNode(final String node) {
>               ^
> ./com/ericsson/otp/erlang/AbstractNode.java:157: warning: no @param for name
>     protected AbstractNode(final String name, final String cookie) {
>               ^
> ./com/ericsson/otp/erlang/AbstractNode.java:157: warning: no @param for
> cookie
>     protected AbstractNode(final String name, final String cookie) {
>               ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/GenericQueue.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpAuthException.html...
> ./com/ericsson/otp/erlang/OtpAuthException.java:34: warning: no @param for s
>     public OtpAuthException(final String s) {
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpConnection.html...
> ./com/ericsson/otp/erlang/OtpConnection.java:124: warning: no @return
>     public int msgCount() {
>                ^
> ./com/ericsson/otp/erlang/OtpConnection.java:407: error: @param name not
> found
>      * @param msg
>               ^
> ./com/ericsson/otp/erlang/OtpConnection.java:414: warning: no @param for
> payload
>     public void sendBuf(final OtpErlangPid dest, final OtpOutputStream
> payload)
>                 ^
> Generating
> ../doc/html/java/com/ericsson/otp/erlang/OtpCookedConnection.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpEpmd.html...
> ./com/ericsson/otp/erlang/OtpEpmd.java:107: warning: no @param for port
>     public static void useEpmdPort(int port) {
>                        ^
> ./com/ericsson/otp/erlang/OtpEpmd.java:120: warning: no @param for node
>     public static int lookupPort(final AbstractNode node) throws IOException
> {
>                       ^
> ./com/ericsson/otp/erlang/OtpEpmd.java:158: warning: no @param for node
>     public static void unPublishPort(final OtpLocalNode node) {
>                        ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangAtom.html...
> ./com/ericsson/otp/erlang/OtpErlangAtom.java:80: warning: no @param for t
>     public OtpErlangAtom(final boolean t) {
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangBinary.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangBitstr.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangBoolean.html...
> ./com/ericsson/otp/erlang/OtpErlangBoolean.java:52: warning: no @param for
> buf
>     public OtpErlangBoolean(final OtpInputStream buf)
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangByte.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangChar.html...
> Generating
> ../doc/html/java/com/ericsson/otp/erlang/OtpErlangDecodeException.html...
> ./com/ericsson/otp/erlang/OtpErlangDecodeException.java:32: warning: no
> @param for msg
>     public OtpErlangDecodeException(final String msg) {
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangDouble.html...
> ./com/ericsson/otp/erlang/OtpErlangDouble.java:39: warning: no @param for d
>     public OtpErlangDouble(final double d) {
>            ^
> Generating
> ../doc/html/java/com/ericsson/otp/erlang/OtpErlangException.html...
> ./com/ericsson/otp/erlang/OtpErlangException.java:37: warning: no @param for
> msg
>     public OtpErlangException(final String msg) {
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangExit.html...
> ./com/ericsson/otp/erlang/OtpErlangExit.java:102: warning: no @return
>     public OtpErlangObject reason() {
>                            ^
> ./com/ericsson/otp/erlang/OtpErlangExit.java:109: warning: no @return
>     public OtpErlangPid pid() {
>                         ^
> Generating
> ../doc/html/java/com/ericsson/otp/erlang/OtpErlangExternalFun.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangFloat.html...
> ./com/ericsson/otp/erlang/OtpErlangFloat.java:34: warning: no @param for f
>     public OtpErlangFloat(final float f) {
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangFun.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangInt.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangList.html...
> ./com/ericsson/otp/erlang/OtpErlangList.java:95: warning: no description for
> @param
>      * @param lastTail
>        ^
> ./com/ericsson/otp/erlang/OtpErlangList.java:96: warning: no description for
> @throws
>      * @throws OtpErlangException
>        ^
> Generating
> ../doc/html/java/com/ericsson/otp/erlang/OtpErlangList.SubList.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangLong.html...
> ./com/ericsson/otp/erlang/OtpErlangLong.java:54: error: @param name not
> found
>      * @param val
>               ^
> ./com/ericsson/otp/erlang/OtpErlangLong.java:57: warning: no @param for v
>     public OtpErlangLong(final BigInteger v) {
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangMap.html...
> ./com/ericsson/otp/erlang/OtpErlangMap.java:61: error: @param name not found
>      * @param elems
>               ^
> ./com/ericsson/otp/erlang/OtpErlangMap.java:63: error: @param name not found
>      * @param start
>               ^
> ./com/ericsson/otp/erlang/OtpErlangMap.java:71: warning: no @param for keys
>     public OtpErlangMap(final OtpErlangObject[] keys, final int kstart,
>            ^
> ./com/ericsson/otp/erlang/OtpErlangMap.java:71: warning: no @param for
> kstart
>     public OtpErlangMap(final OtpErlangObject[] keys, final int kstart,
>            ^
> ./com/ericsson/otp/erlang/OtpErlangMap.java:71: warning: no @param for
> kcount
>     public OtpErlangMap(final OtpErlangObject[] keys, final int kstart,
>            ^
> ./com/ericsson/otp/erlang/OtpErlangMap.java:71: warning: no @param for
> values
>     public OtpErlangMap(final OtpErlangObject[] keys, final int kstart,
>            ^
> ./com/ericsson/otp/erlang/OtpErlangMap.java:71: warning: no @param for
> vstart
>     public OtpErlangMap(final OtpErlangObject[] keys, final int kstart,
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangObject.html...
> Generating
> ../doc/html/java/com/ericsson/otp/erlang/OtpErlangObject.Hash.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangPid.html...
> ./com/ericsson/otp/erlang/OtpErlangPid.java:165: error: @param name not
> found
>      * @param port
>               ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangPort.html...
> Generating
> ../doc/html/java/com/ericsson/otp/erlang/OtpErlangRangeException.html...
> ./com/ericsson/otp/erlang/OtpErlangRangeException.java:39: warning: no
> @param for msg
>     public OtpErlangRangeException(final String msg) {
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangRef.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangShort.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangString.html...
> ./com/ericsson/otp/erlang/OtpErlangString.java:193: warning: no @param for
> bytes
>     public static String newString(final byte[] bytes) {
>                          ^
> ./com/ericsson/otp/erlang/OtpErlangString.java:193: warning: no @return
>     public static String newString(final byte[] bytes) {
>                          ^
> ./com/ericsson/otp/erlang/OtpErlangString.java:45: error: invalid use of
> @return
>      * @return an Erlang string with Unicode code units.
>        ^
> ./com/ericsson/otp/erlang/OtpErlangString.java:53: warning: no @param for
> list
>     public OtpErlangString(final OtpErlangList list)
>            ^
> ./com/ericsson/otp/erlang/OtpErlangString.java:38: warning: no @param for
> str
>     public OtpErlangString(final String str) {
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangTuple.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangUInt.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpErlangUShort.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpException.html...
> ./com/ericsson/otp/erlang/OtpException.java:35: warning: no @param for msg
>     public OtpException(final String msg) {
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpExternal.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpInputStream.html...
> ./com/ericsson/otp/erlang/OtpInputStream.java:110: warning: no @param for
> buf
>     public int readN(final byte[] buf) throws OtpErlangDecodeException {
>                ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:123: warning: no @param for
> buf
>     public int readN(final byte[] buf, final int off, final int len)
>                ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:123: warning: no @param for
> off
>     public int readN(final byte[] buf, final int off, final int len)
>                ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:123: warning: no @param for
> len
>     public int readN(final byte[] buf, final int off, final int len)
>                ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:138: warning: no @return
>     public int peek() throws OtpErlangDecodeException {
>                ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:138: warning: no @throws for
> com.ericsson.otp.erlang.OtpErlangDecodeException
>     public int peek() throws OtpErlangDecodeException {
>                ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:39: warning: no description
> for @param
>      * @param buf
>        ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:48: warning: no description
> for @param
>      * @param flags
>        ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:50: warning: no @param for buf
>     public OtpInputStream(final byte[] buf, final int flags) {
>            ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:59: warning: no description
> for @param
>      * @param flags
>        ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:61: warning: no @param for buf
>     public OtpInputStream(final byte[] buf, final int offset, final int
> length,
>            ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:61: warning: no @param for
> offset
>     public OtpInputStream(final byte[] buf, final int offset, final int
> length,
>            ^
> ./com/ericsson/otp/erlang/OtpInputStream.java:61: warning: no @param for
> length
>     public OtpInputStream(final byte[] buf, final int offset, final int
> length,
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpLocalNode.html...
> ./com/ericsson/otp/erlang/OtpLocalNode.java:42: warning: no @param for node
>     protected OtpLocalNode(final String node) {
>               ^
> ./com/ericsson/otp/erlang/OtpLocalNode.java:50: warning: no @param for node
>     protected OtpLocalNode(final String node, final String cookie) {
>               ^
> ./com/ericsson/otp/erlang/OtpLocalNode.java:50: warning: no @param for
> cookie
>     protected OtpLocalNode(final String node, final String cookie) {
>               ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpMbox.html...
> ./com/ericsson/otp/erlang/OtpMbox.java:423: error: unexpected end tag: </p>
>      * </p>
>        ^
> ./com/ericsson/otp/erlang/OtpMbox.java:427: warning: no @param for reason
>     public void exit(final String reason) {
>                 ^
> ./com/ericsson/otp/erlang/OtpMbox.java:458: warning: no @param for to
>     public void exit(final OtpErlangPid to, final String reason) {
>                 ^
> ./com/ericsson/otp/erlang/OtpMbox.java:458: warning: no @param for reason
>     public void exit(final OtpErlangPid to, final String reason) {
>                 ^
> ./com/ericsson/otp/erlang/OtpMbox.java:598: warning: no @return
>     public boolean ping(final String node, final long timeout) {
>                    ^
> ./com/ericsson/otp/erlang/OtpMbox.java:632: warning: no @param for name
>     public OtpErlangPid whereis(final String name) {
>                         ^
> ./com/ericsson/otp/erlang/OtpMbox.java:76: error: unexpected end tag: </p>
>  * </p>
>    ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpMsg.html...
> ./com/ericsson/otp/erlang/OtpMsg.java:187: warning: no @return
>     public int type() {
>                ^
> ./com/ericsson/otp/erlang/OtpMsg.java:33: error: unknown tag: lu
>  * The header information that is available is as follows: <lu>
>                                                            ^
> ./com/ericsson/otp/erlang/OtpMsg.java:34: error: tag not allowed here: <li>
>  * <li> a tag indicating the type of message
>    ^
> ./com/ericsson/otp/erlang/OtpMsg.java:35: error: tag not allowed here: <li>
>  * <li> the intended recipient of the message, either as a
>    ^
> ./com/ericsson/otp/erlang/OtpMsg.java:37: error: tag not allowed here: <li>
>  * <li> (sometimes) the sender of the message. Due to some eccentric
>    ^
> ./com/ericsson/otp/erlang/OtpMsg.java:40: error: unknown tag: lu
>  * is {@link OtpMsg#regSendTag regSendTag} contain sender information. </lu>
>                                                                        ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpNode.html...
> ./com/ericsson/otp/erlang/OtpNode.java:304: warning: no @param for name
>     public OtpErlangPid whereis(final String name) {
>                         ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpNode.Acceptor.html...
> Generating
> ../doc/html/java/com/ericsson/otp/erlang/OtpNode.Mailboxes.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpNodeStatus.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpOutputStream.html...
> ./com/ericsson/otp/erlang/OtpOutputStream.java:205: error: @param name not
> found
>      * @param buf
>               ^
> ./com/ericsson/otp/erlang/OtpOutputStream.java:209: warning: no @param for
> bytes
>     public void writeN(final byte[] bytes) {
>                 ^
> ./com/ericsson/otp/erlang/OtpOutputStream.java:640: error: @param name not
> found
>      * @param s
>               ^
> ./com/ericsson/otp/erlang/OtpOutputStream.java:643: warning: no @param for
> us
>     public void write_ushort(final short us) {
>                 ^
> ./com/ericsson/otp/erlang/OtpOutputStream.java:64: warning: no @param for
> size
>     public OtpOutputStream(final int size) {
>            ^
> ./com/ericsson/otp/erlang/OtpOutputStream.java:71: warning: no @param for o
>     public OtpOutputStream(final OtpErlangObject o) {
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpPeer.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpSelf.html...
> ./com/ericsson/otp/erlang/OtpSelf.java:71: warning: no @throws for
> java.io.IOException
>     public OtpSelf(final String node) throws IOException {
>            ^
> ./com/ericsson/otp/erlang/OtpSelf.java:85: warning: no @throws for
> java.io.IOException
>     public OtpSelf(final String node, final String cookie) throws
> IOException {
>            ^
> Generating ../doc/html/java/com/ericsson/otp/erlang/OtpServer.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/package-frame.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/package-summary.html...
> Generating ../doc/html/java/com/ericsson/otp/erlang/package-tree.html...
> Generating ../doc/html/java/constant-values.html...
> Generating ../doc/html/java/serialized-form.html...
> Building index for all the packages and classes...
> Generating ../doc/html/java/overview-tree.html...
> Generating ../doc/html/java/index-all.html...
> Generating ../doc/html/java/deprecated-list.html...
> Building index for all classes...
> Generating ../doc/html/java/allclasses-frame.html...
> Generating ../doc/html/java/allclasses-noframe.html...
> Generating ../doc/html/java/index.html...
> Generating ../doc/html/java/help-doc.html...
> 16 errors
> 74 warnings
> make[5]: *** [jdoc] Error 1
> make[5]: Leaving directory
> `/home/FAMILY/bsmr/repositories/github.com/bsmr-erlang/otp/lib/jinterface/doc/src'
> make[4]: *** [release_docs] Error 2
> make[4]: Leaving directory
> `/home/FAMILY/bsmr/repositories/github.com/bsmr-erlang/otp/lib/jinterface/doc/src'
> make[3]: *** [release_docs] Error 2
> make[3]: Leaving directory
> `/home/FAMILY/bsmr/repositories/github.com/bsmr-erlang/otp/lib/jinterface'
> make[2]: *** [release_docs] Error 2
> make[2]: Leaving directory
> `/home/FAMILY/bsmr/repositories/github.com/bsmr-erlang/otp/lib'
> make[1]: *** [release_docs] Error 2
> make[1]: Leaving directory
> `/home/FAMILY/bsmr/repositories/github.com/bsmr-erlang/otp'
> make: *** [install-docs] Error 2
>
>
> _______________________________________________
> erlang-bugs mailing list
> 
> http://erlang.org/mailman/listinfo/erlang-bugs
>


More information about the erlang-bugs mailing list