Logging: Adapted the `logger' utility to the new numbering of levels.

[libucw.git] / ucw / fb-socket.h

diff --git a/ucw/fb-socket.h b/ucw/fb-socket.h
index b80086048acd24c835d8d32b14c078d94fcec7d3..c9f6806bf05df792aa7b21de57a52a2121ea1ce4 100644 (file)
--- a/ucw/fb-socket.h
+++ b/ucw/fb-socket.h
@@ -12,7 +12,7 @@
 
 #include "ucw/fastbuf.h"
 
 
 #include "ucw/fastbuf.h"
 

-struct fbsock_params {
+struct fbsock_params { /** Configuration of socket fastbuf. **/

   int fd;
   uns bufsize;
   uns timeout_ms;
   int fd;
   uns bufsize;
   uns timeout_ms;


@@ -20,12 +20,16 @@ struct fbsock_params {
   void *data;                  // Passed to the err callback
 };
 
   void *data;                  // Passed to the err callback
 };
 

-enum fbsock_err_flags {
+enum fbsock_err_flags {        /** Description of a socket error **/

   FBSOCK_READ = 1,             // Happened during read
   FBSOCK_WRITE = 2,            // Happened during write
   FBSOCK_TIMEOUT = 4,          // The error is a timeout
 };
 
   FBSOCK_READ = 1,             // Happened during read
   FBSOCK_WRITE = 2,            // Happened during write
   FBSOCK_TIMEOUT = 4,          // The error is a timeout
 };
 

+/**
+ * Create a new socket fastbuf.
+ * All information is passed by @par.
+ **/

 struct fastbuf *fbsock_create(struct fbsock_params *par);
 
 #endif
 struct fastbuf *fbsock_create(struct fbsock_params *par);
 
 #endif