diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-01-25 09:27:22 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-01-27 06:01:48 +0100 |
commit | b35ac9901caac823c5aa4aeeb81c4bb2c6bc58fd (patch) | |
tree | fe1061be42fa3aa4c18182e1d91c7ec7a83fe7f0 /cpukit/include/rtems/score/basedefs.h | |
parent | heap: Fix _Heap_Area_overhead() (diff) | |
download | rtems-b35ac9901caac823c5aa4aeeb81c4bb2c6bc58fd.tar.bz2 |
rtems: Add "Notes" paragraph header
Place the paragraphs in the same order as the directive documentation in
the RTEMS Classic API Guide.
Update #3993.
Diffstat (limited to 'cpukit/include/rtems/score/basedefs.h')
-rw-r--r-- | cpukit/include/rtems/score/basedefs.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/cpukit/include/rtems/score/basedefs.h b/cpukit/include/rtems/score/basedefs.h index d017ffa96a..a98b80f0dd 100644 --- a/cpukit/include/rtems/score/basedefs.h +++ b/cpukit/include/rtems/score/basedefs.h @@ -293,10 +293,10 @@ extern "C" { * * @brief Declares a global symbol with the name. * - * This macro must be placed at file scope. - * * @param _name is the name of the global symbol. It shall be a valid * designator. + * + * This macro must be placed at file scope. */ #define RTEMS_DECLARE_GLOBAL_SYMBOL( _name ) extern char _name[] @@ -354,12 +354,12 @@ extern "C" { * * @brief Gets the pointer reference type. * - * The reference type idea is based on libHX by Jan Engelhardt. - * * @param _level is the pointer indirection level expressed in *. * * @param _target is the reference target type. * + * The reference type idea is based on libHX by Jan Engelhardt. + * * @return Returns the type of a pointer reference of the specified level to * the specified type. */ @@ -601,9 +601,9 @@ extern "C" { * @brief Obfuscates the variable so that the compiler cannot perform * optimizations based on the variable value. * - * The variable must be simple enough to fit into a register. - * * @param _var is the variable to obfuscate. + * + * The variable must be simple enough to fit into a register. */ #if defined(__GNUC__) #define RTEMS_OBFUSCATE_VARIABLE( _var ) __asm__( "" : "+r" ( _var ) ) @@ -917,8 +917,6 @@ extern "C" { * * @brief Defines a global symbol with the name and value. * - * This macro shall be placed at file scope. - * * @param _name is the user defined name of the symbol. The name shall be a * valid designator. On the name a macro expansion is performed and * afterwards it is stringified. @@ -926,6 +924,8 @@ extern "C" { * @param _value is the value of the symbol. On the value a macro expansion is * performed and afterwards it is stringified. It shall expand to an integer * expression understood by the assembler. + * + * This macro shall be placed at file scope. */ #if defined(__USER_LABEL_PREFIX__) #define RTEMS_DEFINE_GLOBAL_SYMBOL( _name, _value ) \ |