X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=socket.h;h=0c4ac001d219505555857c736eafdb9e93e0095a;hb=464bab19acf0aaeb8c5512c2092042162266de2d;hp=9365f2f8b0c46c5a39bc052a85d61cf41670c0de;hpb=497ba428052f1437187778ceb2293c8eaba5893f;p=~andy%2Ffetchmail

diff --git a/socket.h b/socket.h
index 9365f2f8..0c4ac001 100644
--- a/socket.h
+++ b/socket.h
@@ -1,5 +1,5 @@
-/*
- * socket.h -- declarations for socket library functions
+/**
+ * \file socket.h -- declarations for socket library functions
  *
  * For license terms, see the file COPYING in this directory.
  */
@@ -17,17 +17,11 @@ struct addrinfo;
 #endif
 #include <netdb.h>
 
-/* Create a new client socket; returns -1 on error */
+/** Create a new client socket; returns -1 on error */
 int SockOpen(const char *host, const char *service, const char *plugin, struct addrinfo **);
 
-/* Returns 1 if this socket is OK, 0 if it isn't select()able
- * on - probably because it's been closed. You should
- * always check this function before passing stuff to the
- * select()-based waiter, as otherwise it may loop. 
- */
-int SockCheckOpen(int fd);
 
-/* 
+/** 
 Get a string terminated by an '\n' (matches interface of fgets).
 Pass it a valid socket, a buffer for the string, and
 the length of the buffer (including the trailing \0)
@@ -35,12 +29,12 @@ returns length of buffer on success, -1 on failure.
 */
 int SockRead(int sock, char *buf, int len);
 
-/*
+/**
  * Peek at the next socket character without actually reading it.
  */
 int SockPeek(int sock);
 
-/*
+/**
 Write a chunk of bytes to the socket (matches interface of fwrite).
 Returns number of bytes successfully written.
 */
@@ -51,7 +45,7 @@ int SockWrite(int sock, const char *buf, int size);
 # define __attribute__(xyz)    /* Ignore. */
 #endif
 
-/* 
+/**
 Send formatted output to the socket (matches interface of fprintf).
 Returns number of bytes successfully written.
 */
@@ -63,14 +57,14 @@ int SockPrintf(int sock, const char *format, ...)
 int SockPrintf();
 #endif
  
-/*
+/**
 Close a socket previously opened by SockOpen.  This allows for some
 additional clean-up if necessary.
 */
 int SockClose(int sock);
 
-/*
-FIXME: document this
+/**
+ \todo document this
 */
 int UnixOpen(const char *path);