Skip to content

Commit

Permalink
Update the API packages’ READMEs
Browse files Browse the repository at this point in the history
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 <patrick@pniedzielski.net>
  • Loading branch information
pniedzielski committed Oct 9, 2023
1 parent a8335b7 commit ed9fa8e
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 28 deletions.
32 changes: 20 additions & 12 deletions src/groups/bmq/bmqa/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
BMQA
====
> The `BMQA` (BlazingMQ API) package provides applications public API for the
> The `BMQA` (BlazingMQ API) package provides applications a public API for the
> BlazingMQ SDK.

Description
-----------
The 'bmqa' package provides the public API of the BlazingMQ SDK for
The `bmqa` package provides the public API of the BlazingMQ SDK for
applications to use.

Component Synopsis
------------------
Component | Provides ...
---------------------------|-----------------------------------------------------------
`bmqa_event` | a generic variant encompassing all types of events.
`bmqa_message` | the application with a message data object.
`bmqa_messageevent` | the application with data event notifications.
`bmqa_messageeventbuilder` | a builder for 'MessageEvent' objects.
`bmqa_messageiterator` | a mechanism to iterate over the messages of a MessageEvent.
`bmqa_queueid` | a value-semantic efficient identifier for a queue.
`bmqa_session` | access to the BlazingMQ broker.
`bmqa_sessionevent` | value-semantic type for system event session notifications.
Component | Provides ...
-------------------------------|-----------------------------------------------------------
`bmqa_abstractsession` | a pure protocol for a BlazingMQ session.
`bmqa_closequeuestatus` | a value-semantic type for a close queue operation status.
`bmqa_configurequeuestatus` | a value-semantic type for a configure queue operation status.
`bmqa_confirmeventbuilder` | a builder for batching confirmation messages.
`bmqa_event` | a generic variant encompassing all types of events.
`bmqa_manualhosthealthmonitor` | a minimal implementation of `bmqpi::HostHealthMonitor`.
`bmqa_message` | the application with a message data object.
`bmqa_messageevent` | the application with data event notifications.
`bmqa_messageeventbuilder` | a builder for `MessageEvent` objects.
`bmqa_messageiterator` | a mechanism to iterate over the messages of a `MessageEvent`.
`bmqa_messageproperties` | a value-semantic type representing message properties.
`bmqa_mocksession` | a mock session, implementing `bmqa::AbstractSession`.
`bmqa_openqueuestatus` | a value-semantic type for an open queue operation status.
`bmqa_queueid` | a value-semantic efficient identifier for a queue.
`bmqa_session` | access to the BlazingMQ broker.
`bmqa_sessionevent` | a value-semantic type for system event session notifications.
7 changes: 5 additions & 2 deletions src/groups/bmq/bmqpi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ BMQPI

Description
-----------
The 'bmqpi' package provides pure abstract interfaces, which are intended for
The `bmqpi` package provides pure abstract interfaces, which are intended for
clients to extend in their own applications and libraries. These extension
points facilitate integration with other aspects of a runtime environment (e.g.
authentication, host health-checking), which may vary significantly from
Expand All @@ -17,4 +17,7 @@ Component Synopsis
------------------
Component | Provides ...
--------------------------|--------------------------------------------------------------
`bmqpi_hosthealthmonitor` | an interface for monitoring the health of the underlying host
`bmqpi_dtcontext` | an interface for a context with a notion of a current span.
`bmqpi_dtspan` | an interface representing a span of a distributed trace.
`bmqpi_dttracer` | an interface that can create new `DTSpan` objects.
`bmqpi_hosthealthmonitor` | an interface for monitoring the health of the underlying host.
31 changes: 17 additions & 14 deletions src/groups/bmq/bmqt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,20 @@ the BlazingMQ SDK.

Component Synopsis
------------------
Component | Provides ...
------------------------|-----------------------------------------------------------
`bmqt_correlationid` | a value-semantic type usable as an efficient identifier.
`bmqt_encodingtype` | an enumeration for different message encoding types.
`bmqt_hosthealthstate` | an enumeration for different host health states.
`bmqt_messageeventtype` | an enumeration for the different types of message events.
`bmqt_messageguid` | a value-semantic global unique identifier for BlazingMQ messages.
`bmqt_queueflags` | enums for flags to use at Queue open.
`bmqt_queueoptions` | a value-semantic type for options related to a queue.
`bmqt_resultcode` | enums for various publicly exposed result code.
`bmqt_sessioneventtype` | an enumeration for the different types of session events.
`bmqt_sessionoptions` | a value-semantic type to configure session with the broker.
`bmqt_uri` | value-semantic type and utilities for a BlazingMQ queue URI.
`bmqt_version` | a value-semantic type representing a version (major minor).
Component | Provides ...
--------------------------------|-----------------------------------------------------------
`bmqt_compressionalgorithmtype` | an enumeration for different compression algorithm types.
`bmqt_correlationid` | a value-semantic type usable as an efficient identifier.
`bmqt_encodingtype` | an enumeration for different message encoding types.
`bmqt_hosthealthstate` | an enumeration for different host health states.
`bmqt_messageeventtype` | an enumeration for the different types of message events.
`bmqt_messageguid` | a value-semantic global unique identifier for BlazingMQ messages.
`bmqt_propertytype` | an enum for the supported data types for a message property.
`bmqt_queueflags` | enums for flags to use at Queue open.
`bmqt_queueoptions` | a value-semantic type for options related to a queue.
`bmqt_resultcode` | enums for various publicly exposed result code.
`bmqt_sessioneventtype` | an enumeration for the different types of session events.
`bmqt_sessionoptions` | a value-semantic type to configure session with the broker.
`bmqt_subscription` | a value-semantic types for subscription related API.
`bmqt_uri` | value-semantic type and utilities for a BlazingMQ queue URI.
`bmqt_version` | a value-semantic type representing a version (major minor).

0 comments on commit ed9fa8e

Please sign in to comment.