From c40d1fcdf557accc2280839001b820ec0d5fcf6e Mon Sep 17 00:00:00 2001
From: Kevin Matz <kevin@company235.com>
Date: Tue, 25 Apr 2023 10:25:54 -0400
Subject: [PATCH] documentation cleanup

---
 README.md                      |  2 +-
 docs/Doxyfile.in               |  2 +-
 docs/doxygen_files/footer.html |  6 ++----
 protocol/osc/receiver.cpp      |  6 +++---
 protocol/osc/receiver.h        | 10 +++++-----
 5 files changed, 12 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index a357917..2204843 100644
--- a/README.md
+++ b/README.md
@@ -90,7 +90,7 @@ may not be inherited from sibling `PDU` in the data.
 ### Dependent Protocols
 | Protocol Name | Standard | Referenced By | Implementation Status |
 | :- | :-: |:-: | :-: |
-| UUID Universally Unique Identifier | RFC 4122 | RLP, DDL | Partial |
+| Universally Unique Identifier (UUID) | RFC 4122 | RLP, DDL | Partial |
 | Service Location Protocol (SLP) |	RFC 2609 | EPI 19 | |
 | Trivial File Transfer Protocol (TFTP) | RFC 1350 | EPI 25 | |
 | Network Time Protocol (NTP) | RFC 5909 | OSC | |
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
index fdbe71c..943fec2 100644
--- a/docs/Doxyfile.in
+++ b/docs/Doxyfile.in
@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = OpenLCP
-PROJECT_NUMBER         = 0.2.0
+PROJECT_NUMBER         = @PROJECT_VERSION@
 #PROJECT_BRIEF          = "A collection of C++ libraries for Lighting Control Protocols, focusing on ESTA sponsored ANSI standards."
 PROJECT_LOGO           =
 OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@/docs
diff --git a/docs/doxygen_files/footer.html b/docs/doxygen_files/footer.html
index 921256d..f6adcf0 100644
--- a/docs/doxygen_files/footer.html
+++ b/docs/doxygen_files/footer.html
@@ -1,17 +1,15 @@
-<!-- HTML footer for doxygen 1.9.1-->
-<!-- start footer part -->
 <!--BEGIN GENERATE_TREEVIEW-->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     $navpath
-    <li class="footer">Copyright &copy; 2020,2021 Kevin Matz -- Generated by doxygen $doxygenversion</li>
+    <li class="footer">Copyright &copy; 2020-2023 Kevin Matz -- Generated by doxygen $doxygenversion</li>
   </ul>
 </div>
 <!--END GENERATE_TREEVIEW-->
 <!--BEGIN !GENERATE_TREEVIEW-->
 <address class="footer">
 <small>
-Copyright &copy; 2020,2021 Kevin Matz -- Generated by doxygen $doxygenversion
+Copyright &copy; 2020-2023 Kevin Matz -- Generated by doxygen $doxygenversion
 </small>
 </address>
 <!--END !GENERATE_TREEVIEW-->
diff --git a/protocol/osc/receiver.cpp b/protocol/osc/receiver.cpp
index 66795fb..776087c 100644
--- a/protocol/osc/receiver.cpp
+++ b/protocol/osc/receiver.cpp
@@ -109,7 +109,7 @@ void Receiver::scheduleBundle(const std::shared_ptr<Bundle> msg) const
 
 /**
  * @brief Receiver::rxPacket
- * @param stream
+ * @param buffer
  */
 void Receiver::rxPacket(std::shared_ptr<bufferstream> buffer) const
 {
@@ -124,7 +124,7 @@ void Receiver::rxPacket(std::shared_ptr<bufferstream> buffer) const
 
 /**
  * @brief Receiver::rxPacketTCP
- * @param stream
+ * @param buffer
  *
  * This method is presented in \cite Spec10 Spec 1.0, but has been delared as legacy
  * in favor SLIP framming.
@@ -148,7 +148,7 @@ void Receiver::rxPacketTCP(std::shared_ptr<bufferstream> buffer) const
 
 /**
  * @brief Receiver::rxPacketSLIP
- * @param stream
+ * @param buffer
  */
 void Receiver::rxPacketSLIP(std::shared_ptr<bufferstream> buffer) const
 {
diff --git a/protocol/osc/receiver.h b/protocol/osc/receiver.h
index c04e101..459c0d0 100644
--- a/protocol/osc/receiver.h
+++ b/protocol/osc/receiver.h
@@ -42,13 +42,13 @@ public:
     explicit Receiver();
     virtual ~Receiver();
 
-    void dispatch(const std::shared_ptr<Message>) const;
+    void dispatch(const std::shared_ptr<Message> msg) const;
 
 protected:
-    void scheduleBundle(const std::shared_ptr<Bundle>) const;
-    void rxPacketUDP(std::shared_ptr<bufferstream>) const;
-    void rxPacketTCP(std::shared_ptr<bufferstream>) const;
-    void rxPacketSLIP(std::shared_ptr<bufferstream>) const;
+    void scheduleBundle(const std::shared_ptr<Bundle> bundle) const;
+    void rxPacket(std::shared_ptr<bufferstream> buffer) const;
+    void rxPacketTCP(std::shared_ptr<bufferstream> buffer) const;
+    void rxPacketSLIP(std::shared_ptr<bufferstream> buffer) const;
 
     /**
      * @brief rootMethod