Interface IDescriptionPart

  • All Known Implementing Classes:
    DescriptionPart, LinkPart, TextPart, TypeSection

    public interface IDescriptionPart
    Common interface for describing information in Bsl documentation comments. Commonly extract next type of information:
    • text description of comment parts
    • link to the configuration objects and exported methods
    • description of the types and extra fields of the type
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getLineNumber()
      Gets the line nubmer corresponding to part.
      int getOffset()
      Gets offset of the begining part.
      boolean match​(int lineNumber, int offset)
      Checks that this description part corresponding to the concrete line number and offset
    • Method Detail

      • getOffset

        int getOffset()
        Gets offset of the begining part. Offset - local inline offset
        Returns:
        offset of the begining part.
      • getLineNumber

        int getLineNumber()
        Gets the line nubmer corresponding to part. Numeration starts from 0 Line number - line number corresponding to the begining of the documentation comment. Each comment starts with line with number 0
        Returns:
        the line nubmer corresponding to part
      • match

        boolean match​(int lineNumber,
                      int offset)
        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