Skip to content

Commit

Permalink
Fix component documentation for bmqt_subscription
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
pniedzielski committed Sep 28, 2023
1 parent 66bfc7f commit 5e5e223
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/groups/bmq/bmqt/bmqt_subscription.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
//@PURPOSE: Provide a value-semantic types for subscription related API.
//
//@CLASSES:
// bmqt::Subscription_Handle: uniquely identifies Subscription
// bmqt::Subscription_Expression: Subscription criteria
// bmqt::SubscriptionHandle: uniquely identifies Subscription
// bmqt::SubscriptionExpression: Subscription criteria
// bmqt::Subscription: Subscription parameters
//
//@DESCRIPTION: 'bmqt::Subscription' provides a value-semantic type carried
Expand Down

0 comments on commit 5e5e223

Please sign in to comment.