GBCommentComponentsProvider Class Reference

Tasks

Initialization & disposal

• + provider Returns a new autoreleased GBCommentComponentsProvider instance.

Lists definitions

• orderedListRegex Returns the regex used for matching ordered lists with capture 1 containing lists indent and capture 2 string value.
• orderedListMatchRegex Returns the regex used for testing whether a string matches an ordered lists.
• unorderedListRegex Returns the regex used for matching unordered lists with capture 1 containing list indent and capture 2 string value.
• unorderedListMatchRegex Returns the regex used for testing whether a string matches an unordered list.

Sections definitions

• warningSectionRegex Returns the regex used for matching warning section with capture 1 containing description.
• bugSectionRegex Returns the regex used for matching bug section with capture 1 containing description.
• exampleSectionRegex Returns the regex used for matching example section with capture 1 containing example text.
• exampleLinesRegex Returns the regex used for matching example lines with capture 1 containing example lines texts.

Method specific definitions

• methodGroupRegex Returns the regex used for matching method groups with capture 1 containing section name.
• argumentsMatchingRegex Returns the regex used for matching different method parameter descriptions within the paragraph.
• nextArgumentRegex Returns the regex used for finding next method parameter description within the paragraph.
• parameterDescriptionRegex Returns the regex used for matching method parameter description with capture 1 containing parameter name and capture 2 description.
• returnDescriptionRegex Returns the regex used for matching method return description with capture 1 containing description.
• exceptionDescriptionRegex Returns the regex used for matching method exception description with capture 1 containing exception name and capture 2 description.
• crossReferenceRegex Returns the regex used for matching cross reference directive with capture 1 containing link.

Common definitions

• remoteMemberCrossReferenceRegex Returns the regex used for matching (possible) remote member cross references with capture 1 containing object name and capture 2 member name.
• localMemberCrossReferenceRegex Returns the regex used for matching (possible) local member cross reference with capture 1 containing member name.
• objectCrossReferenceRegex Returns the regex used for matching (possible) object cross reference with capture 1 containing object name.
• urlCrossReferenceRegex Returns the regex used for matching URL cross reference with caption 1 contining the URL itself.

Other Methods

• - exampleRegexWithoutFlags
• - argumentsCommonRegex
• - descriptionCaptureRegexForKeyword:
• - nameDescriptionCaptureRegexForKeyword:
• - crossReferenceRegexByEmbeddingRegex: