From 4546ce803e5fb89c57bb415c9422ca27d1dae849 Mon Sep 17 00:00:00 2001 From: Felix Ruess Date: Sat, 23 Apr 2016 22:33:31 +0200 Subject: [PATCH] [doc] gen_modules_doc: use cleandoc for better indentation handling of module descriptions --- conf/modules/logger_dataflash.xml | 24 ++++++++++++------------ conf/modules/nav_survey_polygon.xml | 24 ++++++++++++------------ sw/tools/doxygen_gen/gen_modules_doc.py | 3 ++- 3 files changed, 26 insertions(+), 25 deletions(-) diff --git a/conf/modules/logger_dataflash.xml b/conf/modules/logger_dataflash.xml index 14f2ff7ee8..e018996c27 100644 --- a/conf/modules/logger_dataflash.xml +++ b/conf/modules/logger_dataflash.xml @@ -3,23 +3,23 @@ -SPI logger -A logger that connects and manage a memory directly connected to th SPI. + SPI logger + A logger that connects and manage a memory directly connected to th SPI. -This module includes some configurations : -- @b ERASE_MEMORY_AT_START : if set to 1 the memory will be erased completly when starting a new log. This will take a little bit less than a minute, but afterwards you will be able to log values at a higher rate than if you didn't do it. If you let it to 0, the module is going to erase the memory block by block of 4K when needed. -- @b SIZE_OF_LOGGED_VALUES : the number of Bytes that each value logged must be (in memory). You can write a 4 Bytes values in a 2 Bytes slots, you just need to be certain that you don't have any overflows. -- @b NBR_VALUES_TO_LOG : the number of messages you want to log. This value is equivalent to the size of the values_to_log array. -- @b SKIP_X_CALLS_BETWEEN_VALUES : you might want to slow down the logger instead of losing values (because of buffer overflows). if that value is set to 0, a new value of every logged messages will be added to the buffer. If set to 2, we will wait two calls to the module, then during the third one we will writte the values to the buffer. By default this modules is called at 512Hz. + This module includes some configurations : + - @b ERASE_MEMORY_AT_START : if set to 1 the memory will be erased completly when starting a new log. This will take a little bit less than a minute, but afterwards you will be able to log values at a higher rate than if you didn't do it. If you let it to 0, the module is going to erase the memory block by block of 4K when needed. + - @b SIZE_OF_LOGGED_VALUES : the number of Bytes that each value logged must be (in memory). You can write a 4 Bytes values in a 2 Bytes slots, you just need to be certain that you don't have any overflows. + - @b NBR_VALUES_TO_LOG : the number of messages you want to log. This value is equivalent to the size of the values_to_log array. + - @b SKIP_X_CALLS_BETWEEN_VALUES : you might want to slow down the logger instead of losing values (because of buffer overflows). if that value is set to 0, a new value of every logged messages will be added to the buffer. If set to 2, we will wait two calls to the module, then during the third one we will writte the values to the buffer. By default this modules is called at 512Hz. -Then you have two arrays : + Then you have two arrays : -- @b values_to_log : containing the pointer to the values to log. -- @b name_of_the_values : the name of the messages logged. This is simply an aesthetic configuration, for you to know which message were logged. + - @b values_to_log : containing the pointer to the values to log. + - @b name_of_the_values : the name of the messages logged. This is simply an aesthetic configuration, for you to know which message were logged. -The applicaton to read the memory back is available here : http://karlito139.github.io/lisa_s_logger_reader/ + The applicaton to read the memory back is available here : http://karlito139.github.io/lisa_s_logger_reader/ -For more informations on how to use this module you can refer to the wiki : http://wiki.paparazziuav.org/wiki/Micro_logger + For more informations on how to use this module you can refer to the wiki : http://wiki.paparazziuav.org/wiki/Micro_logger diff --git a/conf/modules/nav_survey_polygon.xml b/conf/modules/nav_survey_polygon.xml index 10bc399186..889a64df2a 100644 --- a/conf/modules/nav_survey_polygon.xml +++ b/conf/modules/nav_survey_polygon.xml @@ -3,18 +3,18 @@ -Survey a polygon with a fixedwing. -From Uni Stuttgart. -In the flight plan, the survey blocks call init and run functions: -1. Initialize the variables needed for the survey to start, with nav_survey_polygon_setup(first_wp, size, angle, sweep_width, shot_dist, min_rad, altitude): - - first_wp the first Waypoint of the polygon (WP_waypoint_name) - - size the number of points that make up the polygon - - angle angle in which to do the flyovers - - sweep_width distance between the sweeps - - shot_dist distance between the shots - - min_rad minimal radius when navigating - - altitude the altitude that must be reached before the flyover starts -2. Run the survey with nav_survey_polygon_run() + Survey a polygon with a fixedwing. + From Uni Stuttgart. + In the flight plan, the survey blocks call init and run functions: + 1. Initialize the variables needed for the survey to start, with nav_survey_polygon_setup(first_wp, size, angle, sweep_width, shot_dist, min_rad, altitude): + - first_wp the first Waypoint of the polygon (WP_waypoint_name) + - size the number of points that make up the polygon + - angle angle in which to do the flyovers + - sweep_width distance between the sweeps + - shot_dist distance between the shots + - min_rad minimal radius when navigating + - altitude the altitude that must be reached before the flyover starts + 2. Run the survey with nav_survey_polygon_run()