Class DocFinder.Input
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.DocFinder.Input
- Enclosing class:
- DocFinder
The class that encapsulates the input.
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe element to search documentation from.boolean
True if we only want to search for the first sentence.boolean
True if we are looking for documentation to replace the inheritDocTag.boolean
Used to distinguish between type variable param tags and regular param tags.The tag to retrieve documentation for.The id of the tag to retrieve documentation for.The taglet to search for documentation on behalf of. -
Constructor Summary
ConstructorsConstructorDescriptionInput
(ProgramElementDoc element) Input
(ProgramElementDoc element, boolean isFirstSentence) Input
(ProgramElementDoc element, InheritableTaglet taglet) Input
(ProgramElementDoc element, InheritableTaglet taglet, Tag tag, boolean isFirstSentence, boolean isInheritDocTag) Input
(ProgramElementDoc element, InheritableTaglet taglet, String tagId) Input
(ProgramElementDoc element, InheritableTaglet taglet, String tagId, boolean isTypeVariableParamTag) -
Method Summary
-
Field Details
-
element
The element to search documentation from. -
taglet
The taglet to search for documentation on behalf of. Null if we want to search for overall documentation. -
tagId
The id of the tag to retrieve documentation for. -
tag
The tag to retrieve documentation for. This is only used for the inheritDoc tag. -
isFirstSentence
public boolean isFirstSentenceTrue if we only want to search for the first sentence. -
isInheritDocTag
public boolean isInheritDocTagTrue if we are looking for documentation to replace the inheritDocTag. -
isTypeVariableParamTag
public boolean isTypeVariableParamTagUsed to distinguish between type variable param tags and regular param tags.
-
-
Constructor Details
-
Input
public Input(ProgramElementDoc element, InheritableTaglet taglet, Tag tag, boolean isFirstSentence, boolean isInheritDocTag) -
Input
-
Input
public Input(ProgramElementDoc element, InheritableTaglet taglet, String tagId, boolean isTypeVariableParamTag) -
Input
-
Input
-
Input
-
-
Method Details
-
copy
-