Migrate mqba docs into a Doxygen file

This patch removes the old `doc/*.txt` file and migrates some information in it into a file Doxygen can read. The information not migrated is: 1. the table of contents for this package, which will be generated by Doxygen automatically, and kept in-sync with any documentation changes made in the files, and 2. the hierarchical synopsis, which is out-of-date. These are the same changes that we have already made in the public documentation, as in commits bc20ab0 and f3ca1d2. See in particular the rational in the latter’s commit message. Signed-off-by: Patrick M. Niedzielski <[email protected]>
bloomberg · Jan 10, 2025 · 80ba05b · 80ba05b
1 parent 4c0a4ba
commit 80ba05b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 48 deletions.
diff --git a/src/groups/mqb/mqba/README.dox b/src/groups/mqb/mqba/README.dox
@@ -0,0 +1,6 @@
+/**
+@dir mqba
+
+@brief The `MBQA` (BlazingMQ Broker) package provides the components
+       constituting the broker.
+*/
diff --git a/src/groups/mqb/mqba/doc/mqba.txt b/src/groups/mqb/mqba/doc/mqba.txt