From c963557d9a7379b669dac3b6e0f021d2e80386dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beat=20K=C3=BCng?= Date: Wed, 18 Apr 2018 11:19:48 +0200 Subject: [PATCH] module template: move documentation to a new category 'template' --- Tools/px4moduledoc/srcparser.py | 2 +- src/platforms/px4_module.h | 2 +- src/templates/module/module.cpp | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Tools/px4moduledoc/srcparser.py b/Tools/px4moduledoc/srcparser.py index eabca6ec0ffe..79df90f054ba 100644 --- a/Tools/px4moduledoc/srcparser.py +++ b/Tools/px4moduledoc/srcparser.py @@ -9,7 +9,7 @@ class ModuleDocumentation(object): """ valid_categories = ['driver', 'estimator', 'controller', 'system', - 'communication', 'command'] + 'communication', 'command', 'template'] max_line_length = 80 # wrap lines that are longer than this diff --git a/src/platforms/px4_module.h b/src/platforms/px4_module.h index 29c41bee976b..8a711cb0eed6 100644 --- a/src/platforms/px4_module.h +++ b/src/platforms/px4_module.h @@ -403,7 +403,7 @@ __EXPORT void PRINT_MODULE_DESCRIPTION(const char *description); /** * Print the command name * @param executable_name: command name used in scripts & CLI - * @param category one of: driver, estimator, controller, system, communication, command + * @param category one of: driver, estimator, controller, system, communication, command, template */ __EXPORT void PRINT_MODULE_USAGE_NAME(const char *executable_name, const char *category); diff --git a/src/templates/module/module.cpp b/src/templates/module/module.cpp index 42ab0e475d1b..252770866847 100644 --- a/src/templates/module/module.cpp +++ b/src/templates/module/module.cpp @@ -63,7 +63,7 @@ CLI usage example: )DESCR_STR"); - PRINT_MODULE_USAGE_NAME("module", "system"); + PRINT_MODULE_USAGE_NAME("module", "template"); PRINT_MODULE_USAGE_COMMAND("start"); PRINT_MODULE_USAGE_PARAM_FLAG('f', "Optional example flag", true); PRINT_MODULE_USAGE_PARAM_INT('p', 0, 0, 1000, "Optional example parameter", true);