Added docs

davidmoreno · Dec 21, 2023 · df26e40 · df26e40
1 parent 217b673
commit df26e40
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/src/network_rtpmidi_listener.cpp b/src/network_rtpmidi_listener.cpp
@@ -28,6 +28,9 @@
 namespace rtpmididns {
 extern std::unique_ptr<::rtpmidid::mdns_rtpmidi_t> mdns;
 
+/**
+ * @short A rtpmidi server that just sends data to another peer
+ */
 network_rtpmidi_listener_t::network_rtpmidi_listener_t(const std::string &name)
     : name_(name), server(name, "") {
   if (mdns)

diff --git a/src/network_rtpmidi_multi_listener.hpp b/src/network_rtpmidi_multi_listener.hpp
@@ -26,6 +26,12 @@ namespace rtpmididns {
 class aseq_t;
 class midirouter_t;
 
+/**
+ * @short A rtpmidi server that creates local listen ALSA ports
+ *
+ * This midipeer does not actually send or receive data, but creates
+ * a local ALSA peer and a rtpmidi peer and connects them.
+ */
 class network_rtpmidi_multi_listener_t : public midipeer_t {
 public:
   std::shared_ptr<aseq_t> aseq;