Changeset 1bfd3d3 in mainline for uspace/lib/c/generic/net/packet.c


Ignore:
Timestamp:
2010-11-19T22:02:09Z (14 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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • uspace/lib/c/generic/net/packet.c

    rcc3c2a1c r1bfd3d3  
    8282/** Initializes the packet map.
    8383 *
    84  * @returns             EOK on success.
    85  * @returns             ENOMEM if there is not enough memory left.
     84 * @return              EOK on success.
     85 * @return              ENOMEM if there is not enough memory left.
    8686 */
    8787int pm_init(void)
     
    101101 *
    102102 * @param[in] packet_id The packet identifier to be found.
    103  * @returns             The found packet reference.
    104  * @returns             NULL if the mapping does not exist.
     103 * @return              The found packet reference.
     104 * @return              NULL if the mapping does not exist.
    105105 */
    106106packet_t pm_find(packet_id_t packet_id)
     
    130130 *
    131131 * @param[in] packet    The packet to be remembered.
    132  * @returns             EOK on success.
    133  * @returns             EINVAL if the packet is not valid.
    134  * @returns             EINVAL if the packet map is not initialized.
    135  * @returns             ENOMEM if there is not enough memory left.
     132 * @return              EOK on success.
     133 * @return              EINVAL if the packet is not valid.
     134 * @return              EINVAL if the packet map is not initialized.
     135 * @return              ENOMEM if there is not enough memory left.
    136136 */
    137137int pm_add(packet_t packet)
     
    205205 * @param[in] order     The packet order value.
    206206 * @param[in] metric    The metric value of the packet.
    207  * @returns             EOK on success.
    208  * @returns             EINVAL if the first parameter is NULL.
    209  * @returns             EINVAL if the packet is not valid.
     207 * @return              EOK on success.
     208 * @return              EINVAL if the first parameter is NULL.
     209 * @return              EINVAL if the packet is not valid.
    210210 */
    211211int pq_add(packet_t * first, packet_t packet, size_t order, size_t metric)
     
    249249 * @param[in] first     The first packet of the queue.
    250250 * @param[in] order     The packet order value.
    251  * @returns             The packet with the given order.
    252  * @returns             NULL if the first packet is not valid.
    253  * @returns             NULL if the packet is not found.
     251 * @return              The packet with the given order.
     252 * @return              NULL if the first packet is not valid.
     253 * @return              NULL if the packet is not found.
    254254 */
    255255packet_t pq_find(packet_t packet, size_t order)
     
    275275 * @param[in] packet    The packet in the queue.
    276276 * @param[in] new_packet The new packet to be inserted.
    277  * @returns             EOK on success.
    278  * @returns             EINVAL if etiher of the packets is invalid.
     277 * @return              EOK on success.
     278 * @return              EINVAL if etiher of the packets is invalid.
    279279 */
    280280int pq_insert_after(packet_t packet, packet_t new_packet)
     
    298298 *
    299299 * @param[in] packet    The packet to be detached.
    300  * @returns             The next packet in the queue. If the packet is the first
     300 * @return              The next packet in the queue. If the packet is the first
    301301 *                      one of the queue, this becomes the new first one.
    302  * @returns             NULL if there is no packet left.
    303  * @returns             NULL if the packet is not valid.
     302 * @return              NULL if there is no packet left.
     303 * @return              NULL if the packet is not valid.
    304304 */
    305305packet_t pq_detach(packet_t packet)
     
    328328 * @param[in] order     The packet order value.
    329329 * @param[in] metric    The metric value of the packet.
    330  * @returns             EOK on success.
    331  * @returns             EINVAL if the packet is invalid.
     330 * @return              EOK on success.
     331 * @return              EINVAL if the packet is invalid.
    332332 */
    333333int pq_set_order(packet_t packet, size_t order, size_t metric)
     
    346346 * @param[out] order    The packet order value.
    347347 * @param[out] metric   The metric value of the packet.
    348  * @returns             EOK on success.
    349  * @returns             EINVAL if the packet is invalid.
     348 * @return              EOK on success.
     349 * @return              EINVAL if the packet is invalid.
    350350 */
    351351int pq_get_order(packet_t packet, size_t *order, size_t *metric)
     
    391391 *
    392392 * @param[in] packet    The packet queue member.
    393  * @returns             The next packet in the queue.
    394  * @returns             NULL if there is no next packet.
    395  * @returns             NULL if the packet is not valid.
     393 * @return              The next packet in the queue.
     394 * @return              NULL if there is no next packet.
     395 * @return              NULL if the packet is not valid.
    396396 */
    397397packet_t pq_next(packet_t packet)
     
    406406 *
    407407 * @param[in] packet    The packet queue member.
    408  * @returns             The previous packet in the queue.
    409  * @returns             NULL if there is no previous packet.
    410  * @returns             NULL if the packet is not valid.
     408 * @return              The previous packet in the queue.
     409 * @return              NULL if there is no previous packet.
     410 * @return              NULL if the packet is not valid.
    411411 */
    412412packet_t pq_previous(packet_t packet)
Note: See TracChangeset for help on using the changeset viewer.