From 8b04eb3d28c7797a7ca3bc6088b129b5fac7e443 Mon Sep 17 00:00:00 2001 From: john Date: Sun, 16 Sep 2018 19:54:28 +0200 Subject: [PATCH] better documentation --- src/lib/ebus/device.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/lib/ebus/device.h b/src/lib/ebus/device.h index 8a2ede7e..050c1e1d 100755 --- a/src/lib/ebus/device.h +++ b/src/lib/ebus/device.h @@ -76,7 +76,7 @@ class Device { /** * 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 checkDevice whether to regularly check the device availability. * @param readOnly whether to allow read access to the device only. * @param initialSend whether to send an initial @a ESC symbol in @a open(). * @param enhancedProto whether to use the ebusd enhanced protocol. @@ -200,7 +200,7 @@ class Device { /** the device name (e.g. "/dev/ttyUSB0" for serial, "127.0.0.1:1234" for network). */ const char* m_name; - /** whether to regularly check the device availability (only for serial devices). */ + /** whether to regularly check the device availability. */ const bool m_checkDevice; /** whether to allow read access to the device only. */ @@ -248,7 +248,7 @@ class SerialDevice : public Device { /** * 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 checkDevice whether to regularly check the device availability. * @param readOnly whether to allow read access to the device only. * @param initialSend whether to send an initial @a ESC symbol in @a open(). * @param enhancedProto whether to use the ebusd enhanced protocol.