Changeset 57cd05cf in rtems


Ignore:
Timestamp:
Apr 10, 2019, 5:50:15 AM (10 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
3da777e
Parents:
976c095
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/10/19 05:50:15)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:03)
Message:

doxygen: score: adjust doc in mpciimpl.h to doxygen guidelines

Update #3706.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/score/mpciimpl.h

    r976c095 r57cd05cf  
    102102
    103103/**
    104  *  This routine registers the MPCI packet processor for the
    105  *  designated object class.
    106  *
    107  *  @param[in] the_class is the class indicator for packets which will
    108  *             be processed by @a the_packet_processor method.
    109  *  @param[in] the_packet_processor is a pointer to a method which is
    110  *             invoked when packets with @a the_class are received.
     104 * @brief Registers the MPCI packet processor for the designated object class.
     105 *
     106 * @param the_class The class indicator for packets which will
     107 *            be processed by @a the_packet_processor method.
     108 * @param the_packet_processor Pointer to a method which is
     109 *            invoked when packets with @a the_class are received.
    111110 */
    112111void _MPCI_Register_packet_processor(
     
    117116
    118117/**
    119  *  This function obtains a packet by invoking the user provided
    120  *  MPCI get packet callout.
    121  *
    122  *  @retval This method returns a pointer to a MPCI packet which can be
     118 * @brief Obtains a packet by invoking the user provided
     119 *          MPCI get packet callout.
     120 *
     121 * @return Returns a pointer to a MPCI packet which can be
    123122 *          filled in by the caller and used to perform a subsequent
    124123 *          remote operation.
     
    127126
    128127/**
    129  *  @brief Deallocate a packet.
    130  *
    131  *  This routine deallocates a packet by invoking the user provided
    132  *  MPCI return packet callout.
    133  *
    134  *  @param[in] the_packet is the MP packet to deallocate.
     128 * @brief Deallocates a packet.
     129 *
     130 * This routine deallocates a packet by invoking the user provided
     131 * MPCI return packet callout.
     132 *
     133 * @param[out] the_packet The MP packet to deallocate.
    135134 */
    136135void _MPCI_Return_packet (
     
    139138
    140139/**
    141  *  @brief Send a process packet.
    142  *
    143  *  This routine sends a process packet by invoking the user provided
    144  *  MPCI send callout.
    145  *
    146  *  @param[in] destination is the node which should receive this packet.
    147  *  @param[in] the_packet is the packet to be sent.
     140 * @brief Sends a process packet.
     141 *
     142 * This routine sends a process packet by invoking the user provided
     143 * MPCI send callout.
     144 *
     145 * @param destination The node which should receive this packet.
     146 * @param the_packet The packet to be sent.
    148147 */
    149148void _MPCI_Send_process_packet (
     
    153152
    154153/**
    155  *  @brief Send a request packet.
    156  *
    157  *  This routine sends a request packet by invoking the user provided
    158  *  MPCI send callout.
    159  *
    160  *  @param[in] destination is the node which should receive this packet.
    161  *  @param[in] the_packet is the packet to be sent.
    162  *  @param[in] extra_state is the extra thread state bits which should be
    163  *             set in addition to the remote operation pending state.  It
    164  *             may indicate the caller is blocking on a message queue
    165  *             operation.
    166  *
    167  *  @retval This method returns the operation status from the remote node.
     154 * @brief Sends a request packet.
     155 *
     156 * This routine sends a request packet by invoking the user provided
     157 * MPCI send callout.
     158 *
     159 * @param destination The node which should receive this packet.
     160 * @param the_packet The packet to be sent.
     161 * @param extra_state The extra thread state bits which should be
     162 *            set in addition to the remote operation pending state.  It
     163 *            may indicate the caller is blocking on a message queue
     164 *            operation.
     165 *
     166 * @ret This method returns the operation status from the remote node.
    168167 */
    169168Status_Control _MPCI_Send_request_packet(
     
    174173
    175174/**
    176  *  @brief Send a response packet.
    177  *
    178  *  This routine sends a response packet by invoking the user provided
    179  *  MPCI send callout.
    180  *
    181  *  @param[in] destination is the node which should receive this packet.
    182  *  @param[in] the_packet is the packet to be sent.
     175 * @brief Sends a response packet.
     176 *
     177 * This routine sends a response packet by invoking the user provided
     178 * MPCI send callout.
     179 *
     180 * @param destination The node which should receive this packet.
     181 * @param the_packet The packet to be sent.
    183182 */
    184183void _MPCI_Send_response_packet (
     
    188187
    189188/**
    190  *  @brief Receive a packet.
    191  *
    192  *  This routine receives a packet by invoking the user provided
    193  *  MPCI receive callout.
    194  *
    195  *  @retval This method returns the packet received.
     189 * @brief Receives a packet.
     190 *
     191 * This routine receives a packet by invoking the user provided
     192 * MPCI receive callout.
     193 *
     194 * @return This method returns the packet received.
    196195 */
    197196MP_packet_Prefix  *_MPCI_Receive_packet ( void );
    198197
    199198/**
    200  *  @brief Pass a packet to the thread.
    201  *
    202  *  This routine is responsible for passing @a the_packet to the thread
    203  *  waiting on the remote operation to complete.  The unblocked thread is
    204  *  responsible for eventually freeing @a the_packet.
    205  *
    206  *  @param[in] the_packet is the response packet to be processed.
    207  *
    208  *  @retval This method returns a pointer to the thread which was if unblocked
    209  *          or NULL if the waiting thread no longer exists.
     199 * @brief Passes a packet to the thread.
     200 *
     201 * This routine is responsible for passing @a the_packet to the thread
     202 * waiting on the remote operation to complete.  The unblocked thread is
     203 * responsible for eventually freeing @a the_packet.
     204 *
     205 * @param the_packet is the response packet to be processed.
     206 *
     207 * @retval pointer This method returns a pointer to the thread which was unblocked
     208 * @retval NULL The waiting thread no longer exists.
    210209 */
    211210Thread_Control *_MPCI_Process_response (
     
    214213
    215214/**
    216  *  @brief Receive and process all packets.
    217  *
    218  *  This is the server thread which receives and processes all MCPI packets.
    219  *
    220  *  @param[in] ignored is the thread argument.  It is not used.
     215 * @brief Receives and processes all packets.
     216 *
     217 * This is the server thread which receives and processes all MCPI packets.
     218 *
     219 * @param ignored The thread argument.  It is not used.
    221220 */
    222221void _MPCI_Receive_server(
     
    225224
    226225/**
    227  *  @brief Announce the availability of a packet.
    228  *
    229  *  This routine informs RTEMS of the availability of an MPCI packet.
     226 * @brief Announces the availability of a packet.
     227 *
     228 * This routine informs RTEMS of the availability of an MPCI packet.
    230229 */
    231230void _MPCI_Announce ( void );
    232231
    233232/**
    234  *  @brief Perform a process on another node.
    235  *
    236  *  This routine performs a remote procedure call so that a
    237  *  process operation can be performed on another node.
    238  *
    239  *  @param[in] operation is the remote operation to perform.
     233 * @brief Performs a process on another node.
     234 *
     235 * This routine performs a remote procedure call so that a
     236 * process operation can be performed on another node.
     237 *
     238 * @param operation The remote operation to perform.
    240239 */
    241240void _MPCI_Internal_packets_Send_process_packet (
     
    264263
    265264/**
    266  *  @brief Perform requested action from another node.
    267  *
    268  *  This routine performs the actions specific to this package for
    269  *  the request from another node.
     265 * @brief Performs requested action from another node.
     266 *
     267 * This routine performs the actions specific to this package for
     268 * the request from another node.
     269 *
     270 * @param the_packet_prefix The packet prefix for this method.
    270271 */
    271272void _MPCI_Internal_packets_Process_packet (
     
    296297
    297298/**
    298  *  @brief Obtain an internal thread.
    299  *
    300  *  This routine is used to obtain an internal threads MP packet.
     299 * @brief Obtains an internal thread.
     300 *
     301 * This routine is used to obtain an internal threads MP packet.
     302 *
     303 * @retval pointer The pointer to the obtained packet.
     304 * @retval NULL Something went wrong.
    301305 */
    302306MPCI_Internal_packet *_MPCI_Internal_packets_Get_packet ( void );
    303307
    304308/**
    305  * This function returns true if the the_packet_class is valid,
    306  * and false otherwise.
     309 * @brief Checks if the packet class is valid.
     310 *
     311 * @param the_packet_class The packet class to perform the validation on.
     312 *
     313 * @retval true @a the_packet_class is valid.
     314 * @retval false @a the_packet_class is not valid.
    307315 *
    308316 * @note Check for lower bounds (MP_PACKET_CLASSES_FIRST ) is unnecessary
     
    317325}
    318326
    319 /**@}*/
     327/** @} */
    320328
    321329#ifdef __cplusplus
Note: See TracChangeset for help on using the changeset viewer.