From 16cbd6c494880d9985b10037f20f5b25a0db5081 Mon Sep 17 00:00:00 2001
From: Giso Grimm <giso.grimm@vegri.net>
Date: Thu, 2 Nov 2023 19:51:10 +0100
Subject: [PATCH] update documentation of route module

---
 libtascar/src/scene.cc         | 11 ++++++-----
 manual/modroute.tex            | 24 +++++++++++++-----------
 plugins/src/tascarmod_route.cc |  3 ++-
 3 files changed, 21 insertions(+), 17 deletions(-)

diff --git a/libtascar/src/scene.cc b/libtascar/src/scene.cc
index a2723c72..8ecbc639 100644
--- a/libtascar/src/scene.cc
+++ b/libtascar/src/scene.cc
@@ -782,10 +782,10 @@ route_t::route_t(tsccfg::node_t xmlsrc)
     : xml_element_t(xmlsrc), id(TASCAR::get_tuid()), mute(false), solo(false),
       meter_tc(2), meter_weight(TASCAR::levelmeter::Z), targetlevel(0)
 {
-  GET_ATTRIBUTE(name, "", "route name");
-  GET_ATTRIBUTE(id, "", "route id");
-  GET_ATTRIBUTE_BOOL(mute, "mute flag of route");
-  GET_ATTRIBUTE_BOOL(solo, "solo flag of route");
+  GET_ATTRIBUTE(name, "", "Route name");
+  GET_ATTRIBUTE(id, "", "Unique route id, empty to autogenerate");
+  GET_ATTRIBUTE_BOOL(mute, "Mute flag of route");
+  GET_ATTRIBUTE_BOOL(solo, "Solo flag of route");
 }
 
 void route_t::set_solo(bool b, uint32_t& anysolo)
@@ -838,7 +838,8 @@ audio_port_t::audio_port_t(tsccfg::node_t xmlsrc, bool is_input_)
     : xml_element_t(xmlsrc), ctlname(""), port_index(0), is_input(is_input_),
       gain(1), caliblevel(1.0)
 {
-  GET_ATTRIBUTE(connect, "", "jack port connection");
+  GET_ATTRIBUTE(connect, "",
+                "Regular expressions of port names for connections");
   GET_ATTRIBUTE_DB(gain, "port gain");
   has_caliblevel = has_attribute("caliblevel");
   GET_ATTRIBUTE_DBSPL(caliblevel, "calibration level");
diff --git a/manual/modroute.tex b/manual/modroute.tex
index febf68fa..5276158b 100644
--- a/manual/modroute.tex
+++ b/manual/modroute.tex
@@ -10,31 +10,33 @@
 name & description (type, unit) & def.\\
 \hline
 \hline
-\indattr{name} & Jack and OSC identifier (string) & \\
+\indattr{caliblevel} & calibration level (float, dB SPL) & 93.9794\\
 \hline
-\indattr{id} & Unique route id, empty to autogenerate (string) & \\
+\indattr{caliblevel\_in} & Input calibration levels (float array, dB SPL) & \\
 \hline
 \indattr{channels} & Number of channels (uint32) & 1\\
 \hline
-\indattr{gain} & Route gain (float, dB) & 0\\
-\hline
-\indattr{lingain} & linear gain (float) & 1\\
-\hline
 \indattr{connect} & Regular expressions of input port names (string array) & \\
 \hline
 \indattr{connect\_out} & Regular expressions of output port names (string array) & \\
 \hline
-\indattr{inv} & phase invert (bool) & false\\
+\indattr{gain} & Route gain (float, dB) & 0\\
 \hline
-\indattr{mute} & mute flag of route (bool) & false\\
+\indattr{id} & Unique route id, empty to autogenerate (string) & \\
 \hline
-\indattr{solo} & solo flag of route (bool) & false\\
+\indattr{inv} & phase invert (bool) & false\\
 \hline
-\indattr{levelmeter\_tc} & Level meter time constant (double) & 2\\
+\indattr{levelmeter\_tc} & Leq level metering time constant (double, s) & 2\\
 \hline
 \indattr{levelmeter\_weight} & level meter weighting (f-weight) & Z\\
 \hline
-\indattr{caliblevel} & calibration level (float, dB SPL) & 93.9794\\
+\indattr{lingain} & linear gain (float) & 1\\
+\hline
+\indattr{mute} & Mute flag of route (bool) & false\\
+\hline
+\indattr{name} & Jack and OSC identifier (string) & \\
+\hline
+\indattr{solo} & Solo flag of route (bool) & false\\
 \hline
 \end{tabularx}
 }
diff --git a/plugins/src/tascarmod_route.cc b/plugins/src/tascarmod_route.cc
index 14fbd7aa..ad8271e5 100644
--- a/plugins/src/tascarmod_route.cc
+++ b/plugins/src/tascarmod_route.cc
@@ -158,7 +158,8 @@ routemod_t::routemod_t(const TASCAR::module_cfg_t& cfg)
 {
   pthread_mutex_init(&mtx_, NULL);
   TASCAR::module_base_t::GET_ATTRIBUTE(channels, "", "Number of channels");
-  TASCAR::module_base_t::GET_ATTRIBUTE_(connect_out);
+  TASCAR::module_base_t::GET_ATTRIBUTE(
+      connect_out, "", "Regular expressions of output port names");
   TASCAR::module_base_t::get_attribute("lingain", gain, "", "linear gain");
   TASCAR::module_base_t::GET_ATTRIBUTE(levelmeter_tc, "s",
                                        "Leq level metering time constant");