BloombergLP::balxml::Formatter_PrettyImplUtil::addComment

Synopsis

Declared in <balxml_formatter_prettyimpl.h>

static
std::ostream&
addComment(
    std::ostream& stream,
    State* state,
    std::string_view const& comment,
    bool forceNewline = true);

Description

Formatting depends on the specified state, which is updated accordingly. Return the stream. The optionally specified forceNewline, if true, forces to start a new line solely for the comment if it's not on a new line already. Otherwise, comments continue on current line. If an element-opening tag is not completed with a >, addComment will add >.

DEPRECATED: Use addValidComment instead.

Return Value

a reference to the modifiable stream

Parameters

Name	Description
stream	output stream to write to
state	formatter state to update
comment	text of the comment to write
forceNewline	whether to force the comment onto a new line