Skip to content

Update doxygen.md #57

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.

Sign up for GitHub

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

Merged
willhoy merged 1 commit into from
May 12, 2025
Merged

Update doxygen.md #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/doxygen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Metric publisher is used to publish internal library metrics. Users can provide

Error callback is called when a connection or channel is closed by the RabbitMQ broker.

Important -- `RabbitContext` object must outlive other library objects (`VHost`, `Producer`, `Consumer`).
**Important** -- `RabbitContext` object **must outlive** other library objects (`VHost`, `Producer`, `Consumer`).

```cpp

Expand Down Expand Up @@ -51,6 +51,7 @@ bsl::shared_ptr<rmqa::VHost> vhost = context.createVHostConnection(

Creating a `rmqa::VHost` instance **does not** immediately create a connection with the RabbitMQ broker. These connections are created lazily when calling `rmqa::VHost::createProducer` and `rmqa::VHost::createConsumer`.

**Important** -- `VHost` object **must outlive** other library objects (`Producer`, `Consumer`).

## Topology

Expand Down