Module Javadoc

Provides classes and predicates for working with Javadoc documentation.

Import path

semmle.code.java.Javadoc

Imports

Element

Provides a class that represents named elements in Java programs.

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 tag.

JavadocText

A piece of Javadoc text.

ParamTag

A Javadoc @param tag.

SeeTag

A Javadoc @see tag.

ThrowsTag

A Javadoc @throws or @exception tag.