fixed documentation

This commit is contained in:
john30
2015-05-14 13:05:19 +02:00
parent 071d57f957
commit 39c00de51e
3 changed files with 4 additions and 3 deletions
-2
View File
@@ -75,8 +75,6 @@ public:
/**
* Add request data received from the client.
* @param request the request data from the client.
* @param listening whether the client is in listening mode.
* @param listenSince start timestamp of listening update.
* @return true when the request is complete and the response shall be prepared.
*/
bool add(string request)
+2 -1
View File
@@ -359,8 +359,9 @@ protected:
/**
* Internal method for reading the field from a @a SymbolString.
* @param input the unescaped @a SymbolString to read the binary value from.
* @param offset the offset in the @a SymbolString.
* @param baseOffset the base offset in the @a SymbolString.
* @param output the ostringstream to append the formatted value to.
* @param dataFormat the @a DataFormat to use.
* @return @a RESULT_OK on success, or an error code.
*/
virtual result_t readSymbols(SymbolString& input, const unsigned char baseOffset,
+2
View File
@@ -195,6 +195,7 @@ public:
* Construct a new instance.
* @param name the device name (e.g. "/dev/ttyUSB0" for serial, "127.0.0.1:1234" for network).
* @param checkDevice whether to regularly check the device availability (only for serial devices).
* @param readonly whether to allow read access to the device only.
* @param logRawFunc the function to call for logging raw data, or NULL.
*/
SerialDevice(const char* name, const bool checkDevice, const bool readonly,
@@ -227,6 +228,7 @@ public:
* Construct a new instance.
* @param name the device name (e.g. "/dev/ttyUSB0" for serial, "127.0.0.1:1234" for network).
* @param address the socket address of the device.
* @param readonly whether to allow read access to the device only.
* @param logRawFunc the function to call for logging raw data, or NULL.
*/
NetworkDevice(const char* name, const struct sockaddr_in address, const bool readonly,