readAndWriteComment

Writes a doc comment to the given file and returns the summary text.

string

readAndWriteComment

(

File f

ref string[string] macros

ref Comment[] prevComments

const FunctionBody functionBody = null

Tuple!(string, string)[] testDocs = null

)

Parameters

f File: The file to write the comment to
comment string: The comment to write
macros string[string]: Macro definitions used in processing the comment
prevComments Comment[]: Previously encountered comments. This is used for handling "ditto" comments. May be null.
functionBody FunctionBody: A function body used for writing contract information. May be null.

Type: string

the summary from the given comment