diff --git a/src/ebusd/bushandler.h b/src/ebusd/bushandler.h index 43a554ed..ff4a6a3d 100644 --- a/src/ebusd/bushandler.h +++ b/src/ebusd/bushandler.h @@ -31,7 +31,13 @@ #include #include -/** \file bushandler.h */ +/** @file bushandler.h + * Classes, functions, and constants related to handling of symbols on the eBUS. + * + * The following table shows the possible states, symbols, and state transition + * depending on the kind of message to send/receive: + * @image html states.png "ebusd BusHandler states" + */ using namespace std; diff --git a/src/ebusd/states.png b/src/ebusd/states.png new file mode 100644 index 00000000..1a9cc6e7 Binary files /dev/null and b/src/ebusd/states.png differ diff --git a/src/lib/ebus/device.h b/src/lib/ebus/device.h index ff275b38..6dcb6579 100644 --- a/src/lib/ebus/device.h +++ b/src/lib/ebus/device.h @@ -26,7 +26,14 @@ #include #include "result.h" -/** \file device.h */ +/** @file device.h + * Classes providing access to the eBUS. + * + * A @a Device is either a @a SerialDevice directly connected to a local tty + * port or a remote @a NetworkDevice handled via a TCP socket. It allows to + * send and receive bytes to/from the eBUS while optionally dumping the data + * to a file and/or forwarding it to a logging function. + */ using namespace std;