Update doc, formatting for emit.h.

mhaag · May 13, 2016 · 728e26e · 728e26e
1 parent 3392ab9
commit 728e26e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git 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
@@ -22,4 +22,4 @@ std::string Dump(const Node& node) {
   emitter << node;
   return emitter.c_str();
 }
-}
+} // namespace YAML