Package org.jdrupes.mdoclet.internal.doclets.toolkit.taglets
package org.jdrupes.mdoclet.internal.doclets.toolkit.taglets
This package has classes used to generate output for Javadoc tags.
Doclets no longer have to implement their own version of standard tags such as @param and @throws. Individual taglets provide common processing, independent of the output format. Each doclet must have a taglet writer that takes a taglet as input and writes doclet-dependent output. The taglet itself will do the tag processing. For example, suppose we are outputting @throws tags. The taglet would:
- Retrieve the list of throws tags to be documented.
- Replace {@inheritDoc} with the appropriate documentation.
- Add throws documentation for exceptions that are declared in the signature of the method but not documented with the throws tags.
-
KlasseBeschreibungA base class that implements the
Tagletinterface.An inline taglet used to denote literal code fragments.A taglet that represents the @deprecated tag.An inline taglet representing {@docRoot}.An inline taglet used to index a word or a phrase.A taglet should implement this interface if it supports an {@inheritDoc} tag or is automatically inherited if it is missing.A taglet that represents the {@inheritDoc} tag.An inline taglet used to denote literal text.A taglet that represents the @param tag.A taglet that represents the @return and {@return } tags.A taglet that represents the @see tag.A custom single-argument block tag.A taglet that represents the @snippet tag.A taglet that represents the @spec tag.A taglet that represents the {@summary} tag.A taglet that represents the @systemProperty tag.This is the taglet interface used internally within the doclet.Manages the Taglets used by doclets.The interface for the taglet writer.A taglet that processesThrowsTree, which represents @throws and @exception tags, collectively referred to as exception tags.A taglet wrapper, allows the public tagletTagletwrapped into an internal Taglet representation.An inline taglet representing the value tag.