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