From 0fa3559fc49bf632ed552ea92868f16d3ab212de Mon Sep 17 00:00:00 2001
From: Sven Czarnian <devel@svcz.de>
Date: Thu, 19 Aug 2021 08:20:54 +0200
Subject: [PATCH] add missing documentation

---
 include/aman/com/AircraftReporter.h | 28 ++++++++++++++++++++--------
 src/com/AircraftReporter.cpp        |  2 +-
 2 files changed, 21 insertions(+), 9 deletions(-)

diff --git a/include/aman/com/AircraftReporter.h b/include/aman/com/AircraftReporter.h
index 19d52af..55d83b2 100644
--- a/include/aman/com/AircraftReporter.h
+++ b/include/aman/com/AircraftReporter.h
@@ -14,10 +14,8 @@
 
 namespace aman {
     /**
-     * @brief Defines the base class for all file formats
-     * @ingroup format
-     *
-     * The base class provides error information, etc.
+     * @brief Defines the aircraft reporter class which sends aircraft information to the backend
+     * @ingroup com
      */
     class AircraftReporter {
     private:
@@ -42,12 +40,26 @@ namespace aman {
         AircraftReporter& operator=(const AircraftReporter&) = delete;
         AircraftReporter& operator=(AircraftReporter&&) = delete;
 
+        /**
+         * @brief Initializes the aircraft reporter
+         * @param[in] configuration The current AMAM communication configuration
+         * @return True if the initialization is done, else false
+         */
         bool initialize(const Communication& configuration);
+        /**
+         * @brief Terminates the reporter connection
+         */
         bool deinitialize();
-
-        bool send(zmq::message_t& message);
-
-        static AircraftReporter& instance();
+        /**
+         * @brief Sends a new message to the backend
+         * @param[in] report The new aircraft report
+         * @return True if the report is sent, else false
+         */
         bool send(const aman::AircraftReport& report);
+        /**
+         * @brief Returns the reporter instance
+         * @return The system-wide instance
+         */
+        static AircraftReporter& instance() noexcept;
     };
 }
diff --git a/src/com/AircraftReporter.cpp b/src/com/AircraftReporter.cpp
index a64476c..2299cae 100644
--- a/src/com/AircraftReporter.cpp
+++ b/src/com/AircraftReporter.cpp
@@ -79,7 +79,7 @@ bool AircraftReporter::send(const aman::AircraftReport& report) {
     return retval;
 }
 
-AircraftReporter& AircraftReporter::instance() {
+AircraftReporter& AircraftReporter::instance() noexcept {
     static AircraftReporter __instance;
     return __instance;
 }