to_cpp_comment#

omni.graph.tools.ogn.to_cpp_comment(multiline_string: str, indent_level: int = 0)#

Convert a multiline string into a C++ comment

Parameters:
  • multiline_string – String with potential newlines in it

  • indent_level – Number of spaces the resulting comment should be indented

Returns:

String representing a C++ comment with one line of the comment per one line of the input. Each line of the string is indented the given number of spaces.