From 8c9164677fa2ef5c80eb60cea1580656ceef141a Mon Sep 17 00:00:00 2001 From: William Date: Thu, 17 Oct 2024 19:43:17 -0700 Subject: [PATCH 1/5] docs: menu_ is now documented --- .vscode/settings.json | 5 ++--- src/fileCLI/fileCLI.hpp | 7 +++++++ 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 615c700f..c48243f0 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -58,9 +58,8 @@ "semaphore": "cpp", "span": "cpp" }, - "particle.firmwareVersion": "5.3.0", - "particle.targetPlatform": "tracker", - "particle.targetDevice": "", + "particle.firmwareVersion": "5.3.1", + "particle.targetPlatform": "boron", "cmake.configureOnOpen": false, "C_Cpp.default.cppStandard": "c++11", "C_Cpp.default.cStandard": "c11", diff --git a/src/fileCLI/fileCLI.hpp b/src/fileCLI/fileCLI.hpp index 2603d1be..0e55c17a 100644 --- a/src/fileCLI/fileCLI.hpp +++ b/src/fileCLI/fileCLI.hpp @@ -93,6 +93,13 @@ class FileCLI{ DIR* dir_stack[FILE_CLI_MAX_DIR_DEPTH]; char path_stack[FILE_CLI_MAX_DIR_DEPTH][NAME_MAX]; int current_dir; + + /** + * @brief Structure representing a command menu entry for FileCLI. + * + * Associated specific user commands with specific actions. + * The findCommand function then finds the matching command in the menu. + */ typedef struct menu_ { const char cmd; From fd3ef27c16882a7c122ad6b22777aba013098a8a Mon Sep 17 00:00:00 2001 From: William Date: Thu, 17 Oct 2024 21:27:18 -0700 Subject: [PATCH 2/5] fix: fields inside menu_ documented. revert unintended changes --- .vscode/settings.json | 4 ++-- src/fileCLI/fileCLI.hpp | 6 ++---- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index c48243f0..50b98364 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -58,8 +58,8 @@ "semaphore": "cpp", "span": "cpp" }, - "particle.firmwareVersion": "5.3.1", - "particle.targetPlatform": "boron", + "particle.firmwareVersion": "5.3.0", + "particle.targetPlatform": "tracker", "cmake.configureOnOpen": false, "C_Cpp.default.cppStandard": "c++11", "C_Cpp.default.cStandard": "c11", diff --git a/src/fileCLI/fileCLI.hpp b/src/fileCLI/fileCLI.hpp index 0e55c17a..07b2c42e 100644 --- a/src/fileCLI/fileCLI.hpp +++ b/src/fileCLI/fileCLI.hpp @@ -97,13 +97,11 @@ class FileCLI{ /** * @brief Structure representing a command menu entry for FileCLI. * - * Associated specific user commands with specific actions. - * The findCommand function then finds the matching command in the menu. */ typedef struct menu_ { - const char cmd; - void (FileCLI::*fn)(void); + const char cmd; /**< A character representing a user command. */ + void (FileCLI::*fn)(void); /**< A pointer to a FileCLI member function. */ } menu_t; static menu_t fsExplorerMenu[]; /** From 7bf96648fc7af8330e4089b2409e3c23420b5ea8 Mon Sep 17 00:00:00 2001 From: William Date: Thu, 24 Oct 2024 20:24:24 -0700 Subject: [PATCH 3/5] docs: menu_ now has more detailed documentation. revert unintended changes --- .vscode/settings.json | 1 + src/fileCLI/fileCLI.hpp | 6 ++++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 50b98364..615c700f 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -60,6 +60,7 @@ }, "particle.firmwareVersion": "5.3.0", "particle.targetPlatform": "tracker", + "particle.targetDevice": "", "cmake.configureOnOpen": false, "C_Cpp.default.cppStandard": "c++11", "C_Cpp.default.cStandard": "c11", diff --git a/src/fileCLI/fileCLI.hpp b/src/fileCLI/fileCLI.hpp index 07b2c42e..df1e98b8 100644 --- a/src/fileCLI/fileCLI.hpp +++ b/src/fileCLI/fileCLI.hpp @@ -100,8 +100,10 @@ class FileCLI{ */ typedef struct menu_ { - const char cmd; /**< A character representing a user command. */ - void (FileCLI::*fn)(void); /**< A pointer to a FileCLI member function. */ + const char + cmd; /**< A character representing a user command. Will trigger a specific function. */ + void (FileCLI::*fn)( + void); /**< A pointer to a place in ram where a function with properties is held. */ } menu_t; static menu_t fsExplorerMenu[]; /** From 0da8c2cc2e3a33847b503ccdb7f550c4fd84b42e Mon Sep 17 00:00:00 2001 From: William Date: Thu, 31 Oct 2024 20:48:42 -0700 Subject: [PATCH 4/5] docs: change docstring format + more detailed documentation --- src/fileCLI/fileCLI.hpp | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/src/fileCLI/fileCLI.hpp b/src/fileCLI/fileCLI.hpp index df1e98b8..f7c2ee79 100644 --- a/src/fileCLI/fileCLI.hpp +++ b/src/fileCLI/fileCLI.hpp @@ -100,10 +100,15 @@ class FileCLI{ */ typedef struct menu_ { - const char - cmd; /**< A character representing a user command. Will trigger a specific function. */ - void (FileCLI::*fn)( - void); /**< A pointer to a place in ram where a function with properties is held. */ + /** + * A character representing a user command. Will trigger a specific function. + */ + const char cmd; + /** + * A pointer to a place in ram where a function with properties is held. Executes the + * command associated with cmd. + */ + void (FileCLI::*fn)(void); } menu_t; static menu_t fsExplorerMenu[]; /** From e7db8afbe54c8fb6e6690affac1125bcbfdfabbe Mon Sep 17 00:00:00 2001 From: William Date: Thu, 7 Nov 2024 15:54:55 -0800 Subject: [PATCH 5/5] docs: correct menu_ documentation --- src/fileCLI/fileCLI.hpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/fileCLI/fileCLI.hpp b/src/fileCLI/fileCLI.hpp index f7c2ee79..e40852d6 100644 --- a/src/fileCLI/fileCLI.hpp +++ b/src/fileCLI/fileCLI.hpp @@ -105,8 +105,8 @@ class FileCLI{ */ const char cmd; /** - * A pointer to a place in ram where a function with properties is held. Executes the - * command associated with cmd. + * A pointer to a place in flash memory or RAM where a function with properties is held. + * Executes the command associated with cmd. */ void (FileCLI::*fn)(void); } menu_t;