doxygen option '\file' added.

This commit is contained in:
Roland Jax
2014-11-22 20:00:27 +01:00
parent 59d4907223
commit b593af967a
6 changed files with 50 additions and 38 deletions
+13 -11
View File
@@ -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 */
};
/**
+6 -4
View File
@@ -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 */
};
/**
+3 -1
View File
@@ -24,9 +24,11 @@
#include <string>
#include <vector>
/** \file configfile.h */
/** available file endings / types. */
enum FileType {
ft_csv // CSV
ft_csv /*!< CSV */
};
/**
+4 -2
View File
@@ -25,10 +25,12 @@
#include <termios.h>
#include <unistd.h>
/** \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. */
+11 -9
View File
@@ -25,21 +25,23 @@
#include <map>
#include <vector>
/** \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 */
+13 -11
View File
@@ -28,23 +28,25 @@
#include <vector>
#include <cstdarg>
/** \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 */