From 7f58f6a900c06d63f227f0d65c11bca79477f610 Mon Sep 17 00:00:00 2001 From: Leonetienne Date: Thu, 3 Jun 2021 16:40:02 +0200 Subject: [PATCH] Built doxygen --- docs/DataType_8h.html | 2 +- docs/DataType_8h_source.html | 2 +- ...lnupp_8vcxproj_8FileListAbsolute_8txt.html | 2 +- docs/FloatValue_8cpp.html | 2 +- docs/FloatValue_8cpp_source.html | 2 +- docs/FloatValue_8h.html | 2 +- docs/FloatValue_8h_source.html | 2 +- docs/HazelnuppException_8h.html | 2 +- docs/HazelnuppException_8h_source.html | 2 +- docs/Hazelnupp_8cpp.html | 2 +- docs/Hazelnupp_8cpp_source.html | 2 +- docs/Hazelnupp_8h.html | 2 +- docs/Hazelnupp_8h_source.html | 2 +- docs/IntValue_8cpp.html | 2 +- docs/IntValue_8cpp_source.html | 2 +- docs/IntValue_8h.html | 2 +- docs/IntValue_8h_source.html | 2 +- docs/ListValue_8cpp.html | 2 +- docs/ListValue_8cpp_source.html | 2 +- docs/ListValue_8h.html | 2 +- docs/ListValue_8h_source.html | 2 +- docs/ParamConstraint_8h.html | 2 +- docs/ParamConstraint_8h_source.html | 2 +- docs/Parameter_8cpp.html | 2 +- docs/Parameter_8cpp_source.html | 2 +- docs/Parameter_8h.html | 2 +- docs/Parameter_8h_source.html | 2 +- ...lnupp_8vcxproj_8FileListAbsolute_8txt.html | 2 +- docs/StringTools_8cpp.html | 2 +- docs/StringTools_8cpp_source.html | 2 +- docs/StringTools_8h.html | 2 +- docs/StringTools_8h_source.html | 2 +- docs/StringValue_8cpp.html | 2 +- docs/StringValue_8cpp_source.html | 2 +- docs/StringValue_8h.html | 2 +- docs/StringValue_8h_source.html | 2 +- docs/Value_8cpp.html | 2 +- docs/Value_8cpp_source.html | 2 +- docs/Value_8h.html | 2 +- docs/Value_8h_source.html | 2 +- docs/VoidValue_8cpp.html | 2 +- docs/VoidValue_8cpp_source.html | 2 +- docs/VoidValue_8h.html | 2 +- docs/VoidValue_8h_source.html | 2 +- docs/annotated.html | 2 +- docs/classHazelnp_1_1FloatValue-members.html | 2 +- docs/classHazelnp_1_1FloatValue.html | 2 +- docs/classHazelnp_1_1Hazelnupp-members.html | 2 +- docs/classHazelnp_1_1Hazelnupp.html | 2 +- ...1HazelnuppConstraintException-members.html | 2 +- ...zelnp_1_1HazelnuppConstraintException.html | 2 +- ...zelnuppConstraintMissingValue-members.html | 2 +- ...np_1_1HazelnuppConstraintMissingValue.html | 2 +- ...elnuppConstraintTypeMissmatch-members.html | 2 +- ...p_1_1HazelnuppConstraintTypeMissmatch.html | 2 +- ...Hazelnp_1_1HazelnuppException-members.html | 2 +- docs/classHazelnp_1_1HazelnuppException.html | 2 +- ...1HazelnuppInvalidKeyException-members.html | 2 +- ...zelnp_1_1HazelnuppInvalidKeyException.html | 2 +- ...pValueNotConvertibleException-members.html | 2 +- ...HazelnuppValueNotConvertibleException.html | 2 +- docs/classHazelnp_1_1IntValue-members.html | 2 +- docs/classHazelnp_1_1IntValue.html | 2 +- docs/classHazelnp_1_1ListValue-members.html | 2 +- docs/classHazelnp_1_1ListValue.html | 2 +- docs/classHazelnp_1_1Parameter-members.html | 2 +- docs/classHazelnp_1_1Parameter.html | 2 +- docs/classHazelnp_1_1StringTools-members.html | 2 +- docs/classHazelnp_1_1StringTools.html | 2 +- docs/classHazelnp_1_1StringValue-members.html | 2 +- docs/classHazelnp_1_1StringValue.html | 2 +- docs/classHazelnp_1_1Value-members.html | 2 +- docs/classHazelnp_1_1Value.html | 2 +- docs/classHazelnp_1_1VoidValue-members.html | 2 +- docs/classHazelnp_1_1VoidValue.html | 2 +- docs/classes.html | 2 +- .../dir_0202e1e26df2e040f4dc3d434eecf04c.html | 2 +- .../dir_0cc5f59b28c403d42cc56800132eb975.html | 2 +- .../dir_1148ebc2b25b55095aebf6f4cbb6efca.html | 2 +- .../dir_a8cffda729361e9d9637effa362fcea9.html | 2 +- docs/files.html | 2 +- docs/functions.html | 2 +- docs/functions_func.html | 2 +- docs/functions_rela.html | 2 +- docs/functions_vars.html | 2 +- docs/globals.html | 2 +- docs/globals_func.html | 2 +- docs/graph_legend.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 56 ++++++++++++------- docs/index_8md.html | 2 +- docs/inherits.html | 2 +- docs/main_8cpp.html | 2 +- docs/main_8cpp_source.html | 2 +- docs/namespaceHazelnp.html | 2 +- docs/namespacemembers.html | 2 +- docs/namespacemembers_enum.html | 2 +- docs/namespaces.html | 2 +- ...uctHazelnp_1_1ParamConstraint-members.html | 2 +- docs/structHazelnp_1_1ParamConstraint.html | 2 +- 100 files changed, 135 insertions(+), 119 deletions(-) diff --git a/docs/DataType_8h.html b/docs/DataType_8h.html index 047d0a6..f232859 100644 --- a/docs/DataType_8h.html +++ b/docs/DataType_8h.html @@ -132,7 +132,7 @@ Enumerations diff --git a/docs/DataType_8h_source.html b/docs/DataType_8h_source.html index 34a0d0f..26e6681 100644 --- a/docs/DataType_8h_source.html +++ b/docs/DataType_8h_source.html @@ -101,7 +101,7 @@ $(function() {
@ STRING
diff --git a/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html b/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html index f0e492a..5f8a8c5 100644 --- a/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html +++ b/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html @@ -77,7 +77,7 @@ $(function() { diff --git a/docs/FloatValue_8cpp.html b/docs/FloatValue_8cpp.html index 180dff5..1204ab5 100644 --- a/docs/FloatValue_8cpp.html +++ b/docs/FloatValue_8cpp.html @@ -102,7 +102,7 @@ Include dependency graph for FloatValue.cpp: diff --git a/docs/FloatValue_8cpp_source.html b/docs/FloatValue_8cpp_source.html index 49100b7..c834e2b 100644 --- a/docs/FloatValue_8cpp_source.html +++ b/docs/FloatValue_8cpp_source.html @@ -173,7 +173,7 @@ $(function() {
int GetInt32() const override
Will return the data as an int.
Definition: FloatValue.cpp:49
diff --git a/docs/FloatValue_8h.html b/docs/FloatValue_8h.html index 77f504c..c0399d0 100644 --- a/docs/FloatValue_8h.html +++ b/docs/FloatValue_8h.html @@ -122,7 +122,7 @@ Namespaces diff --git a/docs/FloatValue_8h_source.html b/docs/FloatValue_8h_source.html index 64bff1a..d7f10f0 100644 --- a/docs/FloatValue_8h_source.html +++ b/docs/FloatValue_8h_source.html @@ -131,7 +131,7 @@ $(function() {
int GetInt32() const override
Will return the data as an int.
Definition: FloatValue.cpp:49
diff --git a/docs/HazelnuppException_8h.html b/docs/HazelnuppException_8h.html index 23af0c1..882497d 100644 --- a/docs/HazelnuppException_8h.html +++ b/docs/HazelnuppException_8h.html @@ -137,7 +137,7 @@ Namespaces diff --git a/docs/HazelnuppException_8h_source.html b/docs/HazelnuppException_8h_source.html index fa42ced..4d3397d 100644 --- a/docs/HazelnuppException_8h_source.html +++ b/docs/HazelnuppException_8h_source.html @@ -157,7 +157,7 @@ $(function() {
HazelnuppInvalidKeyException()
diff --git a/docs/Hazelnupp_8cpp.html b/docs/Hazelnupp_8cpp.html index 2e7053d..7441a3d 100644 --- a/docs/Hazelnupp_8cpp.html +++ b/docs/Hazelnupp_8cpp.html @@ -122,7 +122,7 @@ Include dependency graph for Hazelnupp.cpp: diff --git a/docs/Hazelnupp_8cpp_source.html b/docs/Hazelnupp_8cpp_source.html index a46636a..5432ce3 100644 --- a/docs/Hazelnupp_8cpp_source.html +++ b/docs/Hazelnupp_8cpp_source.html @@ -522,7 +522,7 @@ $(function() {
diff --git a/docs/Hazelnupp_8h.html b/docs/Hazelnupp_8h.html index d8a12df..cc03848 100644 --- a/docs/Hazelnupp_8h.html +++ b/docs/Hazelnupp_8h.html @@ -128,7 +128,7 @@ Namespaces diff --git a/docs/Hazelnupp_8h_source.html b/docs/Hazelnupp_8h_source.html index 90dd0a9..d47518c 100644 --- a/docs/Hazelnupp_8h_source.html +++ b/docs/Hazelnupp_8h_source.html @@ -170,7 +170,7 @@ $(function() {
void SetCrashOnFail(bool crashOnFail)
Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...
Definition: Hazelnupp.cpp:381
diff --git a/docs/IntValue_8cpp.html b/docs/IntValue_8cpp.html index acfeb0e..c01f930 100644 --- a/docs/IntValue_8cpp.html +++ b/docs/IntValue_8cpp.html @@ -102,7 +102,7 @@ Include dependency graph for IntValue.cpp: diff --git a/docs/IntValue_8cpp_source.html b/docs/IntValue_8cpp_source.html index b1da84a..08da8d4 100644 --- a/docs/IntValue_8cpp_source.html +++ b/docs/IntValue_8cpp_source.html @@ -173,7 +173,7 @@ $(function() {
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
diff --git a/docs/IntValue_8h.html b/docs/IntValue_8h.html index 4947e93..c2f4ee5 100644 --- a/docs/IntValue_8h.html +++ b/docs/IntValue_8h.html @@ -122,7 +122,7 @@ Namespaces diff --git a/docs/IntValue_8h_source.html b/docs/IntValue_8h_source.html index b67110e..e08a2cd 100644 --- a/docs/IntValue_8h_source.html +++ b/docs/IntValue_8h_source.html @@ -131,7 +131,7 @@ $(function() {
diff --git a/docs/ListValue_8cpp.html b/docs/ListValue_8cpp.html index 049011f..604b6ac 100644 --- a/docs/ListValue_8cpp.html +++ b/docs/ListValue_8cpp.html @@ -102,7 +102,7 @@ Include dependency graph for ListValue.cpp: diff --git a/docs/ListValue_8cpp_source.html b/docs/ListValue_8cpp_source.html index c686f82..87d96b2 100644 --- a/docs/ListValue_8cpp_source.html +++ b/docs/ListValue_8cpp_source.html @@ -199,7 +199,7 @@ $(function() {
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
diff --git a/docs/ListValue_8h.html b/docs/ListValue_8h.html index 9e269dc..2eb1c1f 100644 --- a/docs/ListValue_8h.html +++ b/docs/ListValue_8h.html @@ -122,7 +122,7 @@ Namespaces diff --git a/docs/ListValue_8h_source.html b/docs/ListValue_8h_source.html index 1c55e30..7eed798 100644 --- a/docs/ListValue_8h_source.html +++ b/docs/ListValue_8h_source.html @@ -133,7 +133,7 @@ $(function() {
diff --git a/docs/ParamConstraint_8h.html b/docs/ParamConstraint_8h.html index b0173e2..d1c6680 100644 --- a/docs/ParamConstraint_8h.html +++ b/docs/ParamConstraint_8h.html @@ -122,7 +122,7 @@ Namespaces diff --git a/docs/ParamConstraint_8h_source.html b/docs/ParamConstraint_8h_source.html index 770bd5a..71b48a9 100644 --- a/docs/ParamConstraint_8h_source.html +++ b/docs/ParamConstraint_8h_source.html @@ -149,7 +149,7 @@ $(function() {
std::vector< std::string > defaultValue
The default value for this parameter.
diff --git a/docs/Parameter_8cpp.html b/docs/Parameter_8cpp.html index f222b76..54ac716 100644 --- a/docs/Parameter_8cpp.html +++ b/docs/Parameter_8cpp.html @@ -98,7 +98,7 @@ Include dependency graph for Parameter.cpp: diff --git a/docs/Parameter_8cpp_source.html b/docs/Parameter_8cpp_source.html index 4a74171..7cbd6fa 100644 --- a/docs/Parameter_8cpp_source.html +++ b/docs/Parameter_8cpp_source.html @@ -116,7 +116,7 @@ $(function() {
diff --git a/docs/Parameter_8h.html b/docs/Parameter_8h.html index 7057ffe..c50f4b8 100644 --- a/docs/Parameter_8h.html +++ b/docs/Parameter_8h.html @@ -125,7 +125,7 @@ Namespaces diff --git a/docs/Parameter_8h_source.html b/docs/Parameter_8h_source.html index e39a68e..33cd300 100644 --- a/docs/Parameter_8h_source.html +++ b/docs/Parameter_8h_source.html @@ -117,7 +117,7 @@ $(function() {
diff --git a/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html b/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html index 9b35c4d..f6a0671 100644 --- a/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html +++ b/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html @@ -77,7 +77,7 @@ $(function() { diff --git a/docs/StringTools_8cpp.html b/docs/StringTools_8cpp.html index 2e0db2e..2ef1743 100644 --- a/docs/StringTools_8cpp.html +++ b/docs/StringTools_8cpp.html @@ -97,7 +97,7 @@ Include dependency graph for StringTools.cpp: diff --git a/docs/StringTools_8cpp_source.html b/docs/StringTools_8cpp_source.html index 08f0dea..d7abd85 100644 --- a/docs/StringTools_8cpp_source.html +++ b/docs/StringTools_8cpp_source.html @@ -275,7 +275,7 @@ $(function() {
static std::string ToLower(const std::string &str)
Will make a string all lower-case.
diff --git a/docs/StringTools_8h.html b/docs/StringTools_8h.html index 8e3f93e..acec948 100644 --- a/docs/StringTools_8h.html +++ b/docs/StringTools_8h.html @@ -124,7 +124,7 @@ Namespaces diff --git a/docs/StringTools_8h_source.html b/docs/StringTools_8h_source.html index 88cb13f..fda1c7d 100644 --- a/docs/StringTools_8h_source.html +++ b/docs/StringTools_8h_source.html @@ -117,7 +117,7 @@ $(function() {
static std::string ToLower(const std::string &str)
Will make a string all lower-case.
diff --git a/docs/StringValue_8cpp.html b/docs/StringValue_8cpp.html index a3d7460..aa80e76 100644 --- a/docs/StringValue_8cpp.html +++ b/docs/StringValue_8cpp.html @@ -103,7 +103,7 @@ Include dependency graph for StringValue.cpp: diff --git a/docs/StringValue_8cpp_source.html b/docs/StringValue_8cpp_source.html index d0bc537..2a49e8d 100644 --- a/docs/StringValue_8cpp_source.html +++ b/docs/StringValue_8cpp_source.html @@ -165,7 +165,7 @@ $(function() {
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
diff --git a/docs/StringValue_8h.html b/docs/StringValue_8h.html index b77aa89..76c3edf 100644 --- a/docs/StringValue_8h.html +++ b/docs/StringValue_8h.html @@ -123,7 +123,7 @@ Namespaces diff --git a/docs/StringValue_8h_source.html b/docs/StringValue_8h_source.html index 16daf68..0b364a9 100644 --- a/docs/StringValue_8h_source.html +++ b/docs/StringValue_8h_source.html @@ -130,7 +130,7 @@ $(function() {
diff --git a/docs/Value_8cpp.html b/docs/Value_8cpp.html index b3f178a..c55a566 100644 --- a/docs/Value_8cpp.html +++ b/docs/Value_8cpp.html @@ -96,7 +96,7 @@ Include dependency graph for Value.cpp: diff --git a/docs/Value_8cpp_source.html b/docs/Value_8cpp_source.html index 49294f2..7197f78 100644 --- a/docs/Value_8cpp_source.html +++ b/docs/Value_8cpp_source.html @@ -102,7 +102,7 @@ $(function() {
diff --git a/docs/Value_8h.html b/docs/Value_8h.html index 077946f..4fa9b9d 100644 --- a/docs/Value_8h.html +++ b/docs/Value_8h.html @@ -136,7 +136,7 @@ Namespaces diff --git a/docs/Value_8h_source.html b/docs/Value_8h_source.html index 02e7c2b..a856147 100644 --- a/docs/Value_8h_source.html +++ b/docs/Value_8h_source.html @@ -137,7 +137,7 @@ $(function() {
virtual long double GetFloat64() const =0
Will attempt to return the floating-point data (long double)
diff --git a/docs/VoidValue_8cpp.html b/docs/VoidValue_8cpp.html index 100ab35..1fbc9c7 100644 --- a/docs/VoidValue_8cpp.html +++ b/docs/VoidValue_8cpp.html @@ -100,7 +100,7 @@ Include dependency graph for VoidValue.cpp: diff --git a/docs/VoidValue_8cpp_source.html b/docs/VoidValue_8cpp_source.html index 0d7f6c5..e25bb9d 100644 --- a/docs/VoidValue_8cpp_source.html +++ b/docs/VoidValue_8cpp_source.html @@ -150,7 +150,7 @@ $(function() {
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
diff --git a/docs/VoidValue_8h.html b/docs/VoidValue_8h.html index 68238e6..6b088c8 100644 --- a/docs/VoidValue_8h.html +++ b/docs/VoidValue_8h.html @@ -121,7 +121,7 @@ Namespaces diff --git a/docs/VoidValue_8h_source.html b/docs/VoidValue_8h_source.html index 4731200..fb8e9cc 100644 --- a/docs/VoidValue_8h_source.html +++ b/docs/VoidValue_8h_source.html @@ -121,7 +121,7 @@ $(function() {
diff --git a/docs/annotated.html b/docs/annotated.html index bb4c61b..eb84b51 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -98,7 +98,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1FloatValue-members.html b/docs/classHazelnp_1_1FloatValue-members.html index 6362f18..6201384 100644 --- a/docs/classHazelnp_1_1FloatValue-members.html +++ b/docs/classHazelnp_1_1FloatValue-members.html @@ -101,7 +101,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1FloatValue.html b/docs/classHazelnp_1_1FloatValue.html index aff0831..da0a248 100644 --- a/docs/classHazelnp_1_1FloatValue.html +++ b/docs/classHazelnp_1_1FloatValue.html @@ -574,7 +574,7 @@ Additional Inherited Members
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
diff --git a/docs/classHazelnp_1_1Hazelnupp-members.html b/docs/classHazelnp_1_1Hazelnupp-members.html index 00a07cc..4d20c44 100644 --- a/docs/classHazelnp_1_1Hazelnupp-members.html +++ b/docs/classHazelnp_1_1Hazelnupp-members.html @@ -99,7 +99,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1Hazelnupp.html b/docs/classHazelnp_1_1Hazelnupp.html index 86f560d..a994aa5 100644 --- a/docs/classHazelnp_1_1Hazelnupp.html +++ b/docs/classHazelnp_1_1Hazelnupp.html @@ -626,7 +626,7 @@ Public Member Functions
Gets thrown when a parameter is of a type that does not match the required type, and is not convertib...
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException-members.html b/docs/classHazelnp_1_1HazelnuppConstraintException-members.html index 28b9400..95a4b95 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintException-members.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintException-members.html @@ -90,7 +90,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException.html b/docs/classHazelnp_1_1HazelnuppConstraintException.html index 646ef7c..f29ce23 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintException.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintException.html @@ -201,7 +201,7 @@ Additional Inherited Members
HazelnuppException()
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html index ee20767..7de5e22 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html @@ -92,7 +92,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html index 4004aae..7e5f5ca 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html @@ -206,7 +206,7 @@ Additional Inherited Members
HazelnuppConstraintException()
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html index 082ffa2..843e262 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html @@ -92,7 +92,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html index 4600db7..5c02c1d 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html @@ -206,7 +206,7 @@ Additional Inherited Members
HazelnuppConstraintException()
diff --git a/docs/classHazelnp_1_1HazelnuppException-members.html b/docs/classHazelnp_1_1HazelnuppException-members.html index 6fe80e8..8774b9c 100644 --- a/docs/classHazelnp_1_1HazelnuppException-members.html +++ b/docs/classHazelnp_1_1HazelnuppException-members.html @@ -88,7 +88,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppException.html b/docs/classHazelnp_1_1HazelnuppException.html index c55aae8..9250bc7 100644 --- a/docs/classHazelnp_1_1HazelnuppException.html +++ b/docs/classHazelnp_1_1HazelnuppException.html @@ -255,7 +255,7 @@ Protected Attributes
std::string message
diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html b/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html index 5bb996f..663e00d 100644 --- a/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html @@ -90,7 +90,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html b/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html index 0112923..5d4c3ce 100644 --- a/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html @@ -199,7 +199,7 @@ Additional Inherited Members
HazelnuppException()
diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html index f2283e3..b64b2b6 100644 --- a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html @@ -90,7 +90,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html index d8d7c1e..96ec003 100644 --- a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html @@ -199,7 +199,7 @@ Additional Inherited Members
HazelnuppException()
diff --git a/docs/classHazelnp_1_1IntValue-members.html b/docs/classHazelnp_1_1IntValue-members.html index dfecb79..71c9449 100644 --- a/docs/classHazelnp_1_1IntValue-members.html +++ b/docs/classHazelnp_1_1IntValue-members.html @@ -101,7 +101,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1IntValue.html b/docs/classHazelnp_1_1IntValue.html index 3e607ac..570173b 100644 --- a/docs/classHazelnp_1_1IntValue.html +++ b/docs/classHazelnp_1_1IntValue.html @@ -574,7 +574,7 @@ Additional Inherited Members
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
diff --git a/docs/classHazelnp_1_1ListValue-members.html b/docs/classHazelnp_1_1ListValue-members.html index d6be580..730c50c 100644 --- a/docs/classHazelnp_1_1ListValue-members.html +++ b/docs/classHazelnp_1_1ListValue-members.html @@ -101,7 +101,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1ListValue.html b/docs/classHazelnp_1_1ListValue.html index 825823c..cf1533d 100644 --- a/docs/classHazelnp_1_1ListValue.html +++ b/docs/classHazelnp_1_1ListValue.html @@ -601,7 +601,7 @@ Additional Inherited Members
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
diff --git a/docs/classHazelnp_1_1Parameter-members.html b/docs/classHazelnp_1_1Parameter-members.html index 00fc385..962f802 100644 --- a/docs/classHazelnp_1_1Parameter-members.html +++ b/docs/classHazelnp_1_1Parameter-members.html @@ -89,7 +89,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1Parameter.html b/docs/classHazelnp_1_1Parameter.html index e728b3b..58b40ee 100644 --- a/docs/classHazelnp_1_1Parameter.html +++ b/docs/classHazelnp_1_1Parameter.html @@ -275,7 +275,7 @@ Friends
virtual Value * Deepcopy() const =0
Will return a deeopopy of this object.
diff --git a/docs/classHazelnp_1_1StringTools-members.html b/docs/classHazelnp_1_1StringTools-members.html index 02d6a91..42f8541 100644 --- a/docs/classHazelnp_1_1StringTools-members.html +++ b/docs/classHazelnp_1_1StringTools-members.html @@ -92,7 +92,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1StringTools.html b/docs/classHazelnp_1_1StringTools.html index c3ed9f2..a2237ba 100644 --- a/docs/classHazelnp_1_1StringTools.html +++ b/docs/classHazelnp_1_1StringTools.html @@ -626,7 +626,7 @@ Static Public Member Functions
static std::vector< std::string > SplitString(const std::string &str, const char delimiter)
Will split a string by a delimiter char. The delimiter will be excluded!
diff --git a/docs/classHazelnp_1_1StringValue-members.html b/docs/classHazelnp_1_1StringValue-members.html index 7d3c8c7..6db77e5 100644 --- a/docs/classHazelnp_1_1StringValue-members.html +++ b/docs/classHazelnp_1_1StringValue-members.html @@ -100,7 +100,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1StringValue.html b/docs/classHazelnp_1_1StringValue.html index 33bb35c..a660cfa 100644 --- a/docs/classHazelnp_1_1StringValue.html +++ b/docs/classHazelnp_1_1StringValue.html @@ -547,7 +547,7 @@ Additional Inherited Members
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
diff --git a/docs/classHazelnp_1_1Value-members.html b/docs/classHazelnp_1_1Value-members.html index f599f0d..a498717 100644 --- a/docs/classHazelnp_1_1Value-members.html +++ b/docs/classHazelnp_1_1Value-members.html @@ -97,7 +97,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1Value.html b/docs/classHazelnp_1_1Value.html index f94d65b..65272bc 100644 --- a/docs/classHazelnp_1_1Value.html +++ b/docs/classHazelnp_1_1Value.html @@ -548,7 +548,7 @@ Friends
DATA_TYPE type
Definition: Value.h:48
diff --git a/docs/classHazelnp_1_1VoidValue-members.html b/docs/classHazelnp_1_1VoidValue-members.html index 6e3f5af..c75d443 100644 --- a/docs/classHazelnp_1_1VoidValue-members.html +++ b/docs/classHazelnp_1_1VoidValue-members.html @@ -98,7 +98,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1VoidValue.html b/docs/classHazelnp_1_1VoidValue.html index c066260..96561e7 100644 --- a/docs/classHazelnp_1_1VoidValue.html +++ b/docs/classHazelnp_1_1VoidValue.html @@ -493,7 +493,7 @@ Additional Inherited Members
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
diff --git a/docs/classes.html b/docs/classes.html index a676677..698cc02 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -119,7 +119,7 @@ $(function() { diff --git a/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html b/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html index 33ad36e..9e40212 100644 --- a/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html +++ b/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html @@ -136,7 +136,7 @@ Files diff --git a/docs/dir_0cc5f59b28c403d42cc56800132eb975.html b/docs/dir_0cc5f59b28c403d42cc56800132eb975.html index f346fae..ffcbc4d 100644 --- a/docs/dir_0cc5f59b28c403d42cc56800132eb975.html +++ b/docs/dir_0cc5f59b28c403d42cc56800132eb975.html @@ -81,7 +81,7 @@ $(function() { diff --git a/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html b/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html index 1848835..57ed724 100644 --- a/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html +++ b/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html @@ -81,7 +81,7 @@ $(function() { diff --git a/docs/dir_a8cffda729361e9d9637effa362fcea9.html b/docs/dir_a8cffda729361e9d9637effa362fcea9.html index b3346c8..3355d50 100644 --- a/docs/dir_a8cffda729361e9d9637effa362fcea9.html +++ b/docs/dir_a8cffda729361e9d9637effa362fcea9.html @@ -81,7 +81,7 @@ $(function() { diff --git a/docs/files.html b/docs/files.html index 992ca35..40b4d33 100644 --- a/docs/files.html +++ b/docs/files.html @@ -107,7 +107,7 @@ $(function() { diff --git a/docs/functions.html b/docs/functions.html index e28ca04..6fa5030 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -400,7 +400,7 @@ $(function() { diff --git a/docs/functions_func.html b/docs/functions_func.html index f88c8a2..0bf0d6a 100644 --- a/docs/functions_func.html +++ b/docs/functions_func.html @@ -371,7 +371,7 @@ $(function() { diff --git a/docs/functions_rela.html b/docs/functions_rela.html index 9ef9c62..c166e5c 100644 --- a/docs/functions_rela.html +++ b/docs/functions_rela.html @@ -79,7 +79,7 @@ $(function() { diff --git a/docs/functions_vars.html b/docs/functions_vars.html index f1ccee6..5365ca9 100644 --- a/docs/functions_vars.html +++ b/docs/functions_vars.html @@ -96,7 +96,7 @@ $(function() { diff --git a/docs/globals.html b/docs/globals.html index d609643..a2050de 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -78,7 +78,7 @@ $(function() { diff --git a/docs/globals_func.html b/docs/globals_func.html index 5251efb..ab9951d 100644 --- a/docs/globals_func.html +++ b/docs/globals_func.html @@ -78,7 +78,7 @@ $(function() { diff --git a/docs/graph_legend.html b/docs/graph_legend.html index 69bf1a6..85ffe4e 100644 --- a/docs/graph_legend.html +++ b/docs/graph_legend.html @@ -137,7 +137,7 @@ A yellow dashed arrow denotes a relation between a template instance and the tem diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 4010523..8086813 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -100,7 +100,7 @@ This inheritance list is sorted roughly, but not completely, alphabetically: diff --git a/docs/index.html b/docs/index.html index c5a4f02..ff62556 100644 --- a/docs/index.html +++ b/docs/index.html @@ -125,10 +125,11 @@ What's the concept?

Minimal working example

So what's the simplest way to use Hazelnupp to work with command-line parameters? See:

#include "Hazelnupp.h"
+
using namespace Hazelnp;
int main(int argc, char** argv)
{
-
Hazelnupp args(argc, argv);
+
Hazelnupp args(argc, argv);
if (args.HasParam("--force"))
// do forced
@@ -138,19 +139,20 @@ Minimal working example
return 0;
}

Looks super easy! But what about actual values?

#include "Hazelnupp.h"
+
using namespace Hazelnp;
int main(int argc, char** argv)
{
-
Hazelnupp args(argc, argv);
+
Hazelnupp args(argc, argv);
// Either check via HasParam(), or do a try-catch
try
{
int myInt = args["--my-int"].GetInt32();
-
double myInt = args["--my-float"].GetFloat32();
+
double myFlt = args["--my-float"].GetFloat32();
std::string myStr = args["--my-string"].GetString();
}
-
catch (HazelnuppInvalidKeyException&)
+
{
return -1;
}
@@ -158,10 +160,11 @@ Minimal working example
return 0;
}

What about lists?

#include "Hazelnupp.h"
+
using namespace Hazelnp;
int main(int argc, char** argv)
{
-
Hazelnupp args(argc, argv);
+
Hazelnupp args(argc, argv);
const auto& myList = args["--my-list"].GetList(); // std::vector<Value*>
@@ -176,18 +179,19 @@ Minimal working example

Abbreviations

Abbreviations are a very important part of command line arguments. Like, typing -f instead of --force. Here's how to use them in Hazelnupp:

#include "Hazelnupp.h"
+
using namespace Hazelnp;
int main(int argc, char** argv)
{
-
Hazelnupp args;
+
Hazelnupp args;
// Register abbreviations
-
args.RegisterAbbreviation("-f", "--force");
+
args.RegisterAbbreviation("-f", "--force");
// Parse
-
args.Parse(argc, argv);
+
args.Parse(argc, argv);
-
if (args.HasParam("--force")) // This key will be present, even if the user passed '-f'
+
if (args.HasParam("--force")) // This key will be present, even if the user passed '-f'
// do forced
else
// be gentle
@@ -208,19 +212,20 @@ Requiring data
  • If a parameter is not present, and has no default value, an exception will be thrown.
  • Minimal working example:

    #include "Hazelnupp.h"
    +
    using namespace Hazelnp;
    int main(int argc, char** argv)
    {
    -
    Hazelnupp args;
    +
    Hazelnupp args;
    // Register constraints
    -
    args.RegisterConstraints({
    -
    ParamConstraint::Require("--this-is-required"), // This missing throws an exception
    -
    ParamConstraint::Require("--also-required-but-defaulted", {"122"}), // This will default to 122
    + +
    ParamConstraint::Require("--this-is-required"), // This missing throws an exception
    +
    ParamConstraint::Require("--also-required-but-defaulted", {"122"}), // This will default to 122
    });
    // Parse
    -
    args.Parse(argc, argv);
    +
    args.Parse(argc, argv);
    return 0;
    }
    @@ -240,18 +245,19 @@ Type safety

    The conversions *->list just create a list with a single entry (except for void->list which produces an empty list).
    The *->void conversions just drop their value.

    Minimal working example:

    #include "Hazelnupp.h"
    +
    using namespace Hazelnp;
    int main(int argc, char** argv)
    {
    -
    Hazelnupp args;
    +
    Hazelnupp args;
    // Register constraints
    -
    args.RegisterConstraints({
    -
    ParamConstraint::TypeSafety("--this-must-be-int", DATA_TYPE::INT)
    + +
    });
    // Parse
    -
    args.Parse(argc, argv);
    +
    args.Parse(argc, argv);
    return 0;
    }
    @@ -264,7 +270,7 @@ Type safety
    pc.defaultValue = {}; // no default value
    pc.required = true;
    -
    args.RegisterConstraints({pc});
    +

    What doesn't work is inserting multiple constraints for one key. It will just discard the oldest one. But that's okay because one can describe all possible constraints for a single key in one struct.

    More examples?

    @@ -295,11 +301,21 @@ LICENSE
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    +
    Definition: DataType.h:3
    +
    Gets thrown when an non-existent key gets dereferenced.
    +
    The main class to interface with.
    Definition: Hazelnupp.h:11
    int main(int argc, char **argv)
    Definition: main.cpp:7
    +
    bool HasParam(const std::string &key) const
    Will check wether a parameter exists given a key, or not.
    Definition: Hazelnupp.cpp:153
    +
    void Parse(const int argc, const char *const *argv)
    Will parse command line arguments.
    Definition: Hazelnupp.cpp:35
    +
    void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
    Will register an abbreviation (like -f for –force)
    Definition: Hazelnupp.cpp:332
    +
    void RegisterConstraints(const std::vector< ParamConstraint > &constraints)
    Will register parameter constraints.
    Definition: Hazelnupp.cpp:354
    +
    static ParamConstraint Require(const std::string &key, const std::vector< std::string > &defaultValue={}, bool required=true)
    Constructs a require constraint.
    +
    @ INT
    +
    static ParamConstraint TypeSafety(const std::string &key, DATA_TYPE wantedType, bool constrainType=true)
    Constructs a type-safety constraint.
    diff --git a/docs/index_8md.html b/docs/index_8md.html index 7fada0c..9d49f6b 100644 --- a/docs/index_8md.html +++ b/docs/index_8md.html @@ -77,7 +77,7 @@ $(function() { diff --git a/docs/inherits.html b/docs/inherits.html index d946ad0..acf5a17 100644 --- a/docs/inherits.html +++ b/docs/inherits.html @@ -122,7 +122,7 @@ $(function() { diff --git a/docs/main_8cpp.html b/docs/main_8cpp.html index 836c38b..0b70fc5 100644 --- a/docs/main_8cpp.html +++ b/docs/main_8cpp.html @@ -210,7 +210,7 @@ Functions
    std::vector< std::string > defaultValue
    The default value for this parameter.
    diff --git a/docs/main_8cpp_source.html b/docs/main_8cpp_source.html index 5c9ed6e..861193c 100644 --- a/docs/main_8cpp_source.html +++ b/docs/main_8cpp_source.html @@ -159,7 +159,7 @@ $(function() {
    std::vector< std::string > defaultValue
    The default value for this parameter.
    diff --git a/docs/namespaceHazelnp.html b/docs/namespaceHazelnp.html index 922618b..08eac6b 100644 --- a/docs/namespaceHazelnp.html +++ b/docs/namespaceHazelnp.html @@ -190,7 +190,7 @@ Enumerations
    @ STRING
    diff --git a/docs/namespacemembers.html b/docs/namespacemembers.html index f506c2b..1021939 100644 --- a/docs/namespacemembers.html +++ b/docs/namespacemembers.html @@ -78,7 +78,7 @@ $(function() { diff --git a/docs/namespacemembers_enum.html b/docs/namespacemembers_enum.html index ca64a6b..4bffb79 100644 --- a/docs/namespacemembers_enum.html +++ b/docs/namespacemembers_enum.html @@ -78,7 +78,7 @@ $(function() { diff --git a/docs/namespaces.html b/docs/namespaces.html index acd14bf..0dc3529 100644 --- a/docs/namespaces.html +++ b/docs/namespaces.html @@ -82,7 +82,7 @@ $(function() { diff --git a/docs/structHazelnp_1_1ParamConstraint-members.html b/docs/structHazelnp_1_1ParamConstraint-members.html index 6ad1229..1e9c4a4 100644 --- a/docs/structHazelnp_1_1ParamConstraint-members.html +++ b/docs/structHazelnp_1_1ParamConstraint-members.html @@ -93,7 +93,7 @@ $(function() { diff --git a/docs/structHazelnp_1_1ParamConstraint.html b/docs/structHazelnp_1_1ParamConstraint.html index dfb7960..f32cf05 100644 --- a/docs/structHazelnp_1_1ParamConstraint.html +++ b/docs/structHazelnp_1_1ParamConstraint.html @@ -451,7 +451,7 @@ Public Attributes
    std::vector< std::string > defaultValue
    The default value for this parameter.