Changeset 7c3fb9b in mainline for uspace/lib/bithenge/include


Ignore:
Timestamp:
2018-05-17T08:29:01Z (7 years ago)
Author:
Jiri Svoboda <jiri@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
6ff23ff
Parents:
fac0ac7
git-author:
Jiri Svoboda <jiri@…> (2018-05-16 17:28:17)
git-committer:
Jiri Svoboda <jiri@…> (2018-05-17 08:29:01)
Message:

Fix block comment formatting (ccheck).

Location:
uspace/lib/bithenge/include/bithenge
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • uspace/lib/bithenge/include/bithenge/blob.h

    rfac0ac7 r7c3fb9b  
    4343
    4444/** A blob of raw binary data.
    45  * @implements bithenge_node_t */
     45 * @implements bithenge_node_t
     46 */
    4647typedef struct {
    4748        /** @privatesection */
    … …  
    5051
    5152/** Operations providing random access to binary data.
    52  * @todo Should these be thread-safe? */
     53 * @todo Should these be thread-safe?
     54 */
    5355typedef struct bithenge_random_access_blob_ops_t {
    5456        /** @copydoc bithenge_blob_t::bithenge_blob_size */
    … …  
    6163            aoff64_t *size, bool little_endian);
    6264        /** Destroy the blob.
    63          * @param blob The blob. */
     65         * @param blob The blob.
     66         */
    6467        void (*destroy)(bithenge_blob_t *self);
    6568} bithenge_random_access_blob_ops_t;
    6669
    6770/** A blob built from an object that supports only sequential reading.
    68  * @implements bithenge_blob_t */
     71 * @implements bithenge_blob_t
     72 */
    6973typedef struct {
    7074        /** @privatesection */
    … …  
    8286
    8387/** Operations providing sequential access to binary data.
    84  * @memberof bithenge_sequential_blob_t */
     88 * @memberof bithenge_sequential_blob_t
     89 */
    8590typedef struct bithenge_sequential_blob_ops_t {
    8691
    … …  
    112117
    113118        /** Destroy the blob.
    114          * @param self The blob. */
     119         * @param self The blob.
     120         */
    115121        void (*destroy)(bithenge_sequential_blob_t *self);
    116122} bithenge_sequential_blob_ops_t;
    … …  
    189195 * @param self The blob.
    190196 * @param[out] out Holds whether the blob is empty.
    191  * @return EOK on success or an error code from errno.h. */
     197 * @return EOK on success or an error code from errno.h.
     198 */
    192199static inline errno_t bithenge_blob_empty(bithenge_blob_t *self, bool *out)
    193200{
    … …  
    203210 * @memberof bithenge_blob_t
    204211 * @param blob The blob to cast.
    205  * @return The blob node as a generic node. */
     212 * @return The blob node as a generic node.
     213 */
    206214static inline bithenge_node_t *bithenge_blob_as_node(bithenge_blob_t *blob)
    207215{
    … …  
    212220 * @memberof bithenge_blob_t
    213221 * @param node The node to cast, which must be a blob node.
    214  * @return The generic node as a blob node. */
     222 * @return The generic node as a blob node.
     223 */
    215224static inline bithenge_blob_t *bithenge_node_as_blob(bithenge_node_t *node)
    216225{
    … …  
    220229
    221230/** Increment a blob's reference count.
    222  * @param blob The blob to reference. */
     231 * @param blob The blob to reference.
     232 */
    223233static inline void bithenge_blob_inc_ref(bithenge_blob_t *blob)
    224234{
    … …  
    227237
    228238/** Decrement a blob's reference count.
    229  * @param blob The blob to dereference, or NULL. */
     239 * @param blob The blob to dereference, or NULL.
     240 */
    230241static inline void bithenge_blob_dec_ref(bithenge_blob_t *blob)
    231242{

  • uspace/lib/bithenge/include/bithenge/expression.h

    rfac0ac7 r7c3fb9b  
    5555            bithenge_node_t **out);
    5656        /** Destroy the expression.
    57          * @param self The expression. */
     57         * @param self The expression.
     58         */
    5859        void (*destroy)(bithenge_expression_t *self);
    5960} bithenge_expression_ops_t;
    6061
    6162/** Increment an expression's reference count.
    62  * @param self The expression to reference. */
     63 * @param self The expression to reference.
     64 */
    6365static inline void bithenge_expression_inc_ref(bithenge_expression_t *self)
    6466{
    … …  
    6870
    6971/** Decrement an expression's reference count and free it if appropriate.
    70  * @param self The expression to dereference, or NULL. */
     72 * @param self The expression to dereference, or NULL.
     73 */
    7174static inline void bithenge_expression_dec_ref(bithenge_expression_t *self)
    7275{
    … …  
    8487 * @param scope The scope.
    8588 * @param[out] out Where the output tree will be stored.
    86  * @return EOK on success or an error code from errno.h. */
     89 * @return EOK on success or an error code from errno.h.
     90 */
    8791static inline errno_t bithenge_expression_evaluate(bithenge_expression_t *self,
    8892    bithenge_scope_t *scope, bithenge_node_t **out)

  • uspace/lib/bithenge/include/bithenge/print.h

    rfac0ac7 r7c3fb9b  
    4343typedef enum {
    4444        /** Print a Python value. Note that internal nodes will be represented
    45          * as unordered dictionaries. */
     45         * as unordered dictionaries.
     46         */
    4647        BITHENGE_PRINT_PYTHON,
    4748        /** Print JSON. Due to the limitations of JSON, type information may be
    48          * lost. */
     49         * lost.
     50         */
    4951        BITHENGE_PRINT_JSON,
    5052} bithenge_print_type_t;

  • uspace/lib/bithenge/include/bithenge/transform.h

    rfac0ac7 r7c3fb9b  
    6464/** Increment a scope's reference count.
    6565 * @memberof bithenge_scope_t
    66  * @param self The scope to reference. */
     66 * @param self The scope to reference.
     67 */
    6768static inline void bithenge_scope_inc_ref(bithenge_scope_t *self)
    6869{
    … …  
    7374/** Operations that may be provided by a transform. All transforms must provide
    7475 * apply and/or prefix_apply. To be used in struct transforms and repeat
    75  * transforms, transforms must provide prefix_length and/or prefix_apply. */
     76 * transforms, transforms must provide prefix_length and/or prefix_apply.
     77 */
    7678typedef struct bithenge_transform_ops {
    7779        /** @copydoc bithenge_transform_t::bithenge_transform_apply */
    … …  
    8688            bithenge_node_t **out_node, aoff64_t *out_size);
    8789        /** Destroy the transform.
    88          * @param self The transform. */
     90         * @param self The transform.
     91         */
    8992        void (*destroy)(bithenge_transform_t *self);
    9093} bithenge_transform_ops_t;
    … …  
    9396 * by the parser and param-wrapper. Takes ownership of nothing.
    9497 * @param self The transform.
    95  * @return The number of parameters required. */
     98 * @return The number of parameters required.
     99 */
    96100static inline int bithenge_transform_num_params(bithenge_transform_t *self)
    97101{
    … …  
    101105
    102106/** Increment a transform's reference count.
    103  * @param self The transform to reference. */
     107 * @param self The transform to reference.
     108 */
    104109static inline void bithenge_transform_inc_ref(bithenge_transform_t *self)
    105110{
    … …  
    109114
    110115/** Decrement a transform's reference count and free it if appropriate.
    111  * @param self The transform to dereference, or NULL. */
     116 * @param self The transform to dereference, or NULL.
     117 */
    112118static inline void bithenge_transform_dec_ref(bithenge_transform_t *self)
    113119{

  • uspace/lib/bithenge/include/bithenge/tree.h

    rfac0ac7 r7c3fb9b  
    8181 * @param value The value.
    8282 * @param data Data provided to @a bithenge_node_t::bithenge_node_for_each.
    83  * @return EOK on success or an error code from errno.h. */
     83 * @return EOK on success or an error code from errno.h.
     84 */
    8485typedef errno_t (*bithenge_for_each_func_t)(bithenge_node_t *key, bithenge_node_t *value, void *data);
    8586
    … …  
    9293            bithenge_node_t **out);
    9394        /** Destroys the internal node.
    94          * @param self The node to destroy. */
     95         * @param self The node to destroy.
     96         */
    9597        void (*destroy)(bithenge_node_t *self);
    9698} bithenge_internal_node_ops_t;
    … …  
    99101 * @memberof bithenge_node_t
    100102 * @param node The node.
    101  * @return The type of the node. */
     103 * @return The type of the node.
     104 */
    102105static inline bithenge_node_type_t bithenge_node_type(const bithenge_node_t *node)
    103106{
    … …  
    107110/** Increment a node's reference count.
    108111 * @memberof bithenge_node_t
    109  * @param node The node to reference. */
     112 * @param node The node to reference.
     113 */
    110114static inline void bithenge_node_inc_ref(bithenge_node_t *node)
    111115{
    … …  
    122126 * @param func The callback function.
    123127 * @param data Data to provide to the callback function.
    124  * @return EOK on success or an error code from errno.h. */
     128 * @return EOK on success or an error code from errno.h.
     129 */
    125130static inline errno_t bithenge_node_for_each(bithenge_node_t *self,
    126131    bithenge_for_each_func_t func, void *data)
    … …  
    137142 * @memberof bithenge_node_t
    138143 * @param self The boolean node.
    139  * @return The node's value. */
     144 * @return The node's value.
     145 */
    140146static inline bool bithenge_boolean_node_value(bithenge_node_t *self)
    141147{
    … …  
    147153 * @memberof bithenge_node_t
    148154 * @param self The integer node.
    149  * @return The node's value. */
     155 * @return The node's value.
     156 */
    150157static inline bithenge_int_t bithenge_integer_node_value(bithenge_node_t *self)
    151158{
    … …  
    157164 * @memberof bithenge_node_t
    158165 * @param self The string node.
    159  * @return The node's value. */
     166 * @return The node's value.
     167 */
    160168static inline const char *bithenge_string_node_value(bithenge_node_t *self)
    161169{
Note: See TracChangeset for help on using the changeset viewer.