Website Summary Files Commits Branches @commit @diff @stats
path: root / src / Generic / ConsoleInterface
diff options
context:
space:
mode:
Commita8388cfdc47386dcb61f1b5bb9190ce382bf3f1d (patch)
Author
 Syndamia <kamen.d.mladenov@protonmail.com>
2022-05-08 19:50:18 +0300
Committer
 Syndamia <kamen.d.mladenov@protonmail.com>
2022-05-08 19:50:18 +0300
Files9c884826aaffc94664e9e053919336feccfbaeae /src/Generic/ConsoleInterface
FMI-OOP-P1_TicketSystem-a8388cfdc47386dcb61f1b5bb9190ce382bf3f1d.tar
FMI-OOP-P1_TicketSystem-a8388cfdc47386dcb61f1b5bb9190ce382bf3f1d.tar.gz
FMI-OOP-P1_TicketSystem-a8388cfdc47386dcb61f1b5bb9190ce382bf3f1d.zip
Parentde678e3a54bdcb776edb43179ff39e02ffb15d8e (diff)
Fully documented generic classes
2 files changed, 9 insertions, 8 deletions
-rw-r--r--src/Generic/ConsoleInterface/Toolbox.cpp16
-rw-r--r--src/Generic/ConsoleInterface/Toolbox.hpp1
diff --git a/src/Generic/ConsoleInterface/Toolbox.cpp b/src/Generic/ConsoleInterface/Toolbox.cpp
index c46fff4..629c6ce 100644
--- a/src/Generic/ConsoleInterface/Toolbox.cpp
+++ b/src/Generic/ConsoleInterface/Toolbox.cpp
@@ -47,8 +47,8 @@ void successBox(const char* message) {
}
/*!
- * Like successBox but also prints the sub box spacing
- * \sa successBox()
+ * \copydetails successBox()
+ * \sa _printSubBoxSpacing()
*/
void successSubBox(const char* message) {
_printSubBoxSpacing();
@@ -66,8 +66,8 @@ void warningBox(const char* message) {
}
/*!
- * Like warningBox but also prints the sub box spacing
- * \sa warningBox()
+ * \copydetails warningBox()
+ * \sa _printSubBoxSpacing()
*/
void warningSubBox(const char* message) {
_printSubBoxSpacing();
@@ -85,8 +85,8 @@ void errorBox(const char* message) {
}
/*!
- * Like errorBox but also prints the sub box spacing
- * \sa errorBox()
+ * \copydetails errorBox()
+ * \sa _printSubBoxSpacing()
*/
void errorSubBox(const char* message) {
_printSubBoxSpacing();
@@ -126,8 +126,8 @@ void inputLineBox(const char* label, char* output, unsigned maxWidth, bool ignor
}
/*!
- * Like inputLineBox but also prints the sub box spacing
- * \sa inputLineBox()
+ * \copydetails inputLineBox()
+ * \sa _printSubBoxSpacing()
*/
void inputLineSubBox(const char* label, char* output, unsigned maxWidth, bool ignore) {
_printSubBoxSpacing();
diff --git a/src/Generic/ConsoleInterface/Toolbox.hpp b/src/Generic/ConsoleInterface/Toolbox.hpp
index ea1bba1..2686554 100644
--- a/src/Generic/ConsoleInterface/Toolbox.hpp
+++ b/src/Generic/ConsoleInterface/Toolbox.hpp
@@ -104,6 +104,7 @@ void inputBox(const char* label, T* output) {
}
//! Prints a label with sub box spacing and then reads user input and stores it
+//! \sa _printSubBoxSpacing()
template <typename T>
void inputSubBox(const char* label, T* output) {
_printSubBoxSpacing();