Changeset 0784869 in mainline for uspace/lib/bithenge/transform.c


Ignore:
Timestamp:
2012-08-20T17:32:00Z (12 years ago)
Author:
Sean Bartell <wingedtachikoma@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
1f136a27
Parents:
1a3b953
Message:

Bithenge: improve Doxygen documentation

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/lib/bithenge/transform.c

    r1a3b953 r0784869  
    184184/** Create a transform scope. It must be dereferenced with @a
    185185 * bithenge_scope_dec_ref after it is used. Takes ownership of nothing.
     186 * @memberof bithenge_scope_t
    186187 * @param[out] out Holds the new scope.
    187188 * @param outer The outer scope, or NULL.
    … …  
    207208
    208209/** Dereference a transform scope.
    209  * @param self The scope to dereference. */
     210 * @memberof bithenge_scope_t
     211 * @param self The scope to dereference, or NULL. */
    210212void bithenge_scope_dec_ref(bithenge_scope_t *self)
    211213{
    … …  
    224226
    225227/** Get the outer scope of a scope, which may be NULL.
     228 * @memberof bithenge_scope_t
    226229 * @param self The scope to examine.
    227230 * @return The outer scope, which may be NULL. */
    … …  
    233236/** Get the error message stored in the scope, which may be NULL. The error
    234237 * message only exists as long as the scope does.
     238 * @memberof bithenge_scope_t
    235239 * @param scope The scope to get the error message from.
    236240 * @return The error message, or NULL. */
    … …  
    243247 * outermost scope, but if any scope already has an error message this error
    244248 * message is ignored.
     249 * @memberof bithenge_scope_t
    245250 * @param scope The scope.
    246251 * @param format The format string.
    … …  
    292297
    293298/** Get the current node being created, which may be NULL.
     299 * @memberof bithenge_scope_t
    294300 * @param scope The scope to get the current node from.
    295301 * @return The node being created, or NULL. */
    … …  
    302308
    303309/** Set the current node being created. Takes a reference to @a node.
     310 * @memberof bithenge_scope_t
    304311 * @param scope The scope to set the current node in.
    305312 * @param node The current node being created, or NULL. */
    … …  
    312319
    313320/** Get the current input node, which may be NULL.
     321 * @memberof bithenge_scope_t
    314322 * @param scope The scope to get the current input node from.
    315323 * @return The input node, or NULL. */
    … …  
    322330
    323331/** Set the current input node. Takes a reference to @a node.
     332 * @memberof bithenge_scope_t
    324333 * @param scope The scope to set the input node in.
    325334 * @param node The input node, or NULL. */
    … …  
    331340
    332341/** Set a scope as a barrier.
     342 * @memberof bithenge_scope_t
    333343 * @param self The scope to change. */
    334344void bithenge_scope_set_barrier(bithenge_scope_t *self)
    … …  
    339349/** Check whether a scope is a barrier, meaning that variable lookup stops at
    340350 * it.
     351 * @memberof bithenge_scope_t
    341352 * @param self The scope to check.
    342353 * @return Whether the scope is a barrier. */
    … …  
    349360 * bithenge_scope_set_param. This must not be called on a scope that already
    350361 * has parameters.
     362 * @memberof bithenge_scope_t
    351363 * @param scope The scope in which to allocate parameters.
    352364 * @param num_params The number of parameters to allocate.
    … …  
    363375}
    364376
    365 /** Set a parameter. Takes a reference to @a value. Note that range checking is
     377/** Set a parameter. Takes a reference to @a node. Note that range checking is
    366378 * not done in release builds.
     379 * @memberof bithenge_scope_t
    367380 * @param scope The scope in which to allocate parameters.
    368381 * @param i The index of the parameter to set.
    369  * @param value The value to store in the parameter.
     382 * @param node The value to store in the parameter.
    370383 * @return EOK on success or an error code from errno.h. */
    371384int bithenge_scope_set_param( bithenge_scope_t *scope, int i,
    … …  
    383396
    384397/** Get a parameter. Note that range checking is not done in release builds.
     398 * @memberof bithenge_scope_t
    385399 * @param scope The scope to get the parameter from.
    386400 * @param i The index of the parameter to set.
    … …  
    867881}
    868882
     883/** @cond internal */
    869884#define MAKE_UINT_TRANSFORM(NAME, TYPE, ENDIAN, PREFIX_LENGTH_FUNC)            \
    870885        static int NAME##_apply(bithenge_transform_t *self,                    \
    … …  
    906921MAKE_UINT_TRANSFORM(uint64le, uint64_t, uint64_t_le2host, prefix_length_8);
    907922MAKE_UINT_TRANSFORM(uint64be, uint64_t, uint64_t_be2host, prefix_length_8);
     923/** @endcond */
    908924
    909925
Note: See TracChangeset for help on using the changeset viewer.