Changeset 79249a5 in rtems


Ignore:
Timestamp:
Apr 15, 2019, 9:22:42 AM (2 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
9503db6
Parents:
d057bb29
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/15/19 09:22:42)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:04)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    rd057bb29 r79249a5  
    8383} SMP_Fatal_code;
    8484
     85/**
     86 * @brief Terminates with the given code.
     87 *
     88 * @param code The code for the termination.
     89 */
    8590static inline void _SMP_Fatal( SMP_Fatal_code code )
    8691{
     
    8994
    9095/**
    91  *  @brief Initialize SMP Handler
    92  *
    93  *  This method initialize the SMP Handler.
     96 * @brief Initializes SMP Handler
     97 *
     98 * This method initialize the SMP Handler.
    9499 */
    95100#if defined( RTEMS_SMP )
     
    136141 * This function does not return to the caller.
    137142 *
    138  * @param[in] cpu_self The current processor control.
     143 * @param cpu_self The current processor control.
    139144 */
    140145void _SMP_Start_multitasking_on_secondary_processor(
     
    151156 * This handler can be used to test the inter-processor interrupt
    152157 * implementation.
     158 *
     159 * @param handler The handler for text messages.
    153160 */
    154161static inline void _SMP_Set_test_message_handler(
     
    160167
    161168/**
    162  * @brief Interrupt handler for inter-processor interrupts.
     169 * @brief Interrupts handler for inter-processor interrupts.
     170 *
     171 * @param[in, out] cpu_self The cpu control for the operation.
    163172 *
    164173 * @return The received message.
     
    201210
    202211/**
    203  *  @brief Returns true, if the processor with the specified index should be
    204  *  started.
    205  *
    206  *  @param[in] cpu_index The processor index.
    207  *
    208  *  @retval true The processor should be started.
    209  *  @retval false Otherwise.
     212 * @brief Checks if the processor with the specified index should be started.
     213 *
     214 * @param cpu_index The processor index.
     215 *
     216 * @retval true The processor should be started.
     217 * @retval false The processor should not be started.
    210218 */
    211219bool _SMP_Should_start_processor( uint32_t cpu_index );
    212220
    213221/**
    214  *  @brief Sends an SMP message to a processor.
    215  *
    216  *  The target processor may be the sending processor.
    217  *
    218  *  @param[in] cpu_index The target processor of the message.
    219  *  @param[in] message The message.
     222 * @brief Sends an SMP message to a processor.
     223 *
     224 * The target processor may be the sending processor.
     225 *
     226 * @param cpu_index The target processor of the message.
     227 * @param message The message to send.
    220228 */
    221229void _SMP_Send_message( uint32_t cpu_index, unsigned long message );
    222230
    223231/**
    224  *  @brief Sends an SMP message to all other online processors.
    225  *
    226  *  @param[in] message The message.
     232 * @brief Sends an SMP message to all other online processors.
     233 *
     234 * @param message The message to send.
    227235 */
    228236void _SMP_Send_message_broadcast(
     
    231239
    232240/**
    233  *  @brief Sends an SMP message to a set of processors.
    234  *
    235  *  The sending processor may be part of the set.
    236  *
    237  *  @param[in] targets The set of processors to send the message.
    238  *  @param[in] message The message.
     241 * @brief Sends an SMP message to a set of processors.
     242 *
     243 * The sending processor may be part of the set.
     244 *
     245 * @param targets The set of processors to send the message.
     246 * @param message The message to send.
    239247 */
    240248void _SMP_Send_message_multicast(
     
    288296#endif
    289297
     298/**
     299 * @brief Gets all online processors
     300 *
     301 * @return The processor mask with all online processors.
     302 */
    290303RTEMS_INLINE_ROUTINE const Processor_mask *_SMP_Get_online_processors( void )
    291304{
Note: See TracChangeset for help on using the changeset viewer.