From 1eddb8e84f11e44752f2ea0aa935997aaacdaa55 Mon Sep 17 00:00:00 2001 From: Robert McMahon Date: Sat, 27 Dec 2025 19:34:21 -0800 Subject: [PATCH] Refactor file headers and clean up comments in multiple source files - Updated file headers in iperf.c to include trip-time support in the brief description. - Removed unnecessary comment blocks in cmd_ip.c, cmd_nvs.c, app_console.c, and wifi_cfg.c to streamline the codebase. --- components/app_console/app_console.c | 6 ------ components/app_console/cmd_ip.c | 6 ------ components/app_console/cmd_nvs.c | 6 ------ components/iperf/iperf.c | 28 +++++++++++----------------- components/wifi_cfg/wifi_cfg.c | 6 ------ 5 files changed, 11 insertions(+), 41 deletions(-) diff --git a/components/app_console/app_console.c b/components/app_console/app_console.c index 7eaea31..bcf786f 100644 --- a/components/app_console/app_console.c +++ b/components/app_console/app_console.c @@ -30,12 +30,6 @@ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ -/* - * app_console.c - * - * Copyright (c) 2025 Umber Networks & Robert McMahon - * All rights reserved. - */ #include "app_console.h" #include "esp_console.h" diff --git a/components/app_console/cmd_ip.c b/components/app_console/cmd_ip.c index cce9059..e56df8b 100644 --- a/components/app_console/cmd_ip.c +++ b/components/app_console/cmd_ip.c @@ -30,12 +30,6 @@ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ -/* - * cmd_ip.c - * - * Copyright (c) 2025 Umber Networks & Robert McMahon - * All rights reserved. - */ #include #include diff --git a/components/app_console/cmd_nvs.c b/components/app_console/cmd_nvs.c index 15dce39..92d3838 100644 --- a/components/app_console/cmd_nvs.c +++ b/components/app_console/cmd_nvs.c @@ -30,12 +30,6 @@ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ -/* - * cmd_nvs.c - * - * Copyright (c) 2025 Umber Networks & Robert McMahon - * All rights reserved. - */ #include #include diff --git a/components/iperf/iperf.c b/components/iperf/iperf.c index d6f93ef..439f17f 100644 --- a/components/iperf/iperf.c +++ b/components/iperf/iperf.c @@ -30,24 +30,18 @@ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ - /** - * @file iperf.c - * @brief ESP32 iPerf Traffic Generator (UDP Client Only) - * - * This module implements a lightweight UDP traffic generator compatible with iPerf2. - * It features: - * - Precise packet pacing (PPS) using monotonic timers (drift-free). - * - Finite State Machine (FSM) to detect stalls and slow links. - * - Non-Volatile Storage (NVS) for persistent configuration. - * - Detailed error tracking (ENOMEM vs Route errors). - * - GPS Timestamp integration for status reporting. - * @brief ESP32 iPerf Traffic Generator (UDP Client Only) with Trip-Time Support - */ -/* - * iperf.c + +/** + * @file iperf.c + * @brief ESP32 iPerf Traffic Generator (UDP Client Only) with Trip-Time Support * - * Copyright (c) 2025 Umber Networks & Robert McMahon - * All rights reserved. + * This module implements a lightweight UDP traffic generator compatible with iPerf2. + * It features: + * - Precise packet pacing (PPS) using monotonic timers (drift-free). + * - Finite State Machine (FSM) to detect stalls and slow links. + * - Non-Volatile Storage (NVS) for persistent configuration. + * - Detailed error tracking (ENOMEM vs Route errors). + * - GPS Timestamp integration for status reporting. */ #include #include diff --git a/components/wifi_cfg/wifi_cfg.c b/components/wifi_cfg/wifi_cfg.c index 92640b9..ea7fed2 100644 --- a/components/wifi_cfg/wifi_cfg.c +++ b/components/wifi_cfg/wifi_cfg.c @@ -30,12 +30,6 @@ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ -/* - * wifi_cfg.c - * - * Copyright (c) 2025 Umber Networks & Robert McMahon - * All rights reserved. - */ #include "wifi_cfg.h" #include