parseDdoc

Parses a ddoc string into a divided comment.

Comment
parseDdoc
(
string ddoc
,
bool throwError = false
)

Parameters

ddoc string

the documentation string as given by the user without any comment markers

throwError bool

set to true to make parsing errors throw

Return Value

Type: Comment

A comment if the ddoc could be parsed or Comment.init if it couldn't be parsed and throwError is false.

Throws

Exception if comment has ddoc syntax errors.

Meta