The current options. This parameter is an object and will be potentially modified by this method.
Appends multi comment marks before and after the biOpt.lines if needed.
The current options. This parameter is an object and will be potentially modified by this method.
Appends multi comment marks before and after the biOpt.lines
The current options. This parameter is an object and will be potentially modified by this method.
Decodes string such as \u2014 to —
string to decode
Generates an array with the body of content for a html comment. applies Padding as follows: IComment.padLeft is applied to the beginning of each line
IPadding.padLeft is applied before comment
IPadding.padRight is applied after comment
Indent is appled to the start if each line if indenting is enabled.
The current options. This parameter is an object and will be potentially modified by this method.
Determins if the lines passed in var biOpt are formated as multi-line coments or single-line comments
The current options. This parameter is an object and will be potentially modified by this method.
Builds a string array of lines with multiline comments for the body of a multiline style or JsDoc style.
IComment.padLeft is applied to the beginning of each line
IPadding.padLeft is applied before comment
IPadding.padRight is applied after comment
Each line in the array is prefixed with * and depending on the paddind space(s) on each side.
Indent is appled to the start if each line if indenting is enabled.
The current options. This parameter is an object and will be potentially modified by this method.
Builds a string array of lines with single line comments
The arguments from the options string values.
If args.comment.padLeft is set it will be applied before * for each line of the comment.
If args.text.padLeft is set it will be applied after * but before each line of the comment.
If args.text.padRight is set it will be applied after each line of the comment.
Checks opts for comment options and assigns any found options to biOpt
The array of options to search for comment options in
The current options. This parameter is an object and will be potentially modified by this method.
true if opts has comment options; Otherwise, false.
Process any comments that are in the current biOpt.Lines and returns an string array of processed lines.
The current options. This parameter is an object and will be potentially modified by this method.
a string[] of comment processed lines.
Depending on the type of comment this method will modify biOpt to put comment marks at the start and end of biOpt.lines
The current options. This parameter is an object and will be potentially modified by this method.
Generated using TypeDoc
Wraps the results of [[commentHtml]] in html comments marks.
If there is a single line of comments then that line will have a prefix of
<!--and a suffix of-->.If there are multiple lines then
<!--will be the the first line and-->will be the last line.[[commentHtml]]