Mirrors_Framework/PX4-Autopilot
1
0
Fork 0
mirror of https://github.com/PX4/PX4-Autopilot.git synced 2026-06-02 03:49:12 +08:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

module template: move documentation to a new category 'template' (#9324)

Browse Source
This commit is contained in:
Beat Küng
2018-04-18 14:53:52 +02:00
committed by Daniel Agar
parent a05bf390c1
commit e46e6f99f3
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Tools/px4moduledoc/srcparser.py
+1 -1
View File
@@ -9,7 +9,7 @@ class ModuleDocumentation(object):
""" """
valid_categories = ['driver', 'estimator', 'controller', 'system', valid_categories = ['driver', 'estimator', 'controller', 'system',
'communication', 'command'] 'communication', 'command', 'template']
max_line_length = 80 # wrap lines that are longer than this max_line_length = 80 # wrap lines that are longer than this
src/platforms/px4_module.h
+1 -1
View File
@@ -403,7 +403,7 @@ __EXPORT void PRINT_MODULE_DESCRIPTION(const char *description);
/** /**
* Print the command name * Print the command name
* @param executable_name: command name used in scripts & CLI * @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); __EXPORT void PRINT_MODULE_USAGE_NAME(const char *executable_name, const char *category);
src/templates/module/module.cpp
+1 -1
View File
@@ -63,7 +63,7 @@ $ module start -f -p 42
)DESCR_STR"); )DESCR_STR");
PRINT_MODULE_USAGE_NAME("module", "system"); PRINT_MODULE_USAGE_NAME("module", "template");
PRINT_MODULE_USAGE_COMMAND("start"); PRINT_MODULE_USAGE_COMMAND("start");
PRINT_MODULE_USAGE_PARAM_FLAG('f', "Optional example flag", true); PRINT_MODULE_USAGE_PARAM_FLAG('f', "Optional example flag", true);
PRINT_MODULE_USAGE_PARAM_INT('p', 0, 0, 1000, "Optional example parameter", true); PRINT_MODULE_USAGE_PARAM_INT('p', 0, 0, 1000, "Optional example parameter", true);