Updating docs.

door.cpp

@@ -59,11 +59,13 @@ void to_lower(std::string &text) {
 }
 
 /**
- * @brief Replace all instances of from with to.
+ * @brief Replaces one string with another once
  *
- * @param str
- * @param from
- * @param to
+ * Returns true if replaced.
+ * 
+ * @param[in,out] str String to modify
+ * @param[in] from String to search for
+ * @param[in] to String to replace with
  * @return true
  * @return false
  */
@@ -210,10 +212,11 @@ bool full_cp437 = false;
 bool debug_capture = false;
 
 /**
- * Construct a new Door object using the commandline parameters
- * given to the main function.
- *
- * @example door-example.cpp
+ * @brief Construct a new Door:: Door object
+ * 
+ * @param[in] dname Door name used for logfile
+ * @param[in] argc 
+ * @param[in] argv 
  */
 Door::Door(std::string dname, int argc, char *argv[])
     : std::ostream(this), doorname{dname},

door.h

@@ -188,7 +188,6 @@ public:
  * @class Door
  *
  * This handles output to the caller, via ostream.
- *
  */
 class Door : public std::ostream, private std::streambuf {
 
@@ -223,10 +222,6 @@ private:
   std::thread time_thread;
 
 public:
-  /**
-   * @param argc int
-   * @param argv char *[]
-   */
   Door(std::string dname, int argc, char *argv[]);
   /// Default copy ctor deleted
   Door(Door &) = delete;

panel.cpp

@@ -74,8 +74,7 @@ Panel::Panel(const Panel &original) : border_color(original.border_color) {
 /**
  * @brief Set the panels X and Y screen position.
  *
- * @param xp
- * @param yp
+ * @param[in] xp,yp new screen position
  */
 void Panel::set(int xp, int yp) {
   x = xp;
@@ -352,7 +351,7 @@ void Panel::lineSetBack(ANSIColor back) {
  * @brief Create a spacer line using block drawing characters.
  *
  * Return a Line of single or double characters the width of the panel.
- * @param single
+ * @param[in] single make single or double line
  * @return std::unique_ptr<Line>
  */
 std::unique_ptr<Line> Panel::spacer_line(bool single) {