Changeset 1bfd3d3 in mainline for uspace/lib/c/generic/adt


Ignore:
Timestamp:
2010-11-19T22:02:09Z (15 years ago)
Author:
Jiri Svoboda <jiri@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
973ef9fc, a9c6b966
Parents:
cc3c2a1c
Message:

Replace @returns with @return.

Location:
uspace/lib/c/generic/adt
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • uspace/lib/c/generic/adt/char_map.c

    rcc3c2a1c r1bfd3d3  
    6060 * @param[in] value     The integral value to be stored for the key character
    6161 *                      string.
    62  * @returns             EOK on success.
    63  * @returns             ENOMEM if there is not enough memory left.
    64  * @returns             EEXIST if the key character string is already used.
     62 * @return              EOK on success.
     63 * @return              ENOMEM if there is not enough memory left.
     64 * @return              EEXIST if the key character string is already used.
    6565 */
    6666static int
    … …  
    107107 *
    108108 * @param[in] map       The character string to integer map.
    109  * @returns             TRUE if the map is valid.
    110  * @returns             FALSE otherwise.
     109 * @return              TRUE if the map is valid.
     110 * @return              FALSE otherwise.
    111111 */
    112112static int char_map_is_valid(const char_map_t *map)
    … …  
    127127 * @param[in] value     The integral value to be stored for the key character
    128128 *                      string.
    129  * @returns             EOK on success.
    130  * @returns             EINVAL if the map is not valid.
    131  * @returns             EINVAL if the identifier parameter is NULL.
    132  * @returns             EINVAL if the length parameter zero (0) and the
     129 * @return              EOK on success.
     130 * @return              EINVAL if the map is not valid.
     131 * @return              EINVAL if the identifier parameter is NULL.
     132 * @return              EINVAL if the length parameter zero (0) and the
    133133 *                      identifier parameter is an empty character string (the
    134134 *                      first character is the terminating zero ('\0')
    135135 *                      character.
    136  * @returns             EEXIST if the key character string is already used.
    137  * @returns             Other error codes as defined for the
     136 * @return              EEXIST if the key character string is already used.
     137 * @return              Other error codes as defined for the
    138138 *                      char_map_add_item() function.
    139139 */
    … …  
    196196 *                      zero (0) which means that the string is processed until
    197197 *                      the terminating zero ('\0') character is found.
    198  * @returns             The node holding the integral value assigned to the key
     198 * @return              The node holding the integral value assigned to the key
    199199 *                      character string.
    200  * @returns             NULL if the key is not assigned a node.
     200 * @return              NULL if the key is not assigned a node.
    201201 */
    202202static char_map_t *
    … …  
    239239 *                      zero (0) which means that the string is processed until
    240240 *                      the terminating zero ('\0') character is found.
    241  * @returns             The integral value assigned to the key character string.
    242  * @returns             CHAR_MAP_NULL if the key is not assigned a value.
     241 * @return              The integral value assigned to the key character string.
     242 * @return              CHAR_MAP_NULL if the key is not assigned a value.
    243243 */
    244244int char_map_exclude(char_map_t *map, const char *identifier, size_t length)
    … …  
    267267 *                      zero (0) which means that the string is processed until
    268268 *                      the terminating zero ('\0') character is found.
    269  *  @returns            The integral value assigned to the key character string.
    270  *  @returns            CHAR_MAP_NULL if the key is not assigned a value.
     269 *  @return             The integral value assigned to the key character string.
     270 *  @return             CHAR_MAP_NULL if the key is not assigned a value.
    271271 */
    272272int char_map_find(const char_map_t *map, const char *identifier, size_t length)
    … …  
    281281 *
    282282 *  @param[in,out] map  The character string to integer map.
    283  *  @returns            EOK on success.
    284  *  @returns            EINVAL if the map parameter is NULL.
    285  *  @returns            ENOMEM if there is not enough memory left.
     283 *  @return             EOK on success.
     284 *  @return             EINVAL if the map parameter is NULL.
     285 *  @return             ENOMEM if there is not enough memory left.
    286286 */
    287287int char_map_initialize(char_map_t *map)
    … …  
    319319 *  @param[in] value    The integral value to be stored for the key character
    320320 *                      string.
    321  *  @returns            EOK on success.
    322  *  @returns            EINVAL if the map is not valid.
    323  *  @returns            EINVAL if the identifier parameter is NULL.
    324  *  @returns            EINVAL if the length parameter zero (0) and the
     321 *  @return             EOK on success.
     322 *  @return             EINVAL if the map is not valid.
     323 *  @return             EINVAL if the identifier parameter is NULL.
     324 *  @return             EINVAL if the length parameter zero (0) and the
    325325 *                      identifier parameter is an empty character string (the
    326326 *                      first character is the terminating zero ('\0) character.
    327  *  @returns            EEXIST if the key character string is already used.
    328  *  @returns            Other error codes as defined for the char_map_add_item()
     327 *  @return             EEXIST if the key character string is already used.
     328 *  @return             Other error codes as defined for the char_map_add_item()
    329329 *                      function.
    330330 */

  • uspace/lib/c/generic/adt/dynamic_fifo.c

    rcc3c2a1c r1bfd3d3  
    5656 *
    5757 * @param[in] fifo      The dynamic queue.
    58  * @returns             TRUE if the queue is valid.
    59  * @returns             FALSE otherwise.
     58 * @return              TRUE if the queue is valid.
     59 * @return              FALSE otherwise.
    6060 */
    6161static int dyn_fifo_is_valid(dyn_fifo_t *fifo)
    … …  
    6868 * @param[in,out] fifo  The dynamic queue.
    6969 * @param[in] size      The initial queue size.
    70  * @returns             EOK on success.
    71  * @returns             EINVAL if the queue is not valid.
    72  * @returns             EBADMEM if the fifo parameter is NULL.
    73  * @returns             ENOMEM if there is not enough memory left.
     70 * @return              EOK on success.
     71 * @return              EINVAL if the queue is not valid.
     72 * @return              EBADMEM if the fifo parameter is NULL.
     73 * @return              ENOMEM if there is not enough memory left.
    7474 */
    7575int dyn_fifo_initialize(dyn_fifo_t *fifo, int size)
    … …  
    100100 *                      this limit. May be zero or negative to indicate no
    101101 *                      limit.
    102  * @returns             EOK on success.
    103  * @returns             EINVAL if the queue is not valid.
    104  * @returns             ENOMEM if there is not enough memory left.
     102 * @return              EOK on success.
     103 * @return              EINVAL if the queue is not valid.
     104 * @return              ENOMEM if there is not enough memory left.
    105105 */
    106106int dyn_fifo_push(dyn_fifo_t *fifo, int value, int max_size)
    … …  
    150150 *
    151151 * @param[in,out] fifo  The dynamic queue.
    152  * @returns             Value of the first item in the queue.
    153  * @returns             EINVAL if the queue is not valid.
    154  * @returns             ENOENT if the queue is empty.
     152 * @return              Value of the first item in the queue.
     153 * @return              EINVAL if the queue is not valid.
     154 * @return              ENOENT if the queue is empty.
    155155 */
    156156int dyn_fifo_pop(dyn_fifo_t *fifo)
    … …  
    172172 *
    173173 * @param[in,out] fifo  The dynamic queue.
    174  * @returnsi            Value of the first item in the queue.
    175  * @returns             EINVAL if the queue is not valid.
    176  * @returns             ENOENT if the queue is empty.
     174 * @return              Value of the first item in the queue.
     175 * @return              EINVAL if the queue is not valid.
     176 * @return              ENOENT if the queue is empty.
    177177 */
    178178int dyn_fifo_value(dyn_fifo_t *fifo)
    … …  
    190190 *
    191191 * @param[in,out] fifo  The dynamic queue.
    192  * @returns             EOK on success.
    193  * @returns             EINVAL if the queue is not valid.
     192 * @return              EOK on success.
     193 * @return              EINVAL if the queue is not valid.
    194194 */
    195195int dyn_fifo_destroy(dyn_fifo_t *fifo)

  • uspace/lib/c/generic/adt/measured_strings.c

    rcc3c2a1c r1bfd3d3  
    5555 *                      appended with the terminating zero ('\0') character
    5656 *                      otherwise.
    57  * @returns             The new bundled character string with measured length.
    58  * @returns             NULL if there is not enough memory left.
     57 * @return              The new bundled character string with measured length.
     58 * @return              NULL if there is not enough memory left.
    5959 */
    6060measured_string_t *
    … …  
    8484 *
    8585 * @param[in] source    The source measured string to be copied.
    86  * @returns             The copy of the given measured string.
    87  * @returns             NULL if the source parameter is NULL.
    88  * @returns             NULL if there is not enough memory left.
     86 * @return              The copy of the given measured string.
     87 * @return              NULL if the source parameter is NULL.
     88 * @return              NULL if there is not enough memory left.
    8989 */
    9090measured_string_t *measured_string_copy(measured_string_t *source)
    … …  
    120120 *                      actual character strings.
    121121 *  @param[in] count    The size of the measured strings array.
    122  *  @returns            EOK on success.
    123  *  @returns            EINVAL if the strings or data parameter is NULL.
    124  *  @returns            EINVAL if the count parameter is zero (0).
    125  *  @returns            EINVAL if the sent array differs in size.
    126  *  @returns            EINVAL if there is inconsistency in sent measured
     122 *  @return             EOK on success.
     123 *  @return             EINVAL if the strings or data parameter is NULL.
     124 *  @return             EINVAL if the count parameter is zero (0).
     125 *  @return             EINVAL if the sent array differs in size.
     126 *  @return             EINVAL if there is inconsistency in sent measured
    127127 *                      strings' lengths (should not occur).
    128  *  @returns            ENOMEM if there is not enough memory left.
    129  *  @returns            Other error codes as defined for the
     128 *  @return             ENOMEM if there is not enough memory left.
     129 *  @return             Other error codes as defined for the
    130130 *                      async_data_write_finalize() function.
    131131 */
    … …  
    209209 * @param[in] strings   The measured strings array to be processed.
    210210 * @param[in] count     The measured strings array size.
    211  * @returns             The computed sizes array.
    212  * @returns             NULL if there is not enough memory left.
     211 * @return              The computed sizes array.
     212 * @return              NULL if there is not enough memory left.
    213213 */
    214214static size_t *prepare_lengths(const measured_string_t *strings, size_t count)
    … …  
    238238 * @param[in] strings   The measured strings array to be transferred.
    239239 * @param[in] count     The measured strings array size.
    240  * @returns             EOK on success.
    241  * @returns             EINVAL if the strings parameter is NULL.
    242  * @returns             EINVAL if the count parameter is zero (0).
    243  * @returns             EINVAL if the calling module does not accept the given
     240 * @return              EOK on success.
     241 * @return              EINVAL if the strings parameter is NULL.
     242 * @return              EINVAL if the count parameter is zero (0).
     243 * @return              EINVAL if the calling module does not accept the given
    244244 *                      array size.
    245  * @returns             EINVAL if there is inconsistency in sent measured
     245 * @return              EINVAL if there is inconsistency in sent measured
    246246 *                      strings' lengths (should not occur).
    247  * @returns             Other error codes as defined for the
     247 * @return              Other error codes as defined for the
    248248 *                      async_data_read_finalize() function.
    249249 */
    … …  
    302302 *                      actual character strings.
    303303 * @param[in] count     The size of the measured strings array.
    304  * @returns             EOK on success.
    305  * @returns             EINVAL if the strings or data parameter is NULL.
    306  * @returns             EINVAL if the phone or count parameter is not positive.
    307  * @returns             EINVAL if the sent array differs in size.
    308  * @returns             ENOMEM if there is not enough memory left.
    309  * @returns             Other error codes as defined for the
     304 * @return              EOK on success.
     305 * @return              EINVAL if the strings or data parameter is NULL.
     306 * @return              EINVAL if the phone or count parameter is not positive.
     307 * @return              EINVAL if the sent array differs in size.
     308 * @return              ENOMEM if there is not enough memory left.
     309 * @return              Other error codes as defined for the
    310310 *                      async_data_read_start() function.
    311311 */
    … …  
    378378 * @param[in] strings   The measured strings array to be transferred.
    379379 * @param[in] count     The measured strings array size.
    380  * @returns             EOK on success.
    381  * @returns             EINVAL if the strings parameter is NULL.
    382  * @returns             EINVAL if the phone or count parameter is not positive.
    383  * @returns             Other error codes as defined for the
     380 * @return              EOK on success.
     381 * @return              EINVAL if the strings parameter is NULL.
     382 * @return              EINVAL if the phone or count parameter is not positive.
     383 * @return              Other error codes as defined for the
    384384 *                      async_data_write_start() function.
    385385 */
Note: See TracChangeset for help on using the changeset viewer.