From 635dc36ada8aaee8fbe4e48b184017d6dbe71dc8 Mon Sep 17 00:00:00 2001
From: Kevin Matz <kevin@company235.com>
Date: Tue, 6 Dec 2022 14:50:20 -0500
Subject: [PATCH] cleanup documentation

---
 protocol/esta/dmx/dmx.h                  | 13 +++++--------
 protocol/esta/sacn/arbitratinguniverse.h |  5 ++---
 protocol/esta/sacn/data.h                |  2 +-
 protocol/esta/sacn/sacn.h                |  2 ++
 4 files changed, 10 insertions(+), 12 deletions(-)

diff --git a/protocol/esta/dmx/dmx.h b/protocol/esta/dmx/dmx.h
index 2f721ea..5a81df0 100644
--- a/protocol/esta/dmx/dmx.h
+++ b/protocol/esta/dmx/dmx.h
@@ -29,9 +29,7 @@
  *  @brief @cite DMX The Digital Multiplex Protocol
  */
 namespace DMX {
-
-  /// \cite DMX
-  ///  Table D1 - Reserved START Codes
+  /// \cite DMX Table D1 - Reserved START Codes
   static const uint8_t E111_NULL_START       = 0;
   static const uint8_t E111_ASC_TEXT_ASCII   = 23;
   static const uint8_t E111_ASC_TEST         = 85;
@@ -39,18 +37,17 @@ namespace DMX {
   static const uint8_t E111_ASC_MANUFACTURER = 145;
   static const uint8_t E111_ASC_SIP          = 207;
 
-  /// \cite DMX
-  /// 8.1 Data Protocol: Format
+  /// \cite DMX 8.1 Data Protocol: Format
+  ///
   /// DMX512 slots shall be transmitted sequentially in asynchronous serial
   /// format, beginning with slot 0 and ending with the last implemented slot,
   /// up to slot 512 (a maximum total of 513 slots).
   static const std::size_t E111_LAST_SLOT    = 512;
 
-  /// \cite DMX
-  /// 8.5.3.1 Alternate START code refresh interval
+  /// \cite DMX 8.5.3.1 Alternate START code refresh interval
+  ///
   /// A DMX512 transmitter interleaving NULL START Code packets with
   /// Alternate START Code packets shall send a NULL START Code packet at least
   /// once per second.
   static const uint16_t E111_DATA_LOSS_TIMEOUT = 1000;
-
 } // namespace DMX
diff --git a/protocol/esta/sacn/arbitratinguniverse.h b/protocol/esta/sacn/arbitratinguniverse.h
index f5d2e4d..352df6a 100644
--- a/protocol/esta/sacn/arbitratinguniverse.h
+++ b/protocol/esta/sacn/arbitratinguniverse.h
@@ -41,7 +41,7 @@ namespace sACN {
  * > occurs, receivers must handle these sources in some way.
  *
  * If multiple universes with highest priority are recieved, the universe
- * encountered first will maintain dominance.
+ * recieved most recently will be given dominance.
  *
  * > \cite sACN 6.2.3.2 Note on Merge and Arbitration Algorithms
  * >
@@ -49,8 +49,7 @@ namespace sACN {
  * > additional selection criterion is called arbitration.
  *
  * The universe with the highest priority will be determined to be the
- * dominant source.  Universes with NULL Start Code frequency less than
- * DMX::E111_DATA_LOSS_TIMEOUT are not considered as eligible source universes.
+ * dominant source.
  */
 class ArbitratingUniverse
   : public sACN::Universe
diff --git a/protocol/esta/sacn/data.h b/protocol/esta/sacn/data.h
index 718eced..c5a6bda 100644
--- a/protocol/esta/sacn/data.h
+++ b/protocol/esta/sacn/data.h
@@ -198,7 +198,7 @@ namespace std
 
   template<>
   /**
-   * @brief The hash struct specilizaton for SACN::Provenance
+   * @brief The hash struct specilizaton for SACN::DATA::data_header
    */
   struct hash<sACN::DATA::data_header>
   {
diff --git a/protocol/esta/sacn/sacn.h b/protocol/esta/sacn/sacn.h
index 5bd1e88..68177dc 100644
--- a/protocol/esta/sacn/sacn.h
+++ b/protocol/esta/sacn/sacn.h
@@ -121,6 +121,8 @@ using ip_addr_spec = ACN::SDT::ip_addr_spec;
 
 /**
  * @brief \cite sACN 9.3.1 Allocation of IPv4 Multicast Addresses
+ * @param universe
+ * @return
  *
  * > Multicast addresses are from the IPv4 Local Scope and will be managed by
  * > routers in conformance with RFC 2365 \cite ASIPM.