Skip to content

Commit

Permalink
63 docs: menu_ is now documented (#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
ntlhui authored Nov 12, 2024
2 parents 2ae35b2 + 279df17 commit dcef53e
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/fileCLI/fileCLI.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,21 @@ 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.
*
*/
typedef struct menu_
{
/**
* A character representing a user command. Will trigger a specific function.
*/
const char 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;
static menu_t fsExplorerMenu[];
Expand Down

0 comments on commit dcef53e

Please sign in to comment.