diff --git a/src/ebusd/baseloop.h b/src/ebusd/baseloop.h index 03de7c69..20cb833c 100644 --- a/src/ebusd/baseloop.h +++ b/src/ebusd/baseloop.h @@ -24,19 +24,21 @@ #include "network.h" #include "busloop.h" +/** \file baseloop.h */ + /** possible client commands */ enum CommandType { - ct_get, // get ebus data - ct_set, // set ebus value - ct_cyc, // fetch cycle data - ct_hex, // send hex value - ct_scan, // scan ebus - ct_log, // logger settings - ct_raw, // toggle log raw data - ct_dump, // toggle dump state - ct_reload, // reload ebus configuration - ct_help, // print commands - ct_invalid, // invalid + ct_get, /*!< get ebus data */ + ct_set, /*!< set ebus value */ + ct_cyc, /*!< fetch cycle data */ + ct_hex, /*!< send hex value */ + ct_scan, /*!< scan ebus */ + ct_log, /*!< logger settings */ + ct_raw, /*!< toggle log raw data */ + ct_dump, /*!< toggle dump state */ + ct_reload, /*!< reload ebus configuration */ + ct_help, /*!< print commands */ + ct_invalid /*!< invalid */ }; /** diff --git a/src/ebusd/busloop.h b/src/ebusd/busloop.h index 0e609dbb..bc0f56b4 100644 --- a/src/ebusd/busloop.h +++ b/src/ebusd/busloop.h @@ -27,15 +27,17 @@ #include "symbol.h" #include "result.h" +/** \file busloop.h */ + /** the maximum time [us] allowed for retrieving a byte from an addressed slave */ #define RECV_TIMEOUT 10000 /** possible bus command types */ enum BusCommandType { - invalid, // invalid command type - broadcast, // broadcast - masterMaster, // master - master - masterSlave, // master - slave + invalid, /*!< invalid command type */ + broadcast, /*!< broadcast */ + masterMaster, /*!< master - master */ + masterSlave /*!< master - slave */ }; /** diff --git a/src/lib/ebus/configfile.h b/src/lib/ebus/configfile.h index b5160fc3..8fb82c1b 100644 --- a/src/lib/ebus/configfile.h +++ b/src/lib/ebus/configfile.h @@ -24,9 +24,11 @@ #include #include +/** \file configfile.h */ + /** available file endings / types. */ enum FileType { - ft_csv // CSV + ft_csv /*!< CSV */ }; /** diff --git a/src/lib/ebus/port.h b/src/lib/ebus/port.h index 13deb6a7..31724946 100644 --- a/src/lib/ebus/port.h +++ b/src/lib/ebus/port.h @@ -25,10 +25,12 @@ #include #include +/** \file port.h */ + /** available device types. */ enum DeviceType { - dt_serial, // serial device - dt_network // network device + dt_serial, /*!< serial device */ + dt_network /*!< network device */ }; /** max bytes write to bus. */ diff --git a/src/lib/utils/appl.h b/src/lib/utils/appl.h index 186164cd..39e6037c 100644 --- a/src/lib/utils/appl.h +++ b/src/lib/utils/appl.h @@ -25,21 +25,23 @@ #include #include +/** \file appl.h */ + /** the available data types. */ enum DataType { - dt_none, // default for __text_only__ - dt_bool, // boolean - dt_int, // integer - dt_long, // long - dt_float, // float - dt_string // string + dt_none, /*!< default for __text_only__ */ + dt_bool, /*!< boolean */ + dt_int, /*!< integer */ + dt_long, /*!< long */ + dt_float, /*!< float */ + dt_string /*!< string */ }; /** option types. */ enum OptionType { - ot_none, // no option type is needed - ot_optional, // a value is optional - ot_mandatory // a value is mandatory + ot_none, /*!< no option type is needed */ + ot_optional, /*!< a value is optional */ + ot_mandatory /*!< a value is mandatory */ }; /** structure for defining application options */ diff --git a/src/lib/utils/logger.h b/src/lib/utils/logger.h index 9d17c50f..354a8887 100644 --- a/src/lib/utils/logger.h +++ b/src/lib/utils/logger.h @@ -28,23 +28,25 @@ #include #include +/** \file logger.h */ + /** available types for all subsystems */ enum AreasType { - bas=1, // basis - net=2, // network - bus=4, // ebus - cyc=8, // cycle - all=15, // type for all subsystems - Size_of_Areas=4 // number of possible areas + bas=1, /*!< basis */ + net=2, /*!< network */ + bus=4, /*!< ebus */ + cyc=8, /*!< cycle */ + all=15, /*!< type for all subsystems */ + Size_of_Areas=4 /*!< number of possible areas */ }; /** available logging levels */ enum LevelType { - error=0, // silent run, only errors will be printed - event, // only interesting message for normal use - trace, // most of the information for normal use - debug, // print internal states too - Size_of_Level // number of possible levels + error=0, /*!< silent run, only errors will be printed */ + event, /*!< only interesting message for normal use */ + trace, /*!< most of the information for normal use */ + debug, /*!< print internal states too */ + Size_of_Level /*!< number of possible levels */ }; /** global function to get calculate logging areas */