Type: String
Pattern used to match path/filename.txt
This patterns position is required to match the value of indexFile that has been set for current instance.
Type: Number
Indicates the index that the file path will be found at.
This value is required to match the index of the file name within the regular expression
set in the fileName value.
Usually this is 1.
Type: Number
Indicates the index that the options will be found at.
This value is required to match the index of the parameters within the regular expression
set in the parameters value.
Usually this is 2.
Type: String
The kind of internal regular expression to apply.
Must match a value of the regexKind enum.
Type: String
Name of the build_include segment.
Type: String
The options to apply to the regular epression. such as i
for ignore case.
Type: String
Regular expression used to match the options.
This patterns position is required to match the value of indexParam that has been set for current instance.
Type: String
Optional path that can be appended to file.
This can be useful when using [[include:filePath]]
as the path of include may be a subdirectory path as is
often the case when using typedoc.
Type: String
Regular expression used to match what precludes BUILD_INCLUDE.
Type: String
Regular expression used to match what comes after BUILD_INCLUDE and parameters.
Generated using TypeDoc
Match options for matching build_include in files.
The match options are combined into one regular expression.