Eclipse Community Forums: Java Development Tools (JDT)

Help

Home

Home » Language IDEs » Java Development Tools (JDT) » Javadoc and @NonNull

Show: Today's Messages :: Show Polls :: Message Navigator

Javadoc and @NonNull [message #1732979]

Mon, 23 May 2016 14:08

Ed Willink

Messages: 7677
Registered: July 2009

Senior Member

<html>
<head>

<meta http-equiv="content-type" content="text/html; charset=utf-8">
</head>
<body bgcolor="#FFFFFF" text="#000000">
Hi 
 
Has anyone successfully used (Sun jdk1.8.0_92) Javadoc for @NonNull
annotated source code? 
 
I get errors from infix annotated types such as 
 
<tt> [javadoc]
E:\GIT\org.eclipse.ocl\plugins\org.eclipse.ocl.pivot\src\org\eclipse\ocl\pivot\utilities\OCL.java:118:
error: annotation type not applicable to this kind of declaration</tt><tt> 
</tt><tt> [javadoc] public static @NonNull OCL
newInstance(EPackage.@NonNull Registry ePackageRegistry) {</tt><tt> 
</tt><tt> [javadoc]
 ^</tt><tt> 
</tt> 
I get errors from annotated template types such as 
 
<tt> [javadoc]
E:\GIT\org.eclipse.ocl\plugins\org.eclipse.ocl.pivot.uml\emf-gen\org\eclipse\ocl\pivot\uml\internal\oclforuml\util\OCLforUMLSwitch.java:41:
error: annotation type not applicable to this kind of declaration</tt><tt> 
</tt><tt> [javadoc] public class OCLforUMLSwitch<@Nullable T></tt><tt> 
</tt><tt> [javadoc] ^</tt><tt> 
</tt> 
Where Javadoc is generated, infixes are shown as untidy prefixes: 
<h4>getCSResource</h4>
<pre>@NonNull
public <a href="file:///C:/Users/Edward/AppData/Local/Temp/wz57c8/org/eclipse/ocl/pivot/resource/CSResource.html" title="interface in org.eclipse.ocl.pivot.resource">CSResource</a> getCSResource(@NonNull
org.eclipse.emf.common.util.URI uri,
@NonNull
java.io.InputStream inputStream)
throws java.io.IOException</pre>
 
It all culminates in 
 
[javadoc] java.lang.ClassCastException:
com.sun.tools.javac.code.Symbol$TypeVariableSymbol cannot be cast
to com.sun.tools.javac.code.Symbol$ClassSymbol 
[javadoc] at
com.sun.tools.javac.api.JavacTrees.attributeDocReference(JavacTrees.java:410) 
[javadoc] at
com.sun.tools.javac.api.JavacTrees.getElement(JavacTrees.java:345) 
[javadoc] at
com.sun.tools.doclint.Checker.visitReference(Checker.java:756) 
[javadoc] at
com.sun.tools.doclint.Checker.visitReference(Checker.java:95) 
[javadoc] at
com.sun.tools.javac.tree.DCTree$DCReference.accept(DCTree.java:523) 
[javadoc] at
com.sun.source.util.DocTreePathScanner.scan(DocTreePathScanner.java:65) 
[javadoc] at
com.sun.source.util.DocTreeScanner.visitLink(DocTreeScanner.java:177) 
[javadoc] at
com.sun.tools.doclint.Checker.visitLink(Checker.java:684) 
 
From the @NonNull errors it would appear that Javadoc -source 1.8 is
using 1.7 policies. 
 
Has Javadoc not been updated, or is there some magic incantation
that I should have used? 
 
 Regards 
 
 Ed Willink 
</body>
</html>

Report message to a moderator

Re: Javadoc and @NonNull [message #1733032 is a reply to message #1732979]

Mon, 23 May 2016 20:40

Stephan Herrmann

Messages: 1853
Registered: July 2009

Senior Member

Wow, interesting post format, particularly how the forum software adds a link to EPackage.@NonNull Razz

All I could find on this topic [1]:
Quote:

Impact
...
Documentation: javadoc must display annotations on type uses.

Maybe s.o. forgot to implement this? Oh my ...
Stephan

[1] http://openjdk.java.net/jeps/104

Report message to a moderator

Re: Javadoc and @NonNull [message #1733098 is a reply to message #1733032]

Tue, 24 May 2016 11:03

Ed Willink

Messages: 7677
Registered: July 2009

Senior Member

Hi Stephan

Checking the bug database before reporting reveals

http://bugs.java.com/bugdatabase/view_bug.do?bug_id=8146008

which looks rather similar but only for Java 9.

I don't seem to be able to add a comment. Are you able to add a "Java 8
too" comment?

[The final CCE in my original post was the reaction to an attempt to
@link a method wrt a Template Parameter. That fixed, at least Javadoc is
produced but infix and template parameter @NonNull are ignored.]

Regards

Ed Willink

On 23/05/2016 21:40, Stephan Herrmann wrote:
> Wow, interesting post format, particularly how the forum software adds
> a link to mailto:EPackage.@NonNull :p
>
> All I could find on this topic [1]:
> Quote:
>> Impact
>> ...
>> Documentation: javadoc must display annotations on type uses.
>
>
> Maybe s.o. forgot to implement this? Oh my ...
> Stephan
>
> [1] http://openjdk.java.net/jeps/104

Report message to a moderator

Re: Javadoc and @NonNull [message #1733105 is a reply to message #1733098]

Tue, 24 May 2016 05:23

Stephan Herrmann

Messages: 1853
Registered: July 2009

Senior Member

I have no privileges on Oracle's bug tracker. You can, however, see a little more on it via https://bugs.openjdk.java.net/browse/JDK-8146008

Stephan

Report message to a moderator

Re: Javadoc and @NonNull [message #1733146 is a reply to message #1733105]

Tue, 24 May 2016 18:17

Ed Willink

Messages: 7677
Registered: July 2009

Senior Member

Hm

Yes, but it seems a strange kind of Open consortium that prohibits
non-members from posting coments or raising bugs.

Regards

Ed

On 24/05/2016 06:23, Stephan Herrmann wrote:
> I have no privileges on Oracle's bug tracker. You can, however, see a
> little more on it via https://bugs.openjdk.java.net/browse/JDK-8146008
>
> Stephan

Report message to a moderator

Previous Topic:	Classes Suddenly Stopped Working
Next Topic:	get Block of class ASTparser

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Sun Oct 13 17:05:08 GMT 2024

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter