added more comments

This commit is contained in:
Leonetienne 2021-06-03 11:32:00 +02:00
parent 9d543367bf
commit 781e046122
10 changed files with 22 additions and 5 deletions

View File

@ -1,5 +1,7 @@
#pragma once
/** The different data types a paramater can be
*/
enum class DATA_TYPE
{
VOID,

View File

@ -2,6 +2,8 @@
#include "Value.h"
#include <ostream>
/** Specializations for floating point values (uses long double)
*/
class FloatValue : public Value
{
public:

View File

@ -4,6 +4,8 @@
#include <unordered_map>
#include <vector>
/** The main class to interface with
*/
class Hazelnupp
{
public:

View File

@ -1,6 +1,8 @@
#pragma once
#include "Value.h"
/** Specializations for integer values (uses long long int)
*/
class IntValue : public Value
{
public:

View File

@ -2,6 +2,8 @@
#include "Value.h"
#include <vector>
/** Specializations for list values (uses std::vector<Value*>)
*/
class ListValue : public Value
{
public:

View File

@ -9,7 +9,8 @@ public:
//! Empty constructor
ParamConstraint() = default;
//! Constructs a require constraint
//! Constructs a require constraint.
//! Think of the default value like of a list ofparameters. Like {"--width", "800"}
static ParamConstraint Require(const std::string& key, const std::vector<std::string>& defaultValue = {}, bool required = true)
{
ParamConstraint pc;
@ -54,7 +55,8 @@ public:
DATA_TYPE wantedType = DATA_TYPE::VOID;
//! The default value for this parameter.
//! Gets applied if this parameter was not given.
//! Gets applied if this parameter was not given.
//! Think of this like a list of parameters. Like {"--width", "800"}
std::vector<std::string> defaultValue;
//! If set to true, and no default value set,

View File

@ -4,9 +4,8 @@
#include <vector>
#include <cmath>
/// <summary>
/// Internal helper class. Feel free to use it tho, lol
/// </summary>
/** Internal helper class. Feel free to use it tho.
*/
class StringTools
{
public:

View File

@ -2,6 +2,8 @@
#include "Value.h"
#include <string>
/** Specializations for string values (uses std::string)
*/
class StringValue : public Value
{
public:

View File

@ -3,6 +3,8 @@
#include <ostream>
#include <vector>
/** Abstract class for values
*/
class Value
{
public:

View File

@ -1,6 +1,8 @@
#pragma once
#include "Value.h"
/** Specializations for void values. These house no value whatsoever, but only communicate information by merely existing.
*/
class VoidValue : public Value
{
public: