CodeQL library for Java/Kotlin
codeql/java-all 4.1.1-dev (changelog, source)
Search

Module Javadoc

Provides classes and predicates for working with Javadoc documentation.

Import path

import semmle.code.java.Javadoc

Imports

Location

Provides classes and predicates for working with locations.

Classes

AuthorTag

A Javadoc @author tag.

Documentable

A documentable element that can have an attached Javadoc comment.

Javadoc

A Javadoc comment.

JavadocElement

A common super-class for Javadoc elements, which may be either tags or text.

JavadocParent

A Javadoc parent is an element whose child can be some Javadoc documentation.

JavadocTag

A Javadoc block tag. This does not include inline tags.

JavadocText

A piece of Javadoc text.

KtComment

A Kotlin comment.

KtCommentSection

A Kotlin comment.

ParamTag

A Javadoc @param tag.

SeeTag

A Javadoc @see tag.

ThrowsTag

A Javadoc @throws or @exception tag.