Changeset 8375d0eb in mainline for uspace/app/bithenge/blob.h

Timestamp:

2012-06-08T07:02:55Z (13 years ago)

Author:

Sean Bartell <wingedtachikoma@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

8b36bf2

Parents:

5c925ce

Message:

Bithenge: add Doxygen comments

File:

• uspace/app/bithenge/blob.h (modified) (4 diffs)

uspace/app/bithenge/blob.h

@@ -41 +41 @@
 #include "tree.h"
 
-/** A blob of raw binary data. */
+/** A blob of raw binary data.
+ * @implements bithenge_node_t */
 typedef struct {
         /** @privatesection */
@@ -55 +56 @@
         int (*read)(bithenge_blob_t *blob, aoff64_t offset, char *buffer,
             aoff64_t *size);
-        /** @copydoc bithenge_blob_t::bithenge_blob_destroy */
+        /** Destroy the blob.
+         * @param blob The blob.
+         * @return EOK on success or an error code from errno.h. */
         int (*destroy)(bithenge_blob_t *blob);
 } bithenge_random_access_blob_ops_t;
@@ -148 +151 @@
 }
 
+/** Cast a blob node to a generic node.
+ * @memberof bithenge_blob_t
+ * @param blob The blob to cast.
+ * @return The blob node as a generic node. */
 static inline bithenge_node_t *bithenge_blob_as_node(bithenge_blob_t *blob)
 {
@@ -153 +160 @@
 }
 
+/** Cast a generic node to a blob node.
+ * @memberof bithenge_blob_t
+ * @param node The node to cast, which must be a blob node.
+ * @return The generic node as a blob node. */
 static inline bithenge_blob_t *bithenge_node_as_blob(bithenge_node_t *node)
 {
+        assert(node->type == BITHENGE_NODE_BLOB);
         return (bithenge_blob_t *)node;
 }