Changeset cfd04c4 in mainline

Timestamp:

2025-10-09T15:57:48Z (5 weeks ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

master

Children:

0cf3d5f

Parents:

c111da2

Message:

Add docblocks to capa functions.

File:

• uspace/lib/c/generic/capa.c (modified) (6 diffs)

uspace/lib/c/generic/capa.c

@@ -199 +199 @@
 }
 
+/** Format capacity as string into a newly allocated buffer.
+ *
+ * @param capa Capacity
+ * @param rstr Place to store pointer to newly allocated string
+ * @return EOK on success or an error code
+ */
 errno_t capa_format(capa_spec_t *capa, char **rstr)
 {
@@ -233 +239 @@
 }
 
+/** Format capacity as string into an existing buffer.
+ *
+ * @param capa Capacity
+ * @param buf Buffer for storing string
+ * @param bufsize Size of buffer in bytes
+ * @return EOK on success or an error code
+ */
 errno_t capa_format_buf(capa_spec_t *capa, char *buf, size_t bufsize)
 {
@@ -263 +276 @@
 }
 
+/** Format capacity of n blocks as string into a newly allocated buffer.
+ *
+ * This computes the total capacity of the blocks, simplifies it
+ * and formats it as string.
+ *
+ * @param nblocks Number of blocks
+ * @param block_size Size of each block in bytes
+ * @param rstr Place to store pointer to newly allocated string
+ * @return EOK on success or an error code
+ */
 errno_t capa_blocks_format(uint64_t nblocks, size_t block_size,
     char **rptr)
@@ -273 +296 @@
 }
 
+/** Format capacity of n blocks as string into an existing buffer.
+ *
+ * This computes the total capacity of the blocks, simplifies it
+ * and formats it as string.
+ *
+ * This function does not return error. If the buffer is too small,
+ * the string will be truncated. To make sure it is not truncated,
+ * bufsize should be at least CAPA_BLOCKS_BUFSIZE.
+ *
+ * @param nblocks Number of blocks
+ * @param block_size Size of each block in bytes
+ * @param buf Buffer for storing string
+ * @param bufsize Size of buffer in bytes
+ */
 void capa_blocks_format_buf(uint64_t nblocks, size_t block_size,
-    char *buf, size_t bsize)
+    char *buf, size_t bufsize)
 {
         capa_spec_t capa;
@@ -283 +320 @@
 
         /* Should not get range error because of nblocks * block_size limits */
-        rc = capa_format_buf(&capa, buf, bsize);
+        rc = capa_format_buf(&capa, buf, bufsize);
         assert(rc == EOK);
         (void)rc;
@@ -328 +365 @@
 }
 
+/** Parse string as capacity specification.
+ *
+ * @param str String (e.g. "100 kB")
+ * @param capa Place to store capacity
+ * @return EOK on success or an error code
+ */
 errno_t capa_parse(const char *str, capa_spec_t *capa)
 {