added documentation
This commit is contained in:
@@ -31,7 +31,13 @@
|
||||
#include <map>
|
||||
#include <pthread.h>
|
||||
|
||||
/** \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;
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 115 KiB |
@@ -26,7 +26,14 @@
|
||||
#include <netdb.h>
|
||||
#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;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user