From 062d6b0ae72d098fa51663d62d25000ccaaedda8 Mon Sep 17 00:00:00 2001
From: "Patrick M. Niedzielski" <patrick@pniedzielski.net>
Date: Fri, 14 Feb 2025 13:38:31 -0500
Subject: [PATCH] Migrate mqbcmd 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, because component brief
     descriptions are already coptured in each component’s documentation and
     wil be automatically generated by Doxygen, and

  2. the hierarchical synopsis.

This continues the changes made in 69883e2.

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

diff --git a/src/groups/mqb/mqbcmd/README.dox b/src/groups/mqb/mqbcmd/README.dox
new file mode 100644
index 0000000000..e9fe858ca7
--- /dev/null
+++ b/src/groups/mqb/mqbcmd/README.dox
@@ -0,0 +1,6 @@
+/**
+@dir mqbcmd
+
+@brief The `MQBCMD` (BlazingMQ Commands) package provides a parser and
+       manipulator of command types.
+*/
diff --git a/src/groups/mqb/mqbcmd/doc/mqbcmd.txt b/src/groups/mqb/mqbcmd/doc/mqbcmd.txt
deleted file mode 100644
index dd566274a2..0000000000
--- a/src/groups/mqb/mqbcmd/doc/mqbcmd.txt
+++ /dev/null
@@ -1,38 +0,0 @@
-    mqbcmd.txt
-
-@PURPOSE:
-
-@MNEMONIC: BlazingMQ Commands (mqbcmd)
-
-@DESCRIPTION: This package provides parser and manipulator of commands types.
-
-
-/Hierarchical Synopsis
-/---------------------
- The 'mqbcmd' package currently has 5 components having 2 levels of physical
- dependency.  The list below shows the hierarchical ordering of the components.
-..
-  2. mqbcmd_commandlist
-     mqbcmd_humanprinter
-     mqbcmd_parseutil
-     mqbcmd_util
-
-  1. mqbcmd_messages
-..
-
-/Component Synopsis
-/------------------
-: 'mqbcmd_messages'
-:       Provide VST of commands.
-:
-: 'mqbcmd_commandlist'
-:      Provide a list of all commands the broker can respond to.
-:
-: 'mqbcmd_humanprinter'
-:      Provide a namespace of utilities to print human-friendly results.
-:
-: 'mqbcmd_parseutil'
-:      Provide a namespace of command parsing functions.
-:
-: 'mqbcmd_util'
-:      Provide a namespace of command utilities.