add missing documentation
This commit is contained in:
		@@ -14,10 +14,8 @@
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
namespace aman {
 | 
					namespace aman {
 | 
				
			||||||
    /**
 | 
					    /**
 | 
				
			||||||
     * @brief Defines the base class for all file formats
 | 
					     * @brief Defines the aircraft reporter class which sends aircraft information to the backend
 | 
				
			||||||
     * @ingroup format
 | 
					     * @ingroup com
 | 
				
			||||||
     *
 | 
					 | 
				
			||||||
     * The base class provides error information, etc.
 | 
					 | 
				
			||||||
     */
 | 
					     */
 | 
				
			||||||
    class AircraftReporter {
 | 
					    class AircraftReporter {
 | 
				
			||||||
    private:
 | 
					    private:
 | 
				
			||||||
@@ -42,12 +40,26 @@ namespace aman {
 | 
				
			|||||||
        AircraftReporter& operator=(const AircraftReporter&) = delete;
 | 
					        AircraftReporter& operator=(const AircraftReporter&) = delete;
 | 
				
			||||||
        AircraftReporter& operator=(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);
 | 
					        bool initialize(const Communication& configuration);
 | 
				
			||||||
 | 
					        /**
 | 
				
			||||||
 | 
					         * @brief Terminates the reporter connection
 | 
				
			||||||
 | 
					         */
 | 
				
			||||||
        bool deinitialize();
 | 
					        bool deinitialize();
 | 
				
			||||||
 | 
					        /**
 | 
				
			||||||
        bool send(zmq::message_t& message);
 | 
					         * @brief Sends a new message to the backend
 | 
				
			||||||
 | 
					         * @param[in] report The new aircraft report
 | 
				
			||||||
        static AircraftReporter& instance();
 | 
					         * @return True if the report is sent, else false
 | 
				
			||||||
 | 
					         */
 | 
				
			||||||
        bool send(const aman::AircraftReport& report);
 | 
					        bool send(const aman::AircraftReport& report);
 | 
				
			||||||
 | 
					        /**
 | 
				
			||||||
 | 
					         * @brief Returns the reporter instance
 | 
				
			||||||
 | 
					         * @return The system-wide instance
 | 
				
			||||||
 | 
					         */
 | 
				
			||||||
 | 
					        static AircraftReporter& instance() noexcept;
 | 
				
			||||||
    };
 | 
					    };
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -79,7 +79,7 @@ bool AircraftReporter::send(const aman::AircraftReport& report) {
 | 
				
			|||||||
    return retval;
 | 
					    return retval;
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
AircraftReporter& AircraftReporter::instance() {
 | 
					AircraftReporter& AircraftReporter::instance() noexcept {
 | 
				
			||||||
    static AircraftReporter __instance;
 | 
					    static AircraftReporter __instance;
 | 
				
			||||||
    return __instance;
 | 
					    return __instance;
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user