github / github/codeql

Java: Javadoc.getCommentedElement / Documentable.getJavadoc does not work for annotated elements

Open
#3,698 0 comments 0 reactions 0 assignees View on GitHub
Java question
Dominant language
CodeQL
Stars
10.1k
Forks
2.1k
Avg merge
2d 15h
Merged PRs (30d)
141

Description

**Description of the issue**
It appears `Javadoc.getCommentedElement()` respectively `Documentable.getJavadoc()`, to which it delegates, does not work for annotated elements.
Example query for demo projects on https://lgtm.com/query/lang:java/:
```ql
import java

from Javadoc javadoc, int javadocEnd, Documentable documentable, int documentableStart
where
not exists (javadoc.getCommentedElement())
and not isNormalComment(javadoc)
and javadocEnd = javadoc.getLocation().getEndLine()
and documentable.getCompilationUnit() = javadoc.getFile()
and documentableStart = documentable.getLocation().getStartLine()
and documentableStart < javadocEnd + 3
and documentableStart > javadocEnd
select javadoc, documentable
```

Also note that there appears to be something weird going on, because when trying to exclude annotated elements from that query, it still finds them:
```
and not exists (documentable.(Annotatable).getAnAnnotation())
```
Though on the other hand checking `not exists (annotation.getAnnotatedElement())` does not find anything.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.