Class BslDocumentationComment.Section

    • Constructor Detail

      • Section

        public Section​(int lineNumber,
                       int offset,
                       int headerKeywordLength)
        Constructor
        Parameters:
        lineNumber - number of line from the comment begining corresponding to the start line of the section
        offset - local line offset of the begining section on the line
        headerKeywordLength - length of the keyword of the section
      • Section

        public Section​(int lineNumber)
        Constructor. This constructor should be used if section description created programmatically
        Parameters:
        lineNumber - number of line from the comment begining corresponding to the start line of the section
    • Method Detail

      • getLineNumber

        public int getLineNumber()
        Gets number of line from the comment begining corresponding to the start line of the section
        Returns:
        number of line from the comment begining corresponding to the start line of the section
      • getOffset

        public int getOffset()
        Gets local line offset of the begining section on the line
        Returns:
        local line offset of the begining section on the line, offset can be -1 if offset wasnot set
      • getHeaderKeywordLength

        public int getHeaderKeywordLength()
        Gets length of the keyword of the section
        Returns:
        llength of the keyword of the section, length can be -1 if length wasnot set