From 8c8af574c1cb962776784e1ccdf387c5d72df2ad Mon Sep 17 00:00:00 2001 From: "Patrick M. Niedzielski" Date: Tue, 14 Jan 2025 17:57:41 -0500 Subject: [PATCH] Migrate mqbblp docs directory 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 is very out-of-date and 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 also out-of-date. This continues the changes made in commit cb037c6. Signed-off-by: Patrick M. Niedzielski --- src/groups/mqb/mqbblp/README.dox | 8 ++++++ src/groups/mqb/mqbblp/doc/mqbblp.txt | 43 ---------------------------- 2 files changed, 8 insertions(+), 43 deletions(-) create mode 100644 src/groups/mqb/mqbblp/README.dox delete mode 100644 src/groups/mqb/mqbblp/doc/mqbblp.txt diff --git a/src/groups/mqb/mqbblp/README.dox b/src/groups/mqb/mqbblp/README.dox new file mode 100644 index 0000000000..613f569a6c --- /dev/null +++ b/src/groups/mqb/mqbblp/README.dox @@ -0,0 +1,8 @@ +/** +@dir mqbblp + +@brief The `MQBBLP` (Message Queue Broker Bloomberg LP) package provides +Bloomberg implementation of queue management. + +This package provides implementation of queues. +*/ diff --git a/src/groups/mqb/mqbblp/doc/mqbblp.txt b/src/groups/mqb/mqbblp/doc/mqbblp.txt deleted file mode 100644 index ffedb4c0f0..0000000000 --- a/src/groups/mqb/mqbblp/doc/mqbblp.txt +++ /dev/null @@ -1,43 +0,0 @@ - mqbblp.txt - -@PURPOSE: Provide Bloomberg implementation of queue management. - -@MNEMONIC: Message Queue Broker Bloomberg LP (mqbblp) - -@DESCRIPTION: This package provides implementation of queues. - - -/Hierarchical Synopsis -/--------------------- - The 'mqbblp' package currently has 8 components having 2 levels of physical - dependency. The list below shows the hierarchical ordering of the components. -.. - 1. mqbblp_domain - mqbblp_fanoutqueueengine - mqbblp_priorityqueueengine - mqbblp_queue - mqbblp_routers - - 2. mqbblp_engineregistry -.. - - -/Component Synopsis -/------------------ -: 'mqbblp_domain': -: Provide a concrete implementation of the 'mqbi::Domain' interface. -: -: 'mqbblp_queue: -: Provide a queue implementation for a queue managed by this broker. -: -: 'mqbblp_fanoutqueueengine': -: Provide a QueueEngine for fanout queue mode. -: -: 'mqbblp_priorityqueueengine': -: Provide a QueueEngine for priority queue mode. -: -: 'mqbblp_routers': -: Abstract the message-routing related infrastructure. -: -: 'mqbblp_engineregistry': -: Provide a mapping between configuration types and engines.