GitHub-Proxy/Slic3r
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/slic3r/Slic3r.git synced 2025-08-14 15:45:56 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Finished converting Config.hpp comments to doxygen

Browse Source
This commit is contained in:
Joseph Lenox 2017-05-16 19:53:38 -05:00
parent 05c2493b0e
commit 28214209f6
1 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
xs/src/libslic3r/Config.hpp
View File

@ -15,7 +15,7 @@
namespace Slic3r { namespace Slic3r {
// Name of the configuration option. /// Name of the configuration option.
typedef std::string t_config_option_key; typedef std::string t_config_option_key;
typedef std::vector<std::string> t_config_option_keys; typedef std::vector<std::string> t_config_option_keys;
@ -63,7 +63,7 @@ class ConfigOptionVectorBase : public ConfigOption {
virtual std::vector<std::string> vserialize() const = 0; virtual std::vector<std::string> vserialize() const = 0;
}; };
// Value of a vector valued option (bools, ints, floats, strings, points), template /// Value of a vector valued option (bools, ints, floats, strings, points), template
template <class T> template <class T>
class ConfigOptionVector : public ConfigOptionVectorBase class ConfigOptionVector : public ConfigOptionVectorBase
{ {
@ -454,7 +454,7 @@ class ConfigOptionBools : public ConfigOptionVector<bool>
}; };
}; };
// Map from an enum name to an enum integer value. /// Map from an enum name to an enum integer value.
typedef std::map<std::string,int> t_config_enum_values; typedef std::map<std::string,int> t_config_enum_values;
template <class T> template <class T>
@ -481,7 +481,7 @@ class ConfigOptionEnum : public ConfigOptionSingle<T>
return true; return true;
}; };
// Map from an enum name to an enum integer value. /// Map from an enum name to an enum integer value.
//FIXME The map is called often, it shall be initialized statically. //FIXME The map is called often, it shall be initialized statically.
static t_config_enum_values get_enum_values(); static t_config_enum_values get_enum_values();
}; };
@ -534,13 +534,13 @@ enum ConfigOptionType {
coPoint3, coPoint3,
/// single boolean value /// single boolean value
coBool, coBool,
// vector of boolean values /// vector of boolean values
coBools, coBools,
/// a generic enum /// a generic enum
coEnum, coEnum,
}; };
// Definition of a configuration value for the purpose of GUI presentation, editing, value mapping and config file handling. /// Definition of a configuration value for the purpose of GUI presentation, editing, value mapping and config file handling.
class ConfigOptionDef class ConfigOptionDef
{ {
public: public:
@ -616,14 +616,14 @@ class ConfigOptionDef
ConfigOptionDef& operator= (ConfigOptionDef other); ConfigOptionDef& operator= (ConfigOptionDef other);
}; };
// Map from a config option name to its definition. /// Map from a config option name to its definition.
// The definition does not carry an actual value of the config option, only its constant default value. //i The definition does not carry an actual value of the config option, only its constant default value.
// t_config_option_key is std::string //i t_config_option_key is std::string
typedef std::map<t_config_option_key,ConfigOptionDef> t_optiondef_map; typedef std::map<t_config_option_key,ConfigOptionDef> t_optiondef_map;
// Definition of configuration values for the purpose of GUI presentation, editing, value mapping and config file handling. /// Definition of configuration values for the purpose of GUI presentation, editing, value mapping and config file handling.
// The configuration definition is static: It does not carry the actual configuration values, /// The configuration definition is static: It does not carry the actual configuration values,
// but it carries the defaults of the configuration values. /// but it carries the defaults of the configuration values.
class ConfigDef class ConfigDef
{ {
public: public:
@ -635,14 +635,14 @@ class ConfigDef
void merge(const ConfigDef &other); void merge(const ConfigDef &other);
}; };
// An abstract configuration store. /// An abstract configuration store.
class ConfigBase class ConfigBase
{ {
public: public:
// Definition of configuration values for the purpose of GUI presentation, editing, value mapping and config file handling. /// Definition of configuration values for the purpose of GUI presentation, editing, value mapping and config file handling.
// The configuration definition is static: It does not carry the actual configuration values, /// The configuration definition is static: It does not carry the actual configuration values,
// but it carries the defaults of the configuration values. /// but it carries the defaults of the configuration values.
// ConfigBase does not own ConfigDef, it only references it. /// ConfigBase does not own ConfigDef, it only references it.
const ConfigDef* def; const ConfigDef* def;
ConfigBase() : def(NULL) {}; ConfigBase() : def(NULL) {};
@ -672,8 +672,8 @@ class ConfigBase
void save(const std::string &file) const; void save(const std::string &file) const;
}; };
// Configuration store with dynamic number of configuration values. /// Configuration store with dynamic number of configuration values.
// In Slic3r, the dynamic config is mostly used at the user interface layer. /// In Slic3r, the dynamic config is mostly used at the user interface layer.
class DynamicConfig : public virtual ConfigBase class DynamicConfig : public virtual ConfigBase
{ {
public: public:
@ -696,20 +696,20 @@ class DynamicConfig : public virtual ConfigBase
t_options_map options; t_options_map options;
}; };
// Configuration store with a static definition of configuration values. /// Configuration store with a static definition of configuration values.
// In Slic3r, the static configuration stores are during the slicing / g-code generation for efficiency reasons, /// In Slic3r, the static configuration stores are during the slicing / g-code generation for efficiency reasons,
// because the configuration values could be accessed directly. /// because the configuration values could be accessed directly.
class StaticConfig : public virtual ConfigBase class StaticConfig : public virtual ConfigBase
{ {
public: public:
StaticConfig() : ConfigBase() {}; StaticConfig() : ConfigBase() {};
// Gets list of config option names for each config option of this->def, which has a static counter-part defined by the derived object /// Gets list of config option names for each config option of this->def, which has a static counter-part defined by the derived object
// and which could be resolved by this->optptr(key) call. /// and which could be resolved by this->optptr(key) call.
t_config_option_keys keys() const; t_config_option_keys keys() const;
// Set all statically defined config options to their defaults defined by this->def. /// Set all statically defined config options to their defaults defined by this->def.
void set_defaults(); void set_defaults();
// The derived class has to implement optptr to resolve a static configuration value. /// The derived class has to implement optptr to resolve a static configuration value.
// virtual ConfigOption* optptr(const t_config_option_key &opt_key, bool create = false) = 0; /// virtual ConfigOption* optptr(const t_config_option_key &opt_key, bool create = false) = 0;
}; };
class UnknownOptionException : public std::exception {}; class UnknownOptionException : public std::exception {};