Mirrors_Framework/paparazzi
1
0
Fork 0
mirror of https://github.com/paparazzi/paparazzi.git synced 2026-05-30 03:27:33 +08:00
Code Issues Actions 27 Packages Projects Releases Wiki Activity

[doc] gen_modules_doc: use cleandoc

Browse Source 
for better indentation handling of module descriptions
This commit is contained in:
Felix Ruess
2016-04-23 22:33:31 +02:00
parent c1109c170c
commit 4546ce803e
3 changed files with 26 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
conf/modules/nav_survey_polygon.xml
+12 -12
View File
@@ -3,18 +3,18 @@
<module name="nav_survey_polygon" dir="nav">
<doc>
<description>
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()
<!--
Block example:
@verbatim