From f3c28dd2f1a27ee8039a86942ccd2277fbb4102e Mon Sep 17 00:00:00 2001 From: Clyne Sullivan Date: Sun, 8 Oct 2023 16:32:23 -0400 Subject: add to firmware documentation --- firmware/source/communication.hpp | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'firmware/source/communication.hpp') diff --git a/firmware/source/communication.hpp b/firmware/source/communication.hpp index 03220b8..a4f818a 100644 --- a/firmware/source/communication.hpp +++ b/firmware/source/communication.hpp @@ -2,7 +2,7 @@ * @file communication.hpp * @brief Manages communication with the host computer. * - * Copyright (C) 2021 Clyne Sullivan + * Copyright (C) 2023 Clyne Sullivan * * Distributed under the GNU GPL v3 or later. You should have received a copy of * the GNU General Public License along with this program. @@ -17,9 +17,17 @@ class CommunicationManager { public: + /** + * Starts the communication manager thread (threadComm). + */ static void begin(); private: + /** + * Continuously polls the USB serial connection, handling received commands + * as necessary. + * Does not return. + */ static void threadComm(void *); static std::array m_thread_stack; -- cgit v1.2.3