Skip to content

Commit

Permalink
Migrate mqbcmd 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, 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>
  • Loading branch information
pniedzielski committed Feb 14, 2025
1 parent a6c11c6 commit 062d6b0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 38 deletions.
6 changes: 6 additions & 0 deletions src/groups/mqb/mqbcmd/README.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/**
@dir mqbcmd

@brief The `MQBCMD` (BlazingMQ Commands) package provides a parser and
manipulator of command types.
*/
38 changes: 0 additions & 38 deletions src/groups/mqb/mqbcmd/doc/mqbcmd.txt

This file was deleted.

0 comments on commit 062d6b0

Please sign in to comment.