Write the specified comment into the stream.
Declared in <balxml_formatter.h>
int
addValidComment(
std::string_view const& comment,
bool forceNewline = true,
bool omitEnclosingWhitespace = false);Optionally specify forceNewline that specifies if a new line should be added before the comment if it is not already on a new line. If forceNewline is not specified then a new line is inserted for comments not already on a new line. Also optionally specify an omitEnclosingWhitespace that specifies if a space character should be omitted before and after comment. If omitEnclosingWhitespace is not specified then a space character is inserted before and after comment. Return 0 on success, and non-zero value otherwise. Note that a non-zero return value is returned if either comment contains -- or if omitEnclosingWhitespace is true and comment ends with -. Also note that if an element-opening tag is not completed with a >, addValidComment will add >.
0 on success, and a non-zero value otherwise
| Name | Description |
|---|---|
| comment | text of the comment to write |
| forceNewline | whether to force the comment onto a new line |
| omitEnclosingWhitespace | whether to omit spaces around the comment |