Changeset 7c3fb9b in mainline for uspace/lib/bithenge/src/transform.c


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).

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/lib/bithenge/src/transform.c

    rfac0ac7 r7c3fb9b  
    5656 * whatever parameters it has, so they can be passed to any param_wrappers
    5757 * within.
    58  * @return EOK or an error code from errno.h. */
     58 * @return EOK or an error code from errno.h.
     59 */
    5960errno_t bithenge_init_transform(bithenge_transform_t *self,
    6061    const bithenge_transform_ops_t *ops, int num_params)
    … …  
    8283 * @param in The input tree.
    8384 * @param[out] out Where the output tree will be stored.
    84  * @return EOK on success or an error code from errno.h. */
     85 * @return EOK on success or an error code from errno.h.
     86 */
    8587errno_t bithenge_transform_apply(bithenge_transform_t *self,
    8688    bithenge_scope_t *scope, bithenge_node_t *in, bithenge_node_t **out)
    … …  
    118120 * @param[out] out Where the prefix length will be stored.
    119121 * @return EOK on success, ENOTSUP if not supported, or another error code from
    120  * errno.h. */
     122 * errno.h.
     123 */
    121124errno_t bithenge_transform_prefix_length(bithenge_transform_t *self,
    122125    bithenge_scope_t *scope, bithenge_blob_t *blob, aoff64_t *out)
    … …  
    149152 * case the size is not determined.
    150153 * @return EOK on success, ENOTSUP if not supported, or another error code from
    151  * errno.h. */
     154 * errno.h.
     155 */
    152156errno_t bithenge_transform_prefix_apply(bithenge_transform_t *self,
    153157    bithenge_scope_t *scope, bithenge_blob_t *blob, bithenge_node_t **out_node,
    … …  
    187191 * @param[out] out Holds the new scope.
    188192 * @param outer The outer scope, or NULL.
    189  * @return EOK on success or an error code from errno.h. */
     193 * @return EOK on success or an error code from errno.h.
     194 */
    190195errno_t bithenge_scope_new(bithenge_scope_t **out, bithenge_scope_t *outer)
    191196{
    … …  
    209214/** Dereference a transform scope.
    210215 * @memberof bithenge_scope_t
    211  * @param self The scope to dereference, or NULL. */
     216 * @param self The scope to dereference, or NULL.
     217 */
    212218void bithenge_scope_dec_ref(bithenge_scope_t *self)
    213219{
    … …  
    228234 * @memberof bithenge_scope_t
    229235 * @param self The scope to examine.
    230  * @return The outer scope, which may be NULL. */
     236 * @return The outer scope, which may be NULL.
     237 */
    231238bithenge_scope_t *bithenge_scope_outer(bithenge_scope_t *self)
    232239{
    … …  
    238245 * @memberof bithenge_scope_t
    239246 * @param scope The scope to get the error message from.
    240  * @return The error message, or NULL. */
     247 * @return The error message, or NULL.
     248 */
    241249const char *bithenge_scope_get_error(bithenge_scope_t *scope)
    242250{
    … …  
    250258 * @param scope The scope.
    251259 * @param format The format string.
    252  * @return EINVAL normally, or another error code from errno.h. */
     260 * @return EINVAL normally, or another error code from errno.h.
     261 */
    253262errno_t bithenge_scope_error(bithenge_scope_t *scope, const char *format, ...)
    254263{
    … …  
    299308 * @memberof bithenge_scope_t
    300309 * @param scope The scope to get the current node from.
    301  * @return The node being created, or NULL. */
     310 * @return The node being created, or NULL.
     311 */
    302312bithenge_node_t *bithenge_scope_get_current_node(bithenge_scope_t *scope)
    303313{
    … …  
    310320 * @memberof bithenge_scope_t
    311321 * @param scope The scope to set the current node in.
    312  * @param node The current node being created, or NULL. */
     322 * @param node The current node being created, or NULL.
     323 */
    313324void bithenge_scope_set_current_node(bithenge_scope_t *scope,
    314325    bithenge_node_t *node)
    … …  
    321332 * @memberof bithenge_scope_t
    322333 * @param scope The scope to get the current input node from.
    323  * @return The input node, or NULL. */
     334 * @return The input node, or NULL.
     335 */
    324336bithenge_node_t *bithenge_scope_in_node(bithenge_scope_t *scope)
    325337{
    … …  
    332344 * @memberof bithenge_scope_t
    333345 * @param scope The scope to set the input node in.
    334  * @param node The input node, or NULL. */
     346 * @param node The input node, or NULL.
     347 */
    335348void bithenge_scope_set_in_node(bithenge_scope_t *scope, bithenge_node_t *node)
    336349{
    … …  
    341354/** Set a scope as a barrier.
    342355 * @memberof bithenge_scope_t
    343  * @param self The scope to change. */
     356 * @param self The scope to change.
     357 */
    344358void bithenge_scope_set_barrier(bithenge_scope_t *self)
    345359{
    … …  
    351365 * @memberof bithenge_scope_t
    352366 * @param self The scope to check.
    353  * @return Whether the scope is a barrier. */
     367 * @return Whether the scope is a barrier.
     368 */
    354369bool bithenge_scope_is_barrier(bithenge_scope_t *self)
    355370{
    … …  
    363378 * @param scope The scope in which to allocate parameters.
    364379 * @param num_params The number of parameters to allocate.
    365  * @return EOK on success or an error code from errno.h. */
     380 * @return EOK on success or an error code from errno.h.
     381 */
    366382errno_t bithenge_scope_alloc_params(bithenge_scope_t *scope, int num_params)
    367383{
    … …  
    381397 * @param i The index of the parameter to set.
    382398 * @param node The value to store in the parameter.
    383  * @return EOK on success or an error code from errno.h. */
     399 * @return EOK on success or an error code from errno.h.
     400 */
    384401errno_t bithenge_scope_set_param(bithenge_scope_t *scope, int i,
    385402    bithenge_node_t *node)
    … …  
    400417 * @param i The index of the parameter to set.
    401418 * @param[out] out Stores a new reference to the parameter.
    402  * @return EOK on success or an error code from errno.h. */
     419 * @return EOK on success or an error code from errno.h.
     420 */
    403421errno_t bithenge_scope_get_param(bithenge_scope_t *scope, int i,
    404422    bithenge_node_t **out)
    … …  
    502520 * @param base The barrier transform.
    503521 * @param transform The subtransform to use for all operations.
    504  * @return EOK on success or an error code from errno.h. */
     522 * @return EOK on success or an error code from errno.h.
     523 */
    505524errno_t bithenge_barrier_transform_set_subtransform(bithenge_transform_t *base,
    506525    bithenge_transform_t *transform)
    … …  
    526545 * @param[out] out Holds the created transform.
    527546 * @param num_params The number of parameters to require, which may be 0.
    528  * @return EOK on success or an error code from errno.h. */
     547 * @return EOK on success or an error code from errno.h.
     548 */
    529549errno_t bithenge_new_barrier_transform(bithenge_transform_t **out, int num_params)
    530550{
    … …  
    742762
    743763/** A transform that converts a byte blob to a bit blob, most-significant bit
    744  * first. */
     764 * first.
     765 */
    745766bithenge_transform_t bithenge_bits_be_transform = {
    746767        &bits_xe_ops, 1, 0
    … …  
    748769
    749770/** A transform that converts a byte blob to a bit blob, least-significant bit
    750  * first. */
     771 * first.
     772 */
    751773bithenge_transform_t bithenge_bits_le_transform = {
    752774        &bits_xe_ops, 1, 0
    … …  
    9871009
    9881010/** A transform that reads an unsigned integer from an arbitrary number of
    989  * bits, most-significant bit first. */
     1011 * bits, most-significant bit first.
     1012 */
    9901013bithenge_transform_t bithenge_uint_be_transform = {
    9911014        &uint_xe_ops, 1, 1
    … …  
    9931016
    9941017/** A transform that reads an unsigned integer from an arbitrary number of
    995  * bits, least-significant bit first. */
     1018 * bits, least-significant bit first.
     1019 */
    9961020bithenge_transform_t bithenge_uint_le_transform = {
    9971021        &uint_xe_ops, 1, 1
Note: See TracChangeset for help on using the changeset viewer.