Class DocFinder.Input

  • Enclosing class:
    DocFinder

    public static class DocFinder.Input
    extends Object
    The class that encapsulates the input.
    • Field Detail

      • element

        public ProgramElementDoc element
        The element to search documentation from.
      • taglet

        public InheritableTaglet taglet
        The taglet to search for documentation on behalf of. Null if we want to search for overall documentation.
      • tagId

        public String tagId
        The id of the tag to retrieve documentation for.
      • tag

        public Tag tag
        The tag to retrieve documentation for. This is only used for the inheritDoc tag.
      • isFirstSentence

        public boolean isFirstSentence
        True if we only want to search for the first sentence.
      • isInheritDocTag

        public boolean isInheritDocTag
        True if we are looking for documentation to replace the inheritDocTag.
      • isTypeVariableParamTag

        public boolean isTypeVariableParamTag
        Used to distinguish between type variable param tags and regular param tags.