missing documentation added.
This commit is contained in:
@@ -26,7 +26,7 @@
|
||||
|
||||
/** available file endings / types. */
|
||||
enum FileType {
|
||||
ft_csv
|
||||
ft_csv // CSV
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -51,7 +51,7 @@ public:
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief class for CSV config files.
|
||||
* @brief derived class for CSV config files.
|
||||
*/
|
||||
class ConfigFileCSV : public ConfigFile
|
||||
{
|
||||
@@ -72,7 +72,7 @@ public:
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief class for class device.
|
||||
* @brief class to parse configuration files and store into commands instance.
|
||||
*/
|
||||
class ConfigCommands
|
||||
{
|
||||
@@ -81,7 +81,7 @@ public:
|
||||
/**
|
||||
* @brief set file type and add recursive files from given path.
|
||||
* @param path to configuration files.
|
||||
* @param filetype to parse.
|
||||
* @param type to parse.
|
||||
*/
|
||||
ConfigCommands(const std::string path, const FileType type);
|
||||
|
||||
@@ -92,7 +92,7 @@ public:
|
||||
|
||||
/**
|
||||
* @brief setter for file type.
|
||||
* @param filetype of files.
|
||||
* @param type of files.
|
||||
*/
|
||||
void setType(const FileType type);
|
||||
|
||||
|
||||
+3
-3
@@ -27,8 +27,8 @@
|
||||
|
||||
/** available device types. */
|
||||
enum DeviceType {
|
||||
dt_serial,
|
||||
dt_network,
|
||||
dt_serial, // serial device
|
||||
dt_network // network device
|
||||
};
|
||||
|
||||
/** max bytes write to bus. */
|
||||
@@ -83,7 +83,7 @@ public:
|
||||
|
||||
/**
|
||||
* @brief recvBytes read bytes from opened file descriptor.
|
||||
* @param timeoutmax time for new input data [usec].
|
||||
* @param timeout time for new input data [usec].
|
||||
* @param maxCount max size of receive buffer.
|
||||
* @return number of read bytes or -1 if an error has occured.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user