From 09e65c5a5c999ce1a76f13c9e489eec244f4225c Mon Sep 17 00:00:00 2001
From: "Patrick M. Niedzielski" <patrick@pniedzielski.net>
Date: Thu, 16 Jan 2025 17:01:50 -0500
Subject: [PATCH] Migrate mqbcfg docs directory into a Doxygen file
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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 can be
     auto-generated from each component’s documentation, and

  2. the hierarchical synopsis.

This continues the changes made in commit 8c8af57.

Signed-off-by: Patrick M. Niedzielski <patrick@pniedzielski.net>
---
 src/groups/mqb/mqbcfg/README.dox     |  9 +++++++++
 src/groups/mqb/mqbcfg/doc/mqbcfg.txt | 28 ----------------------------
 2 files changed, 9 insertions(+), 28 deletions(-)
 create mode 100644 src/groups/mqb/mqbcfg/README.dox
 delete mode 100644 src/groups/mqb/mqbcfg/doc/mqbcfg.txt

diff --git a/src/groups/mqb/mqbcfg/README.dox b/src/groups/mqb/mqbcfg/README.dox
new file mode 100644
index 000000000..d690ff7a3
--- /dev/null
+++ b/src/groups/mqb/mqbcfg/README.dox
@@ -0,0 +1,9 @@
+/**
+@dir mqbcfg
+
+@brief The `MQBCFG` (BlazingMQ Broker Config) package provide broker
+configuration schema and message component.
+
+This package provides the schema of the configuration used by the broker, as
+well as the generated corresponding messages component.
+*/
diff --git a/src/groups/mqb/mqbcfg/doc/mqbcfg.txt b/src/groups/mqb/mqbcfg/doc/mqbcfg.txt
deleted file mode 100644
index 596eaff16..000000000
--- a/src/groups/mqb/mqbcfg/doc/mqbcfg.txt
+++ /dev/null
@@ -1,28 +0,0 @@
-    mqbcfg.txt
-
-@PURPOSE: Provide broker configuration schema and message component.
-
-@MNEMONIC: BlazingMQ Broker Config (mqbcfg)
-
-@DESCRIPTION: This package provides the schema of the configuration used by the
-broker, as well as the generated corresponding messages component.
-
-
-/Hierarchical Synopsis
-/---------------------
- The 'mqbcfg' package currently has 3 components having 2 levels of physical
- dependency.  The list below shows the hierarchical ordering of the components.
-..
-  1. mqbcfg_messages
-  2. mqbcfg_brokerconfig
-  2. mqbcfg_tcpinterfaceconfigvalidator
-..
-
-/Component Synopsis
-/------------------
-: 'mqbcfg_messages':
-:      BMQBroker generated configuration messages.
-: 'mqbcfg_brokerconfig'
-:      Provide global access to broker configuration.
-: 'mqbcfg_tcpinterfaceconfigvalidator'
-:      Provide validation logic for `appConfig/networkInterfaces/tcpInterface/listeners` in the broker configuration.