Class TextPart

    • Constructor Detail

      • TextPart

        public TextPart​(IDescriptionPart parent,
                        int lineNumber,
                        int offset,
                        String text)
        Constructor.
        Parameters:
        parent - the parent object, cannot be null.
        lineNumber - line nubmer corresponding to part
        offset - offset of the begining part
        text - content of the part, cannot be null
      • TextPart

        public TextPart​(IDescriptionPart parent,
                        int lineNumber,
                        String text)
        Constructor.
        Parameters:
        parent - the parent object, cannot be null.
        lineNumber - line nubmer corresponding to part
        text - content of the part, cannot be null
    • Method Detail

      • getText

        public String getText()
        Gets content of the part
        Returns:
        content of the part, never null
      • setText

        public void setText​(String text)
        Sets content of the part
        Parameters:
        text - content of the part, cannot be null
      • match

        public boolean match​(int lineNumber,
                             int offset)
        Description copied from interface: IDescriptionPart
        Checks that this description part corresponding to the concrete line number and offset
        Parameters:
        lineNumber - number of the documentation comment line
        offset - local offset on the comment line
        Returns:
        true if this description part corresponding to the send line number and offset, false otherwise