Fix component documentation for bmqt_subscription
#120
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
Currently, [the component-level documentation for `bmqt_subscription`][bmqt_subscription] references `bmqt::Subscription_Handle` and `bmqt::Subscription_Expression` classes, which do not exist. This results in broken links within our published documentation. This patch corrects the documentation comment to correctly reference `bmqt::SubscriptionHandle` and `bmqt::SubscriptionExpression`, respectively. [bmqt_subscription]: https://bloomberg.github.io/blazingmq/docs/apidocs/cpp_apidocs/group__bmqt__subscription.html Signed-off-by: Patrick M. Niedzielski <patrick@pniedzielski.net>
hallfox
approved these changes
Sep 28, 2023
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.
Currently, the component-level documentation for
bmqt_subscriptionreferencesbmqt::Subscription_Handleandbmqt::Subscription_Expressionclasses, which do not exist. This results in broken links within our published documentation. This patch corrects the documentation comment to correctly referencebmqt::SubscriptionHandleandbmqt::SubscriptionExpression, respectively.Note that although this patch is very simple, it cannot be tested yet, until we can rebuild component-level documentation with Doxygen from source (see #118 for more details).