Better working docs, example menu.

This shows how to get doxygen to use .cpp files.
TLDR; add @file to them.

https://stackoverflow.com/questions/3990533/doxygen-wont-process-main-cpp

.gitignore

@@ -1,4 +1,4 @@
 .vscode
 googletest
-docs
+docs/
 build

CMakeLists.txt

@@ -74,6 +74,10 @@ target_include_directories(door++ PUBLIC $<BUILD_INTERFACE:${HEADERS_DIR}>)
 add_executable(door-example examples/door-example.cpp)
 target_link_libraries(door-example door++ pthread)
 
+add_executable(menu-example examples/menu-example.cpp)
+target_link_libraries(menu-example door++ pthread)
+
+
 ## if(ZF_LOG_LIBRARY_PREFIX)
 ##	target_compile_definitions(door++ PRIVATE "ZF_LOG_LIBRARY_PREFIX=${ZF_LOG_LIBRARY_PREFIX}")
 ## endif()

ansicolor.cpp

@@ -1,6 +1,11 @@
 #include "door.h"
 #include <string>
 
+/**
+ * @file
+ * @brief ANSIColor
+ */
+
 namespace door {
 
 /**

door.cpp

@@ -22,6 +22,11 @@
 #include <algorithm>
 #include <iostream>
 
+/**
+ * @file
+ * @brief Door
+ */
+
 /*
 
 My strategy here has failed.

door.h

@@ -316,9 +316,24 @@ public:
 };
 
 /**
- * This defines the render output function.  This is used
- * to define the setRender functions, as well as the creation
- * of render functions.
+ * This defines the render output function.  Given the line text, we output the
+ * color codes needs to display the line.
+ *
+ * ~~~{.cpp}
+ * door::ANSIColor upperColor, lowerColor;
+ *
+ * door::RenderFunction render = [upperColor, lowerColor]
+ *                               (const std::string &text) -> door::Render {
+ *   door::Render r(text);
+ *   for (char const &c : text) {
+ *     if (std::isupper(c))
+ *       r.append(upperColor);
+ *     else
+ *       r.append(lowerColor);
+ *   }
+ *   return r;
+ * };
+ * ~~~
  *
  * @brief Render output function
  *
@@ -329,6 +344,18 @@ typedef std::function<Render(const std::string &)> renderFunction;
  * This defines the update function.
  *
  * This updates the text.
+ *
+ * ~~~{.cpp}
+ * int score = 0;
+ *
+ * door::updateFunction updater = [](void) -> std::string {
+ *   std::string text = "Score: ";
+ *   text += std::to_string(score);
+ *   return text;
+ * };
+ *
+ * fancyLine.setUpdater(updater);
+ * ~~~
  */
 typedef std::function<std::string(void)> updateFunction;
 

doxy.config

@@ -67,7 +67,8 @@ EXTRACT_PRIVATE        = YES
 EXTRACT_PACKAGE        = NO
 EXTRACT_STATIC         = NO
 EXTRACT_LOCAL_CLASSES  = YES
-EXTRACT_LOCAL_METHODS  = NO
+EXTRACT_LOCAL_METHODS  = YES
+# NO
 EXTRACT_ANON_NSPACES   = NO
 HIDE_UNDOC_MEMBERS     = NO
 HIDE_UNDOC_CLASSES     = NO
@@ -110,7 +111,7 @@ WARN_IF_DOC_ERROR      = YES
 WARN_NO_PARAMDOC       = NO
 WARN_AS_ERROR          = NO
 WARN_FORMAT            = "$file:$line: $text"
-WARN_LOGFILE           =
+WARN_LOGFILE           = doxygen_warn.log
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
 #---------------------------------------------------------------------------

examples/menu-example.cpp

@@ -0,0 +1,52 @@
+#include "door.h"
+
+int main(int argc, char *argv[]) {
+  door::Door door("example", argc, argv);
+
+  // reset colors, clear screen.
+  door << door::reset << door::cls << door::nl;
+
+  door::Menu menu(10, 5, 25);
+  menu.setColor(door::ANSIColor(door::COLOR::YELLOW, door::COLOR::BLUE,
+                                door::ATTR::BOLD)); // set border
+  menu.setTitle(std::make_unique<door::Line>("Menu Example"), 1);
+
+  int arrows = 15;
+  door::updateFunction arrowsUpdate = [&arrows](void) -> std::string {
+    std::string text = "Arrows (";
+    text += std::to_string(arrows);
+    text += " in stock)";
+    return text;
+  };
+  menu.addSelection('A', "Arrows (0 in stock)", arrowsUpdate);
+  menu.addSelection('C', "Color selection");
+  menu.addSelection('P', "Pants");
+  menu.addSelection('Q', "Quit");
+
+  int r = 0;
+
+  while (r >= 0) {
+    menu.update();
+
+    r = menu.choose(door);
+    if (r > 0) {
+      // we did not timeout
+      char c = menu.which(r - 1);
+      if (c == 'A') {
+        if (arrows > 0)
+          --arrows;
+        else {
+          door << door::Goto(1, 17) << door::reset
+               << "Sorry, we're out of stock.";
+          continue;
+        }
+      }
+
+      door << door::Goto(1, 17) << door::reset << "You chose " << c << "!";
+      if (c == 'Q')
+        break;
+    }
+  }
+
+  door << door::nl << "Returing to BBS... " << door::nl;
+}

getkey.cpp

@@ -10,6 +10,11 @@
 #include <signal.h>
 #include <unistd.h>
 
+/**
+ * @file
+ * @brief Key and door input routines
+ */
+
 void done(int signal) {
   std::cout << "\r\nWORP WORP\r\n";
   std::cout.flush();

lines.cpp

@@ -1,6 +1,11 @@
 #include "door.h"
 #include "utf8.h"
 
+/**
+ * @file
+ * @brief Line
+ */
+
 namespace door {
 
 #ifdef EXPERIMENTAL

panel.cpp

@@ -2,6 +2,20 @@
 #include <set>
 #include <string.h>
 
+/**
+ * @file
+ * @brief Panels and Menus
+ */
+
+/**
+ * @example menu-example.cpp
+ *
+ * @brief Example using menus
+ *
+ * This example shows a menu, and demonstrates the new menu update ability.
+ *
+ */
+
 // #include <memory>
 
 namespace door {
@@ -57,6 +71,12 @@ Panel::Panel(const Panel &original) : border_color(original.border_color) {
 }
 */
 
+/**
+ * @brief Set the panels X and Y screen position.
+ *
+ * @param xp
+ * @param yp
+ */
 void Panel::set(int xp, int yp) {
   x = xp;
   y = yp;
@@ -511,6 +531,16 @@ renderFunction Menu::defaultUnselectedRender =
                      ANSIColor(COLOR::WHITE, COLOR::BLUE, ATTR::BOLD),
                      ANSIColor(COLOR::YELLOW, COLOR::BLUE, ATTR::BOLD));
 
+/**
+ * @brief Construct a new Menu object
+ *
+ * Set the x, y screen location for the start of the menu, and the width.
+ * The location can be changed via \ref Panel::set
+ *
+ * @param x
+ * @param y
+ * @param width
+ */
 Menu::Menu(int x, int y, int width) : Panel(x, y, width) {
   setStyle(BorderStyle::DOUBLE);
   // Setup initial sensible default values.
@@ -580,13 +610,13 @@ void Menu::addSelection(char c, const char *line) {
 
 /**
  * @brief This allows for menus with updater functions
- * 
- * Note:  The update function only needs to update just the text part.
+ *
+ * Note:  The update function only needs to update just the line text.
  * We wrap it with another updateFuntion to append the "[M] " part.
- * 
- * @param c 
- * @param line 
- * @param update 
+ *
+ * @param c
+ * @param line
+ * @param update
  */
 void Menu::addSelection(char c, const char *line, updateFunction update) {
   std::string menuline;
@@ -602,7 +632,6 @@ void Menu::addSelection(char c, const char *line, updateFunction update) {
 
   menuline += line;
 
-  
   std::unique_ptr<Line> l = std::make_unique<Line>(menuline, width);
   l->setUpdater(fullUpdate);
   // addLine(std::make_unique<Line>(menuline, width));