Update doc, formatting for parse.h.

Amxxl · May 13, 2016 · 3392ab9 · 3392ab9
1 parent 6c569e5
commit 3392ab9
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 6 deletions.
diff --git a/include/yaml-cpp/node/parse.h b/include/yaml-cpp/node/parse.h
@@ -16,15 +16,63 @@
 namespace YAML {
 class Node;
 
+/**
+ * Loads the input string as a single YAML document.
+ *
+ * @throws {@link ParserException} if it is malformed.
+ */
 YAML_CPP_API Node Load(const std::string& input);
+
+/**
+ * Loads the input string as a single YAML document.
+ *
+ * @throws {@link ParserException} if it is malformed.
+ */
 YAML_CPP_API Node Load(const char* input);
+
+/**
+ * Loads the input stream as a single YAML document.
+ *
+ * @throws {@link ParserException} if it is malformed.
+ */
 YAML_CPP_API Node Load(std::istream& input);
+
+/**
+ * Loads the input file as a single YAML document.
+ *
+ * @throws {@link ParserException} if it is malformed.
+ * @throws {@link BadFile} if the file cannot be loaded.
+ */
 YAML_CPP_API Node LoadFile(const std::string& filename);
 
+/**
+ * Loads the input string as a list of YAML documents.
+ *
+ * @throws {@link ParserException} if it is malformed.
+ */
 YAML_CPP_API std::vector<Node> LoadAll(const std::string& input);
+
+/**
+ * Loads the input string as a list of YAML documents.
+ *
+ * @throws {@link ParserException} if it is malformed.
+ */
 YAML_CPP_API std::vector<Node> LoadAll(const char* input);
+
+/**
+ * Loads the input stream as a list of YAML documents.
+ *
+ * @throws {@link ParserException} if it is malformed.
+ */
 YAML_CPP_API std::vector<Node> LoadAll(std::istream& input);
+
+/**
+ * Loads the input file as a list of YAML documents.
+ *
+ * @throws {@link ParserException} if it is malformed.
+ * @throws {@link BadFile} if the file cannot be loaded.
+ */
 YAML_CPP_API std::vector<Node> LoadAllFromFile(const std::string& filename);
-}
+}  // namespace YAML
 
 #endif  // VALUE_PARSE_H_62B23520_7C8E_11DE_8A39_0800200C9A66
diff --git a/src/parse.cpp b/src/parse.cpp
@@ -22,16 +22,18 @@ Node Load(const char* input) {
 Node Load(std::istream& input) {
   Parser parser(input);
   NodeBuilder builder;
-  if (!parser.HandleNextDocument(builder))
+  if (!parser.HandleNextDocument(builder)) {
     return Node();
+  }
 
   return builder.Root();
 }
 
 Node LoadFile(const std::string& filename) {
   std::ifstream fin(filename.c_str());
-  if (!fin)
+  if (!fin) {
     throw BadFile();
+  }
   return Load(fin);
 }
 
@@ -51,8 +53,9 @@ std::vector<Node> LoadAll(std::istream& input) {
   Parser parser(input);
   while (1) {
     NodeBuilder builder;
-    if (!parser.HandleNextDocument(builder))
+    if (!parser.HandleNextDocument(builder)) {
       break;
+    }
     docs.push_back(builder.Root());
   }
 
@@ -61,8 +64,9 @@ std::vector<Node> LoadAll(std::istream& input) {
 
 std::vector<Node> LoadAllFromFile(const std::string& filename) {
   std::ifstream fin(filename.c_str());
-  if (!fin)
+  if (!fin) {
     throw BadFile();
+  }
   return LoadAll(fin);
 }
-}
+}  // namespace YAML