Add code doc for LogicBase::setReceivedTg

2019-10-20 19:37:01 +02:00 · 2019-10-20 19:37:01 +02:00 · d1cda0acec
parent dbfd1a8266
commit d1cda0acec
1 changed files with 7 additions and 0 deletions
--- a/src/svxlink/svxlink/LogicBase.h
+++ b/src/svxlink/svxlink/LogicBase.h
@ -295,6 +295,13 @@ class LogicBase : public sigc::trackable
      }
    }

+    /**
+     * @brief   Used by a logic to indicate received talk group
+     * @param   tg The received talk group
+     *
+     * This function is used by a logic implementation to set which talk group
+     * that local traffic is received on.
+     */
    void setReceivedTg(uint32_t tg)
    {
      m_received_tg = tg;