Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix component documentation for bmqt_subscription #120

Merged
merged 1 commit into from
Sep 28, 2023

Conversation

pniedzielski
Copy link
Collaborator

Currently, the component-level documentation for
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.

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).

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 <[email protected]>
@pniedzielski pniedzielski requested a review from a team as a code owner September 28, 2023 20:54
@pniedzielski pniedzielski merged commit 5e5e223 into bloomberg:main Sep 28, 2023
6 checks passed
@pniedzielski pniedzielski deleted the doxygen/subscriptions branch October 30, 2024 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants