From 728e26e42645d4d70ca65522990f915f47b47a50 Mon Sep 17 00:00:00 2001 From: Jesse Beder Date: Thu, 12 May 2016 23:23:05 -0500 Subject: [PATCH] Update doc, formatting for emit.h. --- include/yaml-cpp/node/emit.h | 9 ++++++++- src/emit.cpp | 2 +- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/include/yaml-cpp/node/emit.h b/include/yaml-cpp/node/emit.h index 7c55af2..9154b51 100644 --- a/include/yaml-cpp/node/emit.h +++ b/include/yaml-cpp/node/emit.h @@ -16,10 +16,17 @@ namespace YAML { class Emitter; 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); + +/** Emits the node to the given output stream. */ 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); -} +} // namespace YAML #endif // NODE_EMIT_H_62B23520_7C8E_11DE_8A39_0800200C9A66 diff --git a/src/emit.cpp b/src/emit.cpp index 5fb593b..67f68a9 100644 --- a/src/emit.cpp +++ b/src/emit.cpp @@ -22,4 +22,4 @@ std::string Dump(const Node& node) { emitter << node; return emitter.c_str(); } -} +} // namespace YAML