Added documentation for struct Border

This commit is contained in:
Kai S. K. Engelbart 2020-01-09 09:25:42 +01:00
parent d1b97fb011
commit 7934aa988e

9
menu.h
View File

@ -9,7 +9,7 @@ struct MenuItem {
void* (*action)(void); void* (*action)(void);
}; };
/// <summary>Represents a border in which a menu is displayed.</summary>
struct MenuBorder { struct MenuBorder {
char line_vertical; char line_vertical;
char line_horizontal; char line_horizontal;
@ -23,13 +23,6 @@ struct MenuBorder {
const extern struct MenuBorder DEFAULT, MODERN, NO_BORDER, SOLID; const extern struct MenuBorder DEFAULT, MODERN, NO_BORDER, SOLID;
/// <summary>Is used for style-switching</summary>
/// <item name="DEFAULT">Default style with asterisks around the terminal</item>
/// <item name="SOLID">Solid border with ASCII border characters</item>
/// <item name="MODERN">Minimalistic design with bar instead of start>/item>
/// <item name="NO_BORDER">No border, just plain text</item>
/// <summary>Displaces a CUI menu to the user and lets them choose an option, then calls the corresponding function.</summary> /// <summary>Displaces a CUI menu to the user and lets them choose an option, then calls the corresponding function.</summary>
/// <param name="itemc">The length of the array <c>itemv</c> of menu items.</param> /// <param name="itemc">The length of the array <c>itemv</c> of menu items.</param>
/// <param name="itemv">An array of all menu items to display in the menu.</param> /// <param name="itemv">An array of all menu items to display in the menu.</param>