Update the public packages' documentation #119
Merged
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
Our three public API packages—`bmqa`, `bmqpi`, and `bmqt`—were given Markdown `README` files that replicate the BDE-style `doc/*.txt` files, excluding some aspects of their component hierarchy. However, these `README` files have not been updated to include recent changes to the API, such as the addition of subscription support. This patch adds the missing components to each of these `README` files, bringing them up to date with the current public API. Applying this patch will enable us to build our API documentation directly from the Doxygen comments, rather than using the `bdedox` tool that our API documentation is currently built with. Signed-off-by: Patrick M. Niedzielski <[email protected]>
This patch removes the public BDE-style package documentation for our three public packages: `bmqa`, `bmqpi`, and `bmqt`. This documentation is old and incomplete, and a more update-to-date version can be found already in the `README.md` for each of these packages. These `README.md` files can be used directly by Doxygen as well, rather than the Doxygen component documentation being generated as a separate step from the BDE-style documentation. Signed-off-by: Patrick M. Niedzielski <[email protected]>
This patch updates the BDE-style component membership list for `bmqa`. This change is trivial to do, and this package is the only one whose membership list was out-of-date, so we do this rather than wholesale remove BDE-style membership lists. Signed-off-by: Patrick M. Niedzielski <[email protected]>
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.
Issue number of the reported bug or feature request: Part of #118
Describe your changes
As part of the work on making sure our documentation can build correctly with just doxygen, these three patches bring our public package documentation up-to-date with the current state of our API, and remove old, out-of-date documentation that mostly duplicates this.
Testing performed
Applying these patches and building with
doxygenyields package documentation that contains all components in each package, as well as their purpose.Additional context
This PR will be part of a series of PRs to tackle #118, as that work is rather large, and these patches are independent of the other work, and independently useful for an open source contributor reading the code.