Docs[mqbcfg]: Complete conversion of mqbcfg documentation from BDE style to Doxygen style #575
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This patch makes two changes: 1. First, it converts the BDE-style component documentation into Doxygen `@file` documentation. 2. Next, it converts stray BDE-style documentation that was not automatically converted to Doxygen format when we open-sourced. This patch continues the work from commit d47304d. Signed-off-by: Patrick M. Niedzielski <[email protected]>
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]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This continues the work started in PR #570 into the mqbcfg package. It contains two independent patches:
Convert mqbcfg documentation to Doxygen format: Migrates in-code documentation to Doxygen format.
Migrate mqbcfg docs directory into a Doxygen file: Migrates package-level documentation to Doxygen format.