From 08e4ec7fd392cd6141937c2233999dd0e39424b2 Mon Sep 17 00:00:00 2001 From: Alessio Morale Date: Sat, 7 Jun 2014 15:45:27 +0200 Subject: [PATCH] OP-1365 Flight code instrumentation API: Fix wrapper documentation/headers --- flight/libraries/inc/instrumentation.h | 11 ++++++++--- flight/libraries/instrumentation.c | 4 ++-- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/flight/libraries/inc/instrumentation.h b/flight/libraries/inc/instrumentation.h index f6734ab0b..02c0cd90e 100644 --- a/flight/libraries/inc/instrumentation.h +++ b/flight/libraries/inc/instrumentation.h @@ -3,8 +3,8 @@ * * @file instrumentation.h * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2014. - * @brief brief goes here. - * -- + * @brief Instrumentation infrastructure + * UAVObject wrapper layer for PiOS instrumentation * @see The GNU Public License (GPL) Version 3 * *****************************************************************************/ @@ -26,9 +26,14 @@ #ifndef INSTRUMENTATION_H #define INSTRUMENTATION_H #include - +/** + * Initialize the instrumentationUAVObject wrapper + */ void InstrumentationInit(); +/** + * publish all counters to UAVObjects + */ void InstrumentationPublishAllCounters(); #endif /* INSTRUMENTATION_H */ diff --git a/flight/libraries/instrumentation.c b/flight/libraries/instrumentation.c index 927fcc7af..9d6bcb483 100644 --- a/flight/libraries/instrumentation.c +++ b/flight/libraries/instrumentation.c @@ -3,8 +3,8 @@ * * @file instrumentation.c * @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2014. - * @brief brief goes here. - * -- + * @brief Instrumentation infrastructure + * UAVObject wrapper layer for PiOS instrumentation * @see The GNU Public License (GPL) Version 3 * *****************************************************************************/