Commit Graph

22807 Commits

Author SHA1 Message Date
Beat Küng 674ae5292e markdown module doc script: write how to generate the modules documentation 2017-07-14 11:57:11 +02:00
Beat Küng 05b0c412c8 sensors: extend module doc a bit 2017-07-14 11:57:11 +02:00
Beat Küng 36c9400de4 gps: use ModuleBase class & add documentation
Note: it changes the interface slightly: instead uf -dualgps, use -e now.

This also fixes 2 bugs:
- nullptr access when doing 'gps status' with fake gps running
- close(fd) was called on an uninitialized fd when gps fake was running
2017-07-14 11:57:11 +02:00
Beat Küng 6463bd4f6f sensors: use ModuleBase & add documentation 2017-07-14 11:57:11 +02:00
Beat Küng 5923a2e9d0 src/mainpage.dox: remove this file, it's not used anymore & completely outdated 2017-07-14 11:57:11 +02:00
Beat Küng a43f135ad4 minor documentation updates to some commands 2017-07-14 11:57:11 +02:00
Beat Küng 7d50f3df0a Makefile: add module_documentation target 2017-07-14 11:57:11 +02:00
Beat Küng 7a4f557a7a px_process_module_doc: separate page into one page per category 2017-07-14 11:57:11 +02:00
Beat Küng 05c3b711f3 fix bl_update: move definition of print_usage into the ifdef
fixes the compile error:
error: 'print_usage' defined but not used [-Werror=unused-function]
2017-07-14 11:57:11 +02:00
Beat Küng a4ca3fc607 ver: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng 68d754b65e usb_connected: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng 8e965a7a2a topic_listener: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng 1b4467f674 sd_bench: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng 06178392ce reboot: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng 16e0e1f7ca perf: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng ba1a483cd6 nshterm: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng 65b11d39a9 mtd: add documentation & do cleanup (remove err(), ...) 2017-07-14 11:57:11 +02:00
Beat Küng e362f760c4 motor_test: add documentation & do cleanup (remove err(), ...) 2017-07-14 11:57:11 +02:00
Beat Küng 4839ed8498 motor_ramp: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng 3a880a09d6 mixer: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng b18a148129 led_control: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng 50d1ed99b0 i2c commmand: remove errx 2017-07-14 11:57:11 +02:00
Beat Küng 6b99b3412e esc_calib: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng 0fdd2b9fea dumpfile: add documentation & do cleanup (remove err(), ...) 2017-07-14 11:57:11 +02:00
Beat Küng 7893623d75 fix dumpfile: specify stack size 2017-07-14 11:57:11 +02:00
Beat Küng 4ea44e51b7 config.c: add documentation & do cleanup (remove err(), ...)
Also changes the order of the arguments for consistency.
2017-07-14 11:57:11 +02:00
Beat Küng be25c337f9 bl_update: add documentation & do cleanup (remove err(), ...) 2017-07-14 11:57:11 +02:00
Beat Küng 35aa95c25f perf_counter.c: mention that the latency buckets are in us 2017-07-14 11:57:11 +02:00
Beat Küng 872049dc57 pwm.cpp: extend documentation for Oneshot 2017-07-14 11:57:11 +02:00
Beat Küng fac6a829c4 pwm.cpp: fix issues by clang tidy (nullptr & void) 2017-07-14 11:57:11 +02:00
Beat Küng 37ff267b68 param.cpp: fix issues by clang tidy (nullptr & void) 2017-07-14 11:57:11 +02:00
Beat Küng b32b0d9b17 hardfault_log: add documentation 2017-07-14 11:57:11 +02:00
Beat Küng 488bc9d7f3 hardfault_log.h: fix comments 2017-07-14 11:57:11 +02:00
Beat Küng 3b0da512a5 px_process_module_doc: add --no-validation flag
and make sure the command failed if there's a validation error.
2017-07-14 11:57:11 +02:00
Beat Küng d309617998 param.c: rename to cpp and add module documentation
use c++ so that raw string literals can be used
2017-07-14 11:57:11 +02:00
Beat Küng 647bdef855 pwm.c: rename to pwm.cpp and add module documentation
use c++ so that raw string literals can be used
2017-07-14 11:57:11 +02:00
Beat Küng 3f6769d41e uorb: add module documentation 2017-07-14 11:57:11 +02:00
Beat Küng f25549169c fmu: wait until running, and handle mode_rcin properly
when the fmu was already running in a pwm mode, changing to mode_rcin would
not have any effect.
2017-07-14 11:57:11 +02:00
Beat Küng 3b64be44f4 ModuleBase: add wait_until_running() method 2017-07-14 11:57:11 +02:00
Beat Küng 6778be2c6e mavlink: remove 'p' from px4_getopt()
It is not handled and not documented.
2017-07-14 11:57:11 +02:00
Beat Küng 0909b58981 fmu.cpp: fix wrong command usage mode_pwm3cap2 -> mode_pwm2cap2 2017-07-14 11:57:11 +02:00
Beat Küng 053eb12329 Module documentation: switch to Markdown 2017-07-14 11:57:11 +02:00
Beat Küng 6c9574b336 Tools/px_process_module_doc.py: add script to extract documentation
And turn it into a markdown page.
It also does some simple validation, to check that the getopt() arguments
match the documentation.
2017-07-14 11:57:11 +02:00
Beat Küng c22b79ece5 pwm.c: fix wrong comment 2017-07-14 11:57:11 +02:00
Beat Küng 45bc882f5d px_process_params: fix scope when script is called from repo root
If called with ./Tools/px_process_params.py, the path would start with
src/<module>, and thus not match the regex "^.*/src/"
2017-07-14 11:57:11 +02:00
Beat Küng 41e53ef949 px_process_airframes: add image path as optional argument for markdown output
usage:
./px_process_airframes.py -m -i ../image/path
2017-07-14 11:57:11 +02:00
Beat Küng 63af349bba px4_module.h: include <cstring> for strcmp() 2017-07-14 11:57:11 +02:00
Beat Küng 59bde454b5 ModuleBase: instanciate -> instantiate 2017-07-14 11:57:11 +02:00
Beat Küng f691ae2a4f mavlink: update usage & module description 2017-07-14 11:57:11 +02:00
Beat Küng 2ad7194ed3 pwm command: update usage 2017-07-14 11:57:11 +02:00