diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-02-06 11:09:27 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-02-14 07:42:14 +0100 |
| commit | 1f8b26a809d514c710469ae6c50fc483f41da9f1 (patch) | |
| tree | 05be2ec1b06d879a2f2b4a1c65ca338c14d3b479 /cpukit/include/rtems/extension.h | |
| parent | doxygen: Generalize appl config constraints (diff) | |
| download | rtems-1f8b26a809d514c710469ae6c50fc483f41da9f1.tar.bz2 | |
doxygen: Use @anchor for appl config options
The application configuration options are documented in
"cpukit/doxygen/appl-config.h". Since the application configuration
option defines are also present in multiple test program sources, the
"#OPTION" references cannot be mapped to a unique definition. Add an
anchor for each option and reference it to avoid the issues with the
multiple definitions.
Update #3994.
Diffstat (limited to 'cpukit/include/rtems/extension.h')
| -rw-r--r-- | cpukit/include/rtems/extension.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/cpukit/include/rtems/extension.h b/cpukit/include/rtems/extension.h index 0117a41b8a..5f9c09db06 100644 --- a/cpukit/include/rtems/extension.h +++ b/cpukit/include/rtems/extension.h @@ -140,7 +140,7 @@ rtems_status_code rtems_extension_delete( rtems_id id ); * may be in an undefined and corrupt state. * * It is recommended to register fatal extensions through initial extension - * sets, see #CONFIGURE_INITIAL_EXTENSIONS. + * sets, see @ref CONFIGURE_INITIAL_EXTENSIONS. * @endparblock */ typedef User_extensions_fatal_extension rtems_fatal_extension; @@ -230,7 +230,7 @@ rtems_status_code rtems_extension_ident( rtems_name name, rtems_id *id ); * @ingroup RTEMSAPIClassicUserExt * * @brief The extensions table contains a set of extensions which may be - * registered in the system through the #CONFIGURE_INITIAL_EXTENSIONS + * registered in the system through the @ref CONFIGURE_INITIAL_EXTENSIONS * application configuration option or the rtems_extension_create() * directive. */ @@ -271,8 +271,8 @@ typedef User_extensions_Table rtems_extensions_table; * * @retval ::RTEMS_TOO_MANY There was no inactive object available to create an * extension set. The number of extension sets available to the application - * is configured through the #CONFIGURE_MAXIMUM_USER_EXTENSIONS application - * configuration option. + * is configured through the @ref CONFIGURE_MAXIMUM_USER_EXTENSIONS + * application configuration option. * * @par Notes * @parblock @@ -286,8 +286,8 @@ typedef User_extensions_Table rtems_extensions_table; * are invoked upon the next system event supporting an extension. * * An alternative to dynamically created extension sets are initial extensions, - * see #CONFIGURE_INITIAL_EXTENSIONS. Initial extensions are recommended for - * extension sets which provide a fatal error extension. + * see @ref CONFIGURE_INITIAL_EXTENSIONS. Initial extensions are recommended + * for extension sets which provide a fatal error extension. * * For control and maintenance of the extension set, RTEMS allocates a ESCB * from the local ESCB free pool and initializes it. @@ -306,8 +306,8 @@ typedef User_extensions_Table rtems_extensions_table; * cause the calling task to be preempted. * * * The number of extension sets available to the application is configured - * through the #CONFIGURE_MAXIMUM_USER_EXTENSIONS application configuration - * option. + * through the @ref CONFIGURE_MAXIMUM_USER_EXTENSIONS application + * configuration option. * @endparblock */ rtems_status_code rtems_extension_create( |