Skip to content

Commit ecd936b

Browse files
committed
Fix a grammar issue, use longer function ends in port.c. Use @note in a few more places
1 parent 2ef0b5d commit ecd936b

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

portable/GCC/ARM_CRx_MPU/port.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -819,7 +819,7 @@ void vPortEnterCritical( void )
819819
configASSERT( ulPortInterruptNesting == 0 );
820820
}
821821
}
822-
/*-----------------------------------------------------------*/
822+
/* ----------------------------------------------------------------------------------- */
823823

824824
/* PRIVILEGED_FUNCTION */
825825
void vPortExitCritical( void )
@@ -840,4 +840,4 @@ void vPortExitCritical( void )
840840
}
841841
}
842842
}
843-
/*-----------------------------------------------------------*/
843+
/* ----------------------------------------------------------------------------------- */

portable/GCC/ARM_CRx_MPU/portmacro.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ extern "C" {
115115
*
116116
* @ingroup Critical Sections
117117
*
118-
* A task exits critical section and enables IRQs when its nesting count reaches
119-
* this value.
118+
* @note A task exits critical section and enables IRQs when its nesting count
119+
* reaches this value.
120120
*/
121121
#define portNO_CRITICAL_NESTING ( ( uint32_t ) 0x0 )
122122

@@ -370,8 +370,8 @@ void vPortExitCritical( void );
370370
*
371371
* @ingroup Port Privilege
372372
*
373-
* @note The processor privilege level is determined by checking if bits [4:0]
374-
* of the Current Program Status Register (CPSR).
373+
* @note The processor privilege level is determined by checking the
374+
* mode bits [4:0] of the Current Program Status Register (CPSR).
375375
*
376376
* @return pdTRUE, if the processer is privileged, pdFALSE otherwise.
377377
*/
@@ -384,7 +384,7 @@ BaseType_t xPortIsPrivileged( void );
384384
*
385385
* @ingroup Port Privilege
386386
*
387-
* A task's privilege level is associated with the task and is different from
387+
* @note A task's privilege level is associated with the task and is different from
388388
* the processor's privilege level returned by xPortIsPrivileged. For example,
389389
* the processor is privileged when an unprivileged task executes a system call.
390390
*
@@ -399,7 +399,7 @@ BaseType_t xPortIsTaskPrivileged( void );
399399
*
400400
* @ingroup Task Context
401401
*
402-
* This function is used as the default return address for tasks if
402+
* @note This function is used as the default return address for tasks if
403403
* configTASK_RETURN_ADDRESS is not defined in FreeRTOSConfig.h.
404404
*/
405405
void prvTaskExitError( void );
@@ -443,8 +443,8 @@ void vPortEndScheduler( void );
443443
* @ingroup Task Context
444444
* @ingroup MPU Control
445445
*
446-
* A privileged task is created by performing a bitwise OR of this value and the
447-
* task priority. For example, to create a privileged task at priority 2, the
446+
* @note A privileged task is created by performing a bitwise OR of this value and
447+
* the task priority. For example, to create a privileged task at priority 2, the
448448
* uxPriority parameter should be set to ( 2 | portPRIVILEGE_BIT ).
449449
*/
450450
#define portPRIVILEGE_BIT ( 0x80000000UL )

0 commit comments

Comments
 (0)