Doxygen edits and site update

Smithsonian · Sep 10, 2024 · 243653f · 243653f
1 parent fcea655
commit 243653f
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 29 deletions.
diff --git a/src/redisx-client.c b/src/redisx-client.c
@@ -398,11 +398,11 @@ int redisxUnlockClient(RedisClient *cl) {
  *
  * \param cl            Pointer to the Redis client to use.
  *
- * \return              X_SUCCESS (0) on success or an error code on failure, is either X_NO_SERVICE
- *                      if not connected to the Redis server on the requested channel, or
- *                      if send() failed.
+ * \return              X_SUCCESS (0) on success or X_NULL if the client is NULL, or else X_NO_SERVICE
+ *                      if not connected to the Redis server on the requested channel, or if send()
+ *                      failed.
+ *
  *
- *                          X_NULL      if the client is NULL.
  */
 int redisxSkipReplyAsync(RedisClient *cl) {
   static const char *fn = "redisSkipReplyAsync";
@@ -429,7 +429,7 @@ int redisxSkipReplyAsync(RedisClient *cl) {
  *
  * \return          X_SUCCESS (0)   if successful, or
  *                  X_NULL          if the Redis client is NULL, or
- *                  X_NO_SERVICE    if send() failed.
+ *                  X_NO_SERVICE    if not connected to the client server or if send() failed.
  *
  * @sa redisxExecBlockAsync()
  * @sa redisxAbortBlockAsync()
@@ -451,7 +451,8 @@ int redisxStartBlockAsync(RedisClient *cl) {
  *
  * \param cl    Pointer to a Redis client
  *
- * \return      X_SUCCESS (0) if successful or else X_NO_SERVICE if send() failed.
+ * \return      X_SUCCESS (0) if successful, or X_NULL if the client is NULL, or else
+ *              X_NO_SERVICE if not connected ot the client or if send() failed.
  *
  * @sa redisxStartBlockAsync()
  *
@@ -525,9 +526,8 @@ RESP *redisxExecBlockAsync(RedisClient *cl) {
  * \param arg2          Optional second string argument or NULL.
  * \param arg3          Optional third string argument or NULL.
  *
- * \return              X_SUCCESS (0) on success or an error code on failure, is either X_NO_SERVICE
- *                      if not connected to the Redis server on the requested channel or if send()
- *                      failed
+ * \return              X_SUCCESS (0) on success or X_NULL if the client is NULL, or else
+ *                      X_NO_SERVICE if not connected to the client or if send() failed
  */
 int redisxSendRequestAsync(RedisClient *cl, const char *command, const char *arg1, const char *arg2, const char *arg3) {
   static const char *fn = "redisxSendRequestAsync";
@@ -559,9 +559,8 @@ int redisxSendRequestAsync(RedisClient *cl, const char *command, const char *arg
  *                      lengths of all string arguments automatically.
  * \param n             The number of arguments to send.
  *
- * \return              X_SUCCESS (0) on success or an error code on failure, is either X_NO_SERVICE
- *                      if not connected to the Redis server on the requested channel or if send()
- *                      failed
+ * \return              X_SUCCESS (0) on success or X_NULL if the client is NULL, or else
+ *                      X_NO_SERVICE if not connected to the client or if send() failed.
  */
 int redisxSendArrayRequestAsync(RedisClient *cl, char *args[], int lengths[], int n) {
   const char *fn = "redisxSendArrayRequestAsync";
@@ -790,7 +789,8 @@ RESP *redisxReadReplyAsync(RedisClient *cl) {
  * client disconnected and reconnected again.
  *
  * @param cl    The Redis client
- * @return      X_SUCCESS (0) if successful, or else an error code (&lt;0) from redisx.h / xchange.h.
+ * @return      X_SUCCESS (0) if successful, or X_NULL if the client is NULL, or another error code
+ *              (&lt;0) from redisx.h / xchange.h.
  */
 int redisxResetClient(RedisClient *cl) {
   static const char *fn = "redisxResetClient";

diff --git a/src/redisx-net.c b/src/redisx-net.c
@@ -155,7 +155,7 @@ static void rConfigSocket(int socket, boolean lowLatency) {
  *
  * @param cl    Pointer to the Redis client to authenticate
  * @return      X_SUCCESS (0) if succssfully authenticated on the server, or else an
- *              appropriate error.
+ *              appropriate error (&lt;0).
  *
  * @sa redisxSetPassword()
  */
@@ -187,9 +187,8 @@ static int rAuthAsync(RedisClient *cl) {
  *
  * \return      X_SUCCESS (0)       if successful, or
  *              X_ALREADY_OPEN      if the Redis instance is alreast connected.
- *              X_NO_SERVICE        if there was an error connecting to Redis
- *
- *              or else an error returned by rConnectClientAsync().
+ *              X_NO_SERVICE        if there was an error connecting to Redis,
+ *              or else an error (&lt;0) returned by rConnectClientAsync().
  *
  * \sa rConnectClientAsync()
  *
@@ -380,7 +379,7 @@ void redisxDisconnect(Redis *redis) {
  * \return      X_SUCCESS (0)   if successful
  *              X_NULL          if the Redis instance is NULL
  *
- *              or else an error as would be returned by redisxConnect().
+ *              or else an error (&lt;0) as would be returned by redisxConnect().
  *
  */
 int redisxReconnect(Redis *redis, boolean usePipeline) {

diff --git a/src/redisx-script.c b/src/redisx-script.c
@@ -27,8 +27,7 @@
  *              X_NULL                  if the Redis instance is NULL
  *              X_NAME_INVALID          if the script is NULL or empty.
  *              REDIS_UNEXPECTED_RESP   if received a Redis reponse of the wrong type,
- *
- *              ot an error returned by redisxRequest().
+ *              or an error (&lt;0) returned by redisxRequest().
  *
  */
 int redisxLoadScript(Redis *redis, const char *script, char **sha1) {
@@ -69,7 +68,7 @@ int redisxLoadScript(Redis *redis, const char *script, char **sha1) {
  * @param params    A NULL-terminated array of additional parameters to pass onto the script, or
  *                  NULL if the script does not take any parameters.
  * @return          X_SUCCESS (0) if successful or else X_NULL if the `redis` or `sha1` parameters
- *                  are NULL, or else an error code from redisxSendArrayRequestAsync().
+ *                  are NULL, or else an error code (&lt;0) from redisxSendArrayRequestAsync().
  *
  * @sa redisxRunScript()
  * @sa redisxLoadScript()

diff --git a/src/redisx-sub.c b/src/redisx-sub.c
@@ -78,8 +78,7 @@ static int rConnectSubscriptionClientAsync(Redis *redis) {
  * \return      X_SUCCESS (0)   if successful, or else
  *              X_NULL          if the redis instance is NULL
  *              X_NAME_INVALID  if the PUB/SUB channel is null or empty
- *
- *              or an error code returned by redisxSendArrayRequestAsync().
+ *              or an error code (&lt;0) returned by redisxSendArrayRequestAsync().
  *
  * @sa redisxPublish()
  * @sa redisxNotify()

diff --git a/src/redisx-tab.c b/src/redisx-tab.c
@@ -119,7 +119,6 @@ RedisEntry *redisxGetTable(Redis *redis, const char *table, int *n) {
  * \param confirm       Whether we should get a confirmation from the server (requires a round-trip).
  *
  * \return      X_SUCCESS if the variable was succesfully set, or:
- *
  *                  X_NO_INIT
  *                  X_NAME_INVALID
  *                  X_NULL
@@ -161,8 +160,7 @@ int redisxSetValue(Redis *redis, const char *table, const char *key, const char
  * \return          X_SUCCESS (0)   if successful, or
  *                  X_NULL          if the client or value is NULL
  *                  X_NAME_INVALID  if key is invalid,
- *
- *                  or an error returned by redisxSendRequestAsync().
+ *                  or an error (&lt;0) returned by redisxSendRequestAsync().
  */
 int redisxSetValueAsync(RedisClient *cl, const char *table, const char *key, const char *value, boolean confirm) {
   static const char *fn = "redisxSetValueAsync";
@@ -315,7 +313,7 @@ char *redisxGetStringValue(Redis *redis, const char *table, const char *key, int
  * \param n             Number of entries.
  * \param confirm       Whether we should get a confirmation from the server (requires a round-trip).
  *
- * \return              X_SUCCESS (0) on success or an error code.
+ * \return              X_SUCCESS (0) on success or an error code (&lt;0) from redisx.h / xchange.h.
  *
  * @sa redisxMultiSet()
  * @sa redisxLockClient()
@@ -376,7 +374,7 @@ int redisxMultiSetAsync(RedisClient *cl, const char *table, const RedisEntry *en
  * \param n             Number of entries.
  * \param confirm       Whether we should get a confirmation from the server (requires a round-trip).
  *
- * \return              X_SUCCESS (0) on success or an error code (&lt;0).
+ * \return              X_SUCCESS (0) on success or an error code (&lt;0) from redisx.h / xchange.h.
  *
  */
 int redisxMultiSet(Redis *redis, const char *table, const RedisEntry *entries, int n, boolean confirm) {
@@ -415,7 +413,8 @@ int redisxMultiSet(Redis *redis, const char *table, const RedisEntry *entries, i
  *                          REDIS_NULL          If got a null or empty response from Redis
  *                          UNEXPECTED_RESP     If the response from Redis was not the expected array type
  *
- * \return               An array with pointers to key names from this table or NULL if there was an error (see parameter n).
+ * \return               An array with pointers to key names from this table or NULL if there was an error
+ *                       (see parameter n for an error status from redisx.h / xchange.h).
  *
  * @sa redisxScanKeys()
  * @sa redisxDestroyKeys()