Formated comments in headers

This commit is contained in:
Tomas Rivera
2026-04-05 15:51:42 +02:00
parent 514046dadc
commit 8da1a430d7
4 changed files with 58 additions and 59 deletions
+20 -20
View File
@@ -12,27 +12,27 @@
#include <limits.h>
#include <regex.h>
#include "utils.h"
/*Uses ncurses to get an input from the user.
Creates a new note with this input.
also can create a journal if the name matches with journalRegex.
returns the path to the note. */
char *createNewNote(char dirToVault[PATH_MAX], char *vaultFromDir, char *bypass, char *journalRegex, int debug);
// Uses ncurses to get an input from the user
// Creates a new note with this input
// also can create a journal if the name matches with journalRegex
// returns the name of the note
/*Uses ncurses to get an input from the user.
Creates a new vault with this input.
If vault already exists, prints a warning.
returns nothing. */
void createNewVault(char *dirToVault, int debug);
// Uses ncurses to get an input from the user
// Creates a new vault with this input
// If vault already exists, prints a warning
// returns nothing
/*this function is used multiple times let the user select one options from many with ncurses in a TUI.
options is the array of strings with all the options.
optionsText is the text that will be printed at the top (For example: "Please select ...").
we distinguish options from extraOptions.
options could be the list of all notes or all vaults.
extraOptions are options that are special and have a special color (for ex: "Delete vault", "Settings", etc.).
note: extraOptions should be at the end of options.
topText is printed between options text and the start of options.
middleText (usally \n) is printed between options and extraOptions.
bottomText is printed bellow.
topText and middle must be exactly one line. If you want empty lines use " " and not "".
returns the selected option. */
char* ncursesSelect(char **options, char *optionsText, size_t optionsNumber, size_t extraOptionsNumber, char *bottomText, char *middleText, char *topText, int debug);
// this function is used multiple times let the user select one options from many with ncurses in a TUI.
// options is the array of strings with all the options.
// optionsText is the text that will be printed at the top (For example: "Please select ...")
// we distinguish options from extraOptions
// options could be the list of all notes or all vaults
// extraOptions are options that are special and have a special color (for ex: "Delete vault", "Settings", etc.)
// note: extraOptions should be at the end of options
// topText is printed between options text and the start of options
// middleText (usally \n) is printed between options and extraOptions
// bottomText is printed bellow
// topText and middle must be exactly one line. If you want empty lines use " " and not ""
// returns the selected option
#endif