Docs[mqbblp]: Complete conversion of mqbblp documentation from BDE style to Doxygen style #570
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
pniedzielski
added
documentation
pniedzielski
force-pushed
the
doxygen/mqbblp
branch
2 times, most recently
from
6bb6efb to
dee6241
Compare
hallfox
previously approved these changes
Jan 14, 2025
pniedzielski
force-pushed
the
doxygen/mqbblp
branch
from
dee6241 to
ab52bb0
Compare
emelialei88
reviewed
Jan 15, 2025
![bmq-oss-ci[bot]](https://avatars.githubusercontent.com/u/1416818?s=60&v=4){kind=small}
pniedzielski
force-pushed
the
doxygen/mqbblp
branch
from
ab52bb0 to
291986a
Compare
pniedzielski
force-pushed
the
doxygen/mqbblp
branch
from
291986a to
0d3fb13
Compare
This shouldn't be related to anything in this PR. |
emelialei88
previously approved these changes
Jan 16, 2025
This patch teaches Doxygen to ignore the `BSLMF_NESTED_TRAIT_DECLARATION` macro instantiations in many of our class declarations, which confuse its parser and cause warnings and incorrect documentation generation. Signed-off-by: Patrick M. Niedzielski <[email protected]>
This patch makes three 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.
3. Finally, it makes minor changes to non-Doxygen comments, like file
header comments or include comments, which were not correctly
updated in the past.
This patch continues the work from commit a75a915.
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 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 <[email protected]>
pniedzielski
force-pushed
the
doxygen/mqbblp
branch
from
0d3fb13 to
ef89b9d
Compare
emelialei88
approved these changes
Jan 16, 2025
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 #523 into the mqbblp package. It contains three independent patches:
Make doxygen ignore
BSLMF_NESTED_TRAIT_DECLARATION: Fixes several warnings during documentation generation.Convert mqbblp documentation to Doxygen format: Migrates in-code documentation to Doxygen format.
Migrate mqbblp docs directory into a Doxygen file: Migrates package-level documentation to Doxygen format.