"vscode:/vscode.git/clone" did not exist on "6a6dfe1cbddfec78854d81340bce9f98dfd6bed1"
Commit 728e26e4 authored by Jesse Beder's avatar Jesse Beder
Browse files

Update doc, formatting for emit.h.

parent 3392ab98
...@@ -16,10 +16,17 @@ namespace YAML { ...@@ -16,10 +16,17 @@ namespace YAML {
class Emitter; class Emitter;
class Node; class Node;
/**
* Emits the node to the given {@link Emitter}. If there is an error in writing,
* {@link Emitter#good} will return false.
*/
YAML_CPP_API Emitter& operator<<(Emitter& out, const Node& node); YAML_CPP_API Emitter& operator<<(Emitter& out, const Node& node);
/** Emits the node to the given output stream. */
YAML_CPP_API std::ostream& operator<<(std::ostream& out, const Node& node); YAML_CPP_API std::ostream& operator<<(std::ostream& out, const Node& node);
/** Converts the node to a YAML string. */
YAML_CPP_API std::string Dump(const Node& node); YAML_CPP_API std::string Dump(const Node& node);
} } // namespace YAML
#endif // NODE_EMIT_H_62B23520_7C8E_11DE_8A39_0800200C9A66 #endif // NODE_EMIT_H_62B23520_7C8E_11DE_8A39_0800200C9A66
...@@ -22,4 +22,4 @@ std::string Dump(const Node& node) { ...@@ -22,4 +22,4 @@ std::string Dump(const Node& node) {
emitter << node; emitter << node;
return emitter.c_str(); return emitter.c_str();
} }
} } // namespace YAML
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment