Commit 538d3497 authored by Hervé Moutarde's avatar 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
......@@ -19,9 +19,13 @@ namespace ElemUtils {
/**
* @class GenericType
*
* @brief A complex object to handle different simple types (like string, int, double, bool ...) into a unique stream.
* It provides a way to handle a generic type.
* There is a method for each simple type that you want to get back.
* @brief A complex object to handle different simple types in a uniform way.
* Simple types considered: double, int, unsigned int, boolean, short, unsigned short, string, etc.
* 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 {
public:
......
......@@ -16,6 +16,9 @@ namespace ElemUtils {
/**
* @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 {
public:
......
......@@ -19,7 +19,8 @@ namespace ElemUtils {
/**
* @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 {
public:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment