Docs[mqba]: Complete conversion of mqba documentation from BDE style to Doxygen style #523
+428
−541
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
force-pushed
the
doxygen/mqba
branch
2 times, most recently
from
93af0db to
51a7e26
Compare
pniedzielski
force-pushed
the
doxygen/mqba
branch
from
51a7e26 to
88c4362
Compare
![bmq-oss-ci[bot]](https://avatars.githubusercontent.com/u/1416818?s=60&v=4){kind=small}
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 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 out-of-date.
These are the same changes that we have already made in the public
documentation, as in commits bc20ab0
and f3ca1d2. See in particular the
rational in the latter’s commit message.
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. See the commit message in commit
f3ca1d2 for more details on this.
2. Next, it converts stray BDE-style documentation that was not
automatically converted to Doxygen format when we open-sourced.
Most of these are the documentation for member variables, but in
some cases, overloads were not correctly converted either.
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.
Signed-off-by: Patrick M. Niedzielski <[email protected]>
pniedzielski
force-pushed
the
doxygen/mqba
branch
from
88c4362 to
0632f3d
Compare
pniedzielski
changed the title
pniedzielski
added
documentation
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.
Please see commit messages for details.
This is the first of many PRs like this. They will all follow the same format (two commits, one to convert component documentation and to fix up things that the Doxygen conversion script missed, and one to migrate package documentation.