fd_util: added API documentation

1 files changed, 24 insertions, 0 deletions

diff --git a/src/fd_util.h b/src/fd_util.h
index 64eb0c85..145941d3 100644
--- a/src/fd_util.h
+++ b/src/fd_util.h
@@ -32,21 +32,45 @@
 
 struct sockaddr;
 
+/**
+ * Wrapper for open(), which sets to CLOEXEC flag (atomically if
+ * supported by the OS).
+ */
 int
 open_cloexec(const char *path_fs, int flags);
 
+/**
+ * Wrapper for creat(), which sets to CLOEXEC flag (atomically if
+ * supported by the OS).
+ */
 int
 creat_cloexec(const char *path_fs, int mode);
 
+/**
+ * Wrapper for pipe(), which sets to CLOEXEC flag (atomically if
+ * supported by the OS).
+ */
 int
 pipe_cloexec(int fd[2]);
 
+/**
+ * Wrapper for socket(), which sets to CLOEXEC flag (atomically if
+ * supported by the OS).
+ */
 int
 socket_cloexec(int domain, int type, int protocol);
 
+/**
+ * Wrapper for accept(), which sets to CLOEXEC flag (atomically if
+ * supported by the OS).
+ */
 int
 accept_cloexec(int fd, struct sockaddr *address, size_t *address_length_r);
 
+/**
+ * Wrapper for inotify_init(), which sets to CLOEXEC flag (atomically
+ * if supported by the OS).
+ */
 int
 inotify_init_cloexec(void);