mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-06-25 17:00:34 +08:00
module documentation: add support for subcategories
This commit is contained in:
@@ -835,6 +835,7 @@ $ sf1xx stop
|
||||
)DESCR_STR");
|
||||
|
||||
PRINT_MODULE_USAGE_NAME("sf1xx", "driver");
|
||||
PRINT_MODULE_USAGE_SUBCATEGORY("distance_sensor");
|
||||
PRINT_MODULE_USAGE_COMMAND_DESCR("start","Start driver");
|
||||
PRINT_MODULE_USAGE_PARAM_FLAG('a', "Attempt to start driver on all I2C buses", true);
|
||||
PRINT_MODULE_USAGE_PARAM_INT('b', 1, 1, 2000, "Start driver on specific I2C bus", true);
|
||||
|
||||
@@ -64,6 +64,11 @@ void PRINT_MODULE_USAGE_NAME(const char *executable_name, const char *category)
|
||||
PX4_INFO_RAW(" Commands:\n");
|
||||
}
|
||||
|
||||
void PRINT_MODULE_USAGE_SUBCATEGORY(const char *subcategory)
|
||||
{
|
||||
(void)subcategory;
|
||||
}
|
||||
|
||||
void PRINT_MODULE_USAGE_NAME_SIMPLE(const char *executable_name, const char *category)
|
||||
{
|
||||
PX4_INFO_RAW("Usage: %s [arguments...]\n", executable_name);
|
||||
|
||||
@@ -472,6 +472,12 @@ __EXPORT void PRINT_MODULE_DESCRIPTION(const char *description);
|
||||
*/
|
||||
__EXPORT void PRINT_MODULE_USAGE_NAME(const char *executable_name, const char *category);
|
||||
|
||||
/**
|
||||
* @brief Specify a subcategory.
|
||||
* @param subcategory e.g. if the category is 'driver', subcategory can be 'distance_sensor'
|
||||
*/
|
||||
__EXPORT void PRINT_MODULE_USAGE_SUBCATEGORY(const char *subcategory);
|
||||
|
||||
/**
|
||||
* @brief Prints the name for a command without any sub-commands (@see PRINT_MODULE_USAGE_NAME()).
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user