mirror of
https://github.com/jbeder/yaml-cpp.git
synced 2025-09-09 12:41:17 +00:00
Update doc, formatting for parse.h.
This commit is contained in:
@@ -16,15 +16,63 @@
|
|||||||
namespace YAML {
|
namespace YAML {
|
||||||
class Node;
|
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);
|
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);
|
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);
|
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);
|
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);
|
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);
|
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);
|
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);
|
YAML_CPP_API std::vector<Node> LoadAllFromFile(const std::string& filename);
|
||||||
}
|
} // namespace YAML
|
||||||
|
|
||||||
#endif // VALUE_PARSE_H_62B23520_7C8E_11DE_8A39_0800200C9A66
|
#endif // VALUE_PARSE_H_62B23520_7C8E_11DE_8A39_0800200C9A66
|
||||||
|
@@ -22,16 +22,18 @@ Node Load(const char* input) {
|
|||||||
Node Load(std::istream& input) {
|
Node Load(std::istream& input) {
|
||||||
Parser parser(input);
|
Parser parser(input);
|
||||||
NodeBuilder builder;
|
NodeBuilder builder;
|
||||||
if (!parser.HandleNextDocument(builder))
|
if (!parser.HandleNextDocument(builder)) {
|
||||||
return Node();
|
return Node();
|
||||||
|
}
|
||||||
|
|
||||||
return builder.Root();
|
return builder.Root();
|
||||||
}
|
}
|
||||||
|
|
||||||
Node LoadFile(const std::string& filename) {
|
Node LoadFile(const std::string& filename) {
|
||||||
std::ifstream fin(filename.c_str());
|
std::ifstream fin(filename.c_str());
|
||||||
if (!fin)
|
if (!fin) {
|
||||||
throw BadFile();
|
throw BadFile();
|
||||||
|
}
|
||||||
return Load(fin);
|
return Load(fin);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -51,8 +53,9 @@ std::vector<Node> LoadAll(std::istream& input) {
|
|||||||
Parser parser(input);
|
Parser parser(input);
|
||||||
while (1) {
|
while (1) {
|
||||||
NodeBuilder builder;
|
NodeBuilder builder;
|
||||||
if (!parser.HandleNextDocument(builder))
|
if (!parser.HandleNextDocument(builder)) {
|
||||||
break;
|
break;
|
||||||
|
}
|
||||||
docs.push_back(builder.Root());
|
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::vector<Node> LoadAllFromFile(const std::string& filename) {
|
||||||
std::ifstream fin(filename.c_str());
|
std::ifstream fin(filename.c_str());
|
||||||
if (!fin)
|
if (!fin) {
|
||||||
throw BadFile();
|
throw BadFile();
|
||||||
|
}
|
||||||
return LoadAll(fin);
|
return LoadAll(fin);
|
||||||
}
|
}
|
||||||
}
|
} // namespace YAML
|
||||||
|
Reference in New Issue
Block a user