Skip to content

Commit

Permalink
Migrate mqbcfg docs directory into a Doxygen file
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
pniedzielski committed Jan 16, 2025
1 parent 224eeb4 commit 09e65c5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 28 deletions.
9 changes: 9 additions & 0 deletions src/groups/mqb/mqbcfg/README.dox
Original file line number Diff line number Diff line change
@@ -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.
*/
28 changes: 0 additions & 28 deletions src/groups/mqb/mqbcfg/doc/mqbcfg.txt

This file was deleted.

0 comments on commit 09e65c5

Please sign in to comment.