Xport Interface: comment::operator <<

Inserts text in the called comment object.

virtual markup& comment::operator<<(
  const std::string&  text
);

Parameters

pcdat

A string argument which represents text to insert as part of the comment.

Returns

Returns a reference to the comment's base class, markup. This allows the chaining of the operation, which is most useful when inserting text multiple times.

Remarks

This operation inserts text into the called comment object. The passed text is inserted at the end of any text which may be present in the comment object.

Complexity

Constant

Example

#include "xhtml_doc.h"
#include <iostream>

int main(int argc, char* argv[])
{
  using namespace Xport;

  document doc(root_doc);

  // create a comment in the body element
  comment com("The content of the document goes here.");
  com << "  Comment's inserter operator allows the insertion of more comment text.";
  doc.body()->insert(com);

  // send the document to cout
  formatter fmtr(std::cout);
  fmtr.option(max_line_length, 70);
  doc.write(fmtr);
  std::cout << "\n\n";

  return 0;
}