Socket: Add short docs to internal classes

[senf.git] / Socket / SocketProtocol.hh

diff --git a/Socket/SocketProtocol.hh b/Socket/SocketProtocol.hh
index 24a8ff8..1f962e3 100644 (file)
--- a/Socket/SocketProtocol.hh
+++ b/Socket/SocketProtocol.hh
@@ -155,7 +155,9 @@ namespace senf {
                                         /**< This member will check in a (very, sigh) protocol
                                              dependent way, how many bytes are guaranteed to be
                                              readable from the socket without blocking even if the
-                                             socket is blocking. */
+                                             socket is blocking. If the socket does not support
+                                             reading (viz. NotReadablePolicy is set), this member
+                                             should always return \c 0.*/
 
         virtual bool eof() const = 0;   ///< Check for end-of-file condition
                                         /**< This is another check which (like available()) is
@@ -278,4 +280,5 @@ namespace senf {
 // indent-tabs-mode: nil
 // ispell-local-dictionary: "american"
 // compile-command: "scons -u test"
+// comment-column: 40
 // End: