include/ruby/internal/intern/select/posix.h: add doxygen

Must not be a bad idea to improve documents. [ci skip]

1 files changed, 64 insertions, 1 deletions

diff --git a/include/ruby/internal/intern/select/posix.h b/include/ruby/internal/intern/select/posix.h
index 7a6cd3024f..bfde159890 100644
--- a/include/ruby/internal/intern/select/posix.h
+++ b/include/ruby/internal/intern/select/posix.h
@@ -30,17 +30,41 @@
 # include <unistd.h>            /* for select(2) (archaic UNIX) */
 #endif
 
-#include "ruby/internal/attr/pure.h"
 #include "ruby/internal/attr/const.h"
+#include "ruby/internal/attr/noalias.h"
+#include "ruby/internal/attr/nonnull.h"
+#include "ruby/internal/attr/pure.h"
 
+/**
+ * The data structure which wraps the  fd_set bitmap used by `select(2)`.  This
+ * allows Ruby to use FD sets larger than what has been historically allowed on
+ * modern platforms.
+ *
+ * @internal
+ *
+ * ... but because  this header file is  included only when the  system is with
+ * that "historic restrictions", this is nothing more than an alias of fd_set.
+ */
 typedef fd_set rb_fdset_t;
 
+/** Clears the given ::rb_fdset_t. */
 #define rb_fd_zero   FD_ZERO
+
+/** Sets the given fd to the ::rb_fdset_t. */
 #define rb_fd_set    FD_SET
+
+/** Unsets the given fd from the ::rb_fdset_t. */
 #define rb_fd_clr    FD_CLR
+
+/** Queries if the given fd is in the ::rb_fdset_t. */
 #define rb_fd_isset  FD_ISSET
+
+/** Initialises the :given :rb_fdset_t. */
 #define rb_fd_init   FD_ZERO
+
+/** Waits for multiple file descriptors at once. */
 #define rb_fd_select select
+
 /**@cond INTERNAL_MACRO */
 #define rb_fd_copy  rb_fd_copy
 #define rb_fd_dup   rb_fd_dup
@@ -48,12 +72,32 @@ typedef fd_set rb_fdset_t;
 #define rb_fd_max   rb_fd_max
 /** @endcond */
 
+RBIMPL_ATTR_NONNULL(())
+RBIMPL_ATTR_NOALIAS()
+/**
+ * Destructively overwrites an fdset with another.
+ *
+ * @param[out]  dst   Target fdset.
+ * @param[in]   src   Source fdset.
+ * @param[in]   n     Unused parameter.
+ * @post        `dst` is a copy of `src`.
+ */
 static inline void
 rb_fd_copy(rb_fdset_t *dst, const fd_set *src, int n)
 {
     *dst = *src;
 }
 
+RBIMPL_ATTR_NONNULL(())
+RBIMPL_ATTR_NOALIAS()
+/**
+ * Destructively overwrites an fdset with another.
+ *
+ * @param[out]  dst   Target fdset.
+ * @param[in]   src   Source fdset.
+ * @param[in]   n     Unused parameter.
+ * @post        `dst` is a copy of `src`.
+ */
 static inline void
 rb_fd_dup(rb_fdset_t *dst, const fd_set *src, int n)
 {
@@ -62,6 +106,17 @@ rb_fd_dup(rb_fdset_t *dst, const fd_set *src, int n)
 
 RBIMPL_ATTR_PURE()
 /* :TODO: can this function be __attribute__((returns_nonnull)) or not? */
+/**
+ * Raw pointer to `fd_set`.
+ *
+ * @param[in]  f  Target fdset.
+ * @return     Underlying fd_set.
+ *
+ * @internal
+ *
+ * Extension library  must not touch  raw pointers.  It was  a bad idea  to let
+ * them use it.
+ */
 static inline fd_set *
 rb_fd_ptr(rb_fdset_t *f)
 {
@@ -69,14 +124,22 @@ rb_fd_ptr(rb_fdset_t *f)
 }
 
 RBIMPL_ATTR_CONST()
+/**
+ * It seems this function has no use.  Maybe just remove?
+ *
+ * @param[in]  f  A set.
+ * @return     Number of file descriptors stored.
+ */
 static inline int
 rb_fd_max(const rb_fdset_t *f)
 {
     return FD_SETSIZE;
 }
 
+/** @cond INTERNAL_MACRO */
 /* :FIXME: What are these?  They don't exist for shibling implementations. */
 #define rb_fd_init_copy(d, s) (*(d) = *(s))
 #define rb_fd_term(f)   ((void)(f))
+/** @endcond */
 
 #endif /* RBIMPL_INTERN_SELECT_POSIX_H */