Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
partons
core
elementary-utils
Commits
538d3497
Commit
538d3497
authored
Jul 25, 2017
by
Hervé Moutarde
Browse files
Update of documentation in GenericType.h, Parameter.h and Parameters.h.
The doxygen @brief is either added or given further details
parent
08989364
Changes
3
Hide whitespace changes
Inline
Side-by-side
include/ElementaryUtils/parameters/GenericType.h
View file @
538d3497
...
@@ -19,9 +19,13 @@ namespace ElemUtils {
...
@@ -19,9 +19,13 @@ namespace ElemUtils {
/**
/**
* @class GenericType
* @class GenericType
*
*
* @brief A complex object to handle different simple types (like string, int, double, bool ...) into a unique stream.
* @brief A complex object to handle different simple types in a uniform way.
* It provides a way to handle a generic type.
* Simple types considered: double, int, unsigned int, boolean, short, unsigned short, string, etc.
* There is a method for each simple type that you want to get back.
* Various simple types are stored into a unique stream, providing a way to handle a generic type.
* Each simple type can be retrieved from the stream using an appropriate method.
* For example toInt() or toDouble() return respectively int or double variables.
*
* Warning: a generic type object can be defined from any class, but the adequate conversion function may have to be added.
*/
*/
class
GenericType
{
class
GenericType
{
public:
public:
...
...
include/ElementaryUtils/parameters/Parameter.h
View file @
538d3497
...
@@ -16,6 +16,9 @@ namespace ElemUtils {
...
@@ -16,6 +16,9 @@ namespace ElemUtils {
/**
/**
* @class Parameter
* @class Parameter
*
* @brief A piece of data of generic type which is given a simply readable name (a string variable).
* As it is the case for GenericType, a parameter can be defined from any class.
*/
*/
class
Parameter
:
public
GenericType
{
class
Parameter
:
public
GenericType
{
public:
public:
...
...
include/ElementaryUtils/parameters/Parameters.h
View file @
538d3497
...
@@ -19,7 +19,8 @@ namespace ElemUtils {
...
@@ -19,7 +19,8 @@ namespace ElemUtils {
/**
/**
* @class Parameters
* @class Parameters
*
*
* @brief
* @brief Object defining a list of pieces of data (of common Parameter type).
* Each member of the list is uniquely identified by its name.
*/
*/
class
Parameters
{
class
Parameters
{
public:
public:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment