splitSections

Split a text into sections.

Takes a text, which is generally a full comment (usually you'll also call unDecorateComment before). It splits it in an array of Section and returns it. Whatever the content of text is, this function will always return an array of at least 2 items. Those 2 sections are the "Summary" and "Description" sections (which may be empty).

splitSections
(
string text
)

Parameters

text string

A DDOC-formatted comment.

Return Value

Type: Section[]

An array of Section with at least 2 elements.

Meta