Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Apr 18, 2018
+3 −3
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Tools/px4moduledoc/srcparser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/platforms/px4_module.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
2 changes: 1 addition & 1 deletion src/templates/module/module.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down