Package net.sf.okapi.filters.doxygen

Class DoxygenPatterns

  • public class DoxygenPatterns
extends Object

    • Field Detail

      • BLANK_LINES_PATTERN

        public static final Pattern BLANK_LINES_PATTERN

      • SINGLE_QUOTE_STRING

        public static final String SINGLE_QUOTE_STRING
        Single-quoted string: 'string' These could contain "false-positive" comment delimiters, and so must be tokenized separately. Hint taken from: http://stackoverflow.com/a/5455705/448068
        See Also:
        Constant Field Values

      • SINGLE_QUOTE_STRING_PREFIX_PATTERN

        public static final Pattern SINGLE_QUOTE_STRING_PREFIX_PATTERN

      • SINGLE_QUOTE_STRING_SUFFIX_PATTERN

        public static final Pattern SINGLE_QUOTE_STRING_SUFFIX_PATTERN

      • DOUBLE_QUOTE_STRING_PREFIX_PATTERN

        public static final Pattern DOUBLE_QUOTE_STRING_PREFIX_PATTERN

      • DOUBLE_QUOTE_STRING_SUFFIX_PATTERN

        public static final Pattern DOUBLE_QUOTE_STRING_SUFFIX_PATTERN

      • CPP_COMMENT_PREFIX

        public static final String CPP_COMMENT_PREFIX
        Single-line comment start: /// or //!
        See Also:
        Constant Field Values

      • CPP_COMMENT_PREFIX_PATTERN

        public static final Pattern CPP_COMMENT_PREFIX_PATTERN

      • CPP_COMMENT_SUFFIX_PATTERN

        public static final Pattern CPP_COMMENT_SUFFIX_PATTERN

      • CPP_EXCLUDE_COMMENT_PREFIX

        public static final String CPP_EXCLUDE_COMMENT_PREFIX
        Non-Doxygen single-line comment start: //
        See Also:
        Constant Field Values

      • CPP_EXCLUDE_COMMENT_PREFIX_PATTERN

        public static final Pattern CPP_EXCLUDE_COMMENT_PREFIX_PATTERN

      • CPP_EXCLUDE_COMMENT_SUFFIX_PATTERN

        public static final Pattern CPP_EXCLUDE_COMMENT_SUFFIX_PATTERN
        Non-Doxygen single-line comment end: linebreak

      • JAVADOC_COMMENT_PREFIX

        public static final String JAVADOC_COMMENT_PREFIX
        Multiline comment start: /** or /*!
        See Also:
        Constant Field Values

      • JAVADOC_COMMENT_PREFIX_PATTERN

        public static final Pattern JAVADOC_COMMENT_PREFIX_PATTERN

      • JAVADOC_COMMENT_SUFFIX_PATTERN

        public static final Pattern JAVADOC_COMMENT_SUFFIX_PATTERN

      • JAVADOC_EXCLUDE_COMMENT_PREFIX

        public static final String JAVADOC_EXCLUDE_COMMENT_PREFIX
        Non-Doxygen multiline comment start: /*
        See Also:
        Constant Field Values

      • JAVADOC_EXCLUDE_COMMENT_PREFIX_PATTERN

        public static final Pattern JAVADOC_EXCLUDE_COMMENT_PREFIX_PATTERN

      • JAVADOC_EXCLUDE_COMMENT_SUFFIX_PATTERN

        public static final Pattern JAVADOC_EXCLUDE_COMMENT_SUFFIX_PATTERN
        Non-Doxygen multiline comment end: *\/

      • PYTHON_SINGLE_COMMENT_DELIMITER

        public static final String PYTHON_SINGLE_COMMENT_DELIMITER
        Python multiline comment: ''' (same delimiter for both prefix and suffix)
        See Also:
        Constant Field Values

      • PYTHON_SINGLE_COMMENT_PREFIX_PATTERN

        public static final Pattern PYTHON_SINGLE_COMMENT_PREFIX_PATTERN

      • PYTHON_SINGLE_COMMENT_SUFFIX_PATTERN

        public static final Pattern PYTHON_SINGLE_COMMENT_SUFFIX_PATTERN

      • PYTHON_DOUBLE_COMMENT_DELIMITER

        public static final String PYTHON_DOUBLE_COMMENT_DELIMITER
        Python multiline comment: """ (same delimiter for both prefix and suffix)
        See Also:
        Constant Field Values

      • PYTHON_DOUBLE_COMMENT_PREFIX_PATTERN

        public static final Pattern PYTHON_DOUBLE_COMMENT_PREFIX_PATTERN

      • PYTHON_DOUBLE_COMMENT_SUFFIX_PATTERN

        public static final Pattern PYTHON_DOUBLE_COMMENT_SUFFIX_PATTERN

      • MULTILINE_DECORATION

        public static final String MULTILINE_DECORATION
        Matches the decoration preceding additional lines of multiline comments. Ex: 
             /**
  [    * ]Foo
  [    * ]bar
       *\/
        See Also:
        Constant Field Values

      • MULTILINE_DECORATION_PATTERN

        public static final Pattern MULTILINE_DECORATION_PATTERN

      • DOXYGEN_COMMAND_PATTERN

        public static final Pattern DOXYGEN_COMMAND_PATTERN

      • MEMBER_COMMENT_PREFIX

        public static final String MEMBER_COMMENT_PREFIX
        Matches member comments. Ex: 
                        bool mybool; ///< Paragraph 4
        See Also:
        Constant Field Values

      • MEMBER_COMMENT_PREFIX_PATTERN

        public static final Pattern MEMBER_COMMENT_PREFIX_PATTERN

      • MEMBER_COMMENT_SUFFIX_PATTERN

        public static final Pattern MEMBER_COMMENT_SUFFIX_PATTERN

      • LIST_ITEM_PREFIX

        public static final String LIST_ITEM_PREFIX
        Matches list delimiters. Ex: 
                        /// Paragraph 1
                /// - Paragraph 2
                ///  -# Paragraph 3
                ///  2. Paragraph 4
        See Also:
        Constant Field Values

      • LIST_ITEM_PREFIX_PATTERN

        public static final Pattern LIST_ITEM_PREFIX_PATTERN

      • LIST_ITEM_SUFFIX_PATTERN

        public static final Pattern LIST_ITEM_SUFFIX_PATTERN

    • Constructor Detail

      • DoxygenPatterns

        public DoxygenPatterns()