Skip to content

Commit

Permalink
[state_interface] doxygen: move short explanation to group
Browse files Browse the repository at this point in the history
  • Loading branch information
flixr committed Sep 5, 2012
1 parent 16d2288 commit d70a675
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions sw/airborne/state.h
Expand Up @@ -23,16 +23,7 @@
*
* API to get/set the generic vehicle states.
*
* This general state interface holds all the most important vehicle states like
* position, velocity, attitude, etc. It handles coordinate system and
* fixed-/floating-point conversion on the fly when needed.
*
* You can set e.g. the position in any coordinate system you wish:
* stateSetPositionNed_i() to set the position in fixed-point NED coordinates.
* If you need to read the position somewhere else in a different representation,
* call: stateGetPositionLla_f() and only then the LLA float position representation
* is calculated on the fly and returned. It's also only calculated once,
* until a new position is set which invalidates all the other representations again.
* Also see @ref StateGroup "State Interface" page.
*
* @author Felix Ruess <felix.ruess@gmail.com>
*/
Expand All @@ -48,6 +39,19 @@
#include "std.h"
#include <string.h>

/**
* This general state interface holds all the most important vehicle states like
* position, velocity, attitude, etc. It handles coordinate system and
* fixed-/floating-point conversion on the fly when needed.
*
* You can set e.g. the position in any coordinate system you wish:
* stateSetPositionNed_i() to set the position in fixed-point NED coordinates.
* If you need to read the position somewhere else in a different representation,
* call: stateGetPositionLla_f() and only then the LLA float position representation
* is calculated on the fly and returned. It's also only calculated once,
* until a new position is set which invalidates all the other representations again.
*/

/**
* @defgroup StateGroup State interface
* @{
Expand Down

0 comments on commit d70a675

Please sign in to comment.