Skip to content

Commit

Permalink
[toranj] remove docs from test specific config headers (#9276)
Browse files Browse the repository at this point in the history
This commit removes the unnecessary Doxygen-style documentation of
used configuration options from toranj config header files. This
makes the test-specific config header simpler and avoids confusion
with the main config parameters documentation, which is included in
the corresponding `src/config/<name>.h` header files.
  • Loading branch information
abtink authored Jul 12, 2023
1 parent 0dd706e commit 5beae14
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 545 deletions.
24 changes: 0 additions & 24 deletions tests/toranj/openthread-core-toranj-config-posix.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,36 +37,12 @@
// Include the common configuration for all platforms.
#include "openthread-core-toranj-config.h"

/**
* @def OPENTHREAD_CONFIG_PLATFORM_INFO
*
* The platform-specific string to insert into the OpenThread version string.
*
*/
#define OPENTHREAD_CONFIG_PLATFORM_INFO "POSIX-toranj"

/**
* @def OPENTHREAD_CONFIG_LOG_OUTPUT
*
* Selects if, and where the LOG output goes to.
*
*/
#define OPENTHREAD_CONFIG_LOG_OUTPUT OPENTHREAD_CONFIG_LOG_OUTPUT_PLATFORM_DEFINED

/**
* @def OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE
*
* Define to 1 to enable Border Router support.
*
*/
#define OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE 1

/**
* @def OPENTHREAD_POSIX_CONFIG_RCP_PTY_ENABLE
*
* Define as 1 to enable PTY device support in POSIX app.
*
*/
#define OPENTHREAD_POSIX_CONFIG_RCP_PTY_ENABLE 1

#define OPENTHREAD_POSIX_CONFIG_RCP_BUS OT_POSIX_RCP_BUS_UART
Expand Down
52 changes: 2 additions & 50 deletions tests/toranj/openthread-core-toranj-config-simulation.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,74 +37,26 @@
// Include the common configuration for all platforms.
#include "openthread-core-toranj-config.h"

/**
* @def OPENTHREAD_CONFIG_PLATFORM_INFO
*
* The platform-specific string to insert into the OpenThread version string.
*
*/
#if OPENTHREAD_RADIO

#define OPENTHREAD_CONFIG_PLATFORM_INFO "SIMULATION-RCP-toranj"
#else
#define OPENTHREAD_CONFIG_PLATFORM_INFO "SIMULATION-toranj"

#endif

/**
* @def OPENTHREAD_CONFIG_PLATFORM_FLASH_API_ENABLE
*
* Define to 1 to enable otPlatFlash* APIs to support non-volatile storage.
*
* When defined to 1, the platform MUST implement the otPlatFlash* APIs instead of the otPlatSettings* APIs.
*
*/
#define OPENTHREAD_CONFIG_PLATFORM_FLASH_API_ENABLE 1

/**
* @def OPENTHREAD_CONFIG_LOG_OUTPUT
*
* Selects if, and where the LOG output goes to.
*
*/
#define OPENTHREAD_CONFIG_LOG_OUTPUT OPENTHREAD_CONFIG_LOG_OUTPUT_PLATFORM_DEFINED

/**
* @def OPENTHREAD_CONFIG_CLI_LOG_INPUT_OUTPUT_ENABLE
*
* Define as 1 for CLI to emit its command input string and the resulting output to the logs.
*
*/
#define OPENTHREAD_CONFIG_CLI_LOG_INPUT_OUTPUT_ENABLE 1

/**
* @def OPENTHREAD_CONFIG_CLI_LOG_INPUT_OUTPUT_LEVEL
*
* Defines the log level to use when CLI emits its command input/output to the logs.
*
*/
#define OPENTHREAD_CONFIG_CLI_LOG_INPUT_OUTPUT_LEVEL OT_LOG_LEVEL_INFO

/**
* @def OPENTHREAD_CONFIG_DNS_DSO_ENABLE
*
* Define to 1 to enable DSO support.
*
*/
#define OPENTHREAD_CONFIG_DNS_DSO_ENABLE 1

/**
* @def OPENTHREAD_CONFIG_HEAP_EXTERNAL_ENABLE
*
* Enable the external heap.
*
*/
#define OPENTHREAD_CONFIG_HEAP_EXTERNAL_ENABLE 1

/**
* @def OPENTHREAD_CONFIG_RADIO_STATS_ENABLE
*
* Disable the radio statistics.
*
*/
#define OPENTHREAD_CONFIG_RADIO_STATS_ENABLE 0

#endif /* OPENTHREAD_CORE_TORANJ_CONFIG_SIMULATION_H_ */
Loading

0 comments on commit 5beae14

Please sign in to comment.