Docs[BMQ] bde -> doxygen conversion fixes #443
Merged
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
chrisbeard
force-pushed
the
doxygen-fixes
branch
2 times, most recently
from
b318fa0 to
9069182
Compare
pniedzielski
previously approved these changes
Oct 7, 2024
chrisbeard
force-pushed
the
doxygen-fixes
branch
6 times, most recently
from
9175171 to
86b12f7
Compare
Signed-off-by: Christopher Beard <[email protected]>
Signed-off-by: Christopher Beard <[email protected]>
Signed-off-by: Christopher Beard <[email protected]>
Signed-off-by: Christopher Beard <[email protected]>
chrisbeard
force-pushed
the
doxygen-fixes
branch
from
86b12f7 to
874ed67
Compare
678098
reviewed
Oct 7, 2024
pniedzielski
approved these changes
Oct 7, 2024
Co-authored-by: Evgeny Malygin <[email protected]> Signed-off-by: Chris Beard <[email protected]>
chrisbeard
force-pushed
the
doxygen-fixes
branch
from
896ea22 to
fb06089
Compare
alexander-e1off
pushed a commit
to alexander-e1off/blazingmq
that referenced
this pull request
Oct 24, 2024
* Doc[BMQT] minor bde -> doxygen docs * Doc[BMQA] minor bde -> doxygen docs * Doc[BMQA] re-wrap data member comments * Doc[BMQT] re-wrap data member comments * Apply suggestions from code review --------- Signed-off-by: Christopher Beard <[email protected]> Signed-off-by: Chris Beard <[email protected]> Co-authored-by: Evgeny Malygin <[email protected]>
alexander-e1off
pushed a commit
to alexander-e1off/blazingmq
that referenced
this pull request
Oct 24, 2024
* Doc[BMQT] minor bde -> doxygen docs * Doc[BMQA] minor bde -> doxygen docs * Doc[BMQA] re-wrap data member comments * Doc[BMQT] re-wrap data member comments * Apply suggestions from code review --------- Signed-off-by: Christopher Beard <[email protected]> Signed-off-by: Chris Beard <[email protected]> Co-authored-by: Evgeny Malygin <[email protected]>
alexander-e1off
pushed a commit
to alexander-e1off/blazingmq
that referenced
this pull request
Oct 24, 2024
Signed-off-by: Christopher Beard <[email protected]> fixing Solaris build (bloomberg#434) Signed-off-by: dorjesinpo <[email protected]> Remove `-DBMQ_ENABLE_MSG_GROUPID` from the build system We do not ever want to build with this flag when releasing, and users often manage to enable this flag accidentally. Because message group IDs are not fully implemented, we remove this temporary definition. It can be added in later if we ever come back to this feature. Signed-off-by: Patrick M. Niedzielski <[email protected]> Make unit tests pass without `BMQ_ENABLE_MSG_GROUPID` The unit tests currently assume that message group IDs are enabled, and since have updated our build system to no longer enable this feature, the unit tests now fail in CI. This patch guards the message group ID tests with preprocessor conditionals, disabling the parts of tests that try to set and check message group IDs. When `BMQ_ENABLE_MSG_GROUPID` is set, these parts of the unit tests run again. Signed-off-by: Patrick M. Niedzielski <[email protected]> Fix mqbstat doc formatting (bloomberg#438) Signed-off-by: Christopher Beard <[email protected]> Fix[bmqeval]: limit expression length to avoid stack overflow (bloomberg#441) Signed-off-by: Evgeny Malygin <[email protected]> Fix Solaris unit tests (bloomberg#440) Signed-off-by: Anton Pryakhin <[email protected]> Docs[BMQ]: Use `.dox` files rather than `.md` files Package group documentation in `libbmq` was converted to Markdown files named `README.md`, and which was tied to the directory containing the code for the package group using Doxygen `@dir` commands. However, when generating the documentation, this left several empty pages in the documentation named `README`, which we were not able to remove. The solution for this that this patch uses is to switch from `.md` files to `.dox` files, which contain a single Doxygen-style C++ comment containing the `@dir` command. Unlike `.md` files, these do not automatically create pages, so there is no empty `README` page created for each package group. The cost of this is that `.dox` files cannot be simple Markdown files, but instead need to be wrapped in a C++ comment. Signed-off-by: Patrick M. Niedzielski <[email protected]> Docs[BMQ] bde -> doxygen conversion fixes (bloomberg#443) * Doc[BMQT] minor bde -> doxygen docs * Doc[BMQA] minor bde -> doxygen docs * Doc[BMQA] re-wrap data member comments * Doc[BMQT] re-wrap data member comments * Apply suggestions from code review --------- Signed-off-by: Christopher Beard <[email protected]> Signed-off-by: Chris Beard <[email protected]> Co-authored-by: Evgeny Malygin <[email protected]> Feat: track queue depth per appId (bloomberg#320) Signed-off-by: Evgeny Malygin <[email protected]> configurator, bmqit: mode protos (bloomberg#447) Signed-off-by: Jean-Louis Leroy <[email protected]> Revert "configurator, bmqit: mode protos (bloomberg#447)" (bloomberg#449) This reverts commit a4b20db. Fix[mqbs_virtualstoragecatalog.cpp]: fix Solaris build (bloomberg#450) Signed-off-by: Evgeny Malygin <[email protected]> fix: configurator: apply app ids (bloomberg#452) Signed-off-by: Jean-Louis Leroy <[email protected]> Fix [MQB]: mqbc::StorageMgr: Transition to available only when all primary active (bloomberg#416) * mqbc::StorageMgr: Ban 'processPrimaryStatusAdvisory' in non-FSM mode Signed-off-by: Yuan Jing Vincent Yan <[email protected]> * mqbc::StorageMgr: Transition to available only when all primary active Signed-off-by: Yuan Jing Vincent Yan <[email protected]> * mqbc::StorageMgr: clang-format Signed-off-by: Yuan Jing Vincent Yan <[email protected]> * mqbc::StorageMgr: Healing replica buffers primary status advisories Signed-off-by: Yuan Jing Vincent Yan <[email protected]> * mqbs::FileStore: Rename setPrimary -> setActivePrimary Signed-off-by: Yuan Jing Vincent Yan <[email protected]> * mqbc::StorageMgr: Comment about check if all partitions available Signed-off-by: Yuan Jing Vincent Yan <[email protected]> --------- Signed-off-by: Yuan Jing Vincent Yan <[email protected]> Fix some compiler warnings in mqb (bloomberg#455) * -Wunused-parameter * -Wshadow * -Wswitch-enum Signed-off-by: Christopher Beard <[email protected]> It: Include full path for admin stat it test failures (bloomberg#453) * It: Include full path for admin stat it test failures This patch makes it a little easier to debug the metric & operation that causes an integration test for stats to fail. Signed-off-by: Christopher Beard <[email protected]> * Update src/integration-tests/test_admin_client.py Co-authored-by: Evgeny Malygin <[email protected]> Signed-off-by: Chris Beard <[email protected]> --------- Signed-off-by: Christopher Beard <[email protected]> Signed-off-by: Chris Beard <[email protected]> Co-authored-by: Evgeny Malygin <[email protected]> Feat: Add queue history size metric (bloomberg#436) * [WIP] Feat: Add queue history size metric This adds a new queue metric that counts the number of GUIDs in that queue's history. This is useful for identifying excessive memory utilization from history and potential history garbage collection issues (where history is filled up faster than it's cleaned up). Signed-off-by: Christopher Beard <[email protected]> * It: Extend admin it for history size stat Signed-off-by: Christopher Beard <[email protected]> --------- Signed-off-by: Christopher Beard <[email protected]> Feat[plugins]: report queue depth per appId to prometheus (bloomberg#446) Signed-off-by: Evgeny Malygin <[email protected]> [Fix] m_bmqstoragetool::FileManagerImpl: Asserts not have side effects (bloomberg#461) Signed-off-by: Yuan Jing Vincent Yan <[email protected]> Feat[MQB]: Enhance queue consumption monitor alarm log with additional details (bloomberg#420) Enhance filebackedstorage alarm log Signed-off-by: Aleksandr Ivanov <[email protected]> Cleanup Signed-off-by: Aleksandr Ivanov <[email protected]> Add test to mqbu_capacitymeter.t Signed-off-by: Aleksandr Ivanov <[email protected]> mqbc::StorageUtil, mqbi::StorageMgr: updateQueue -> updateQueuePrimary (bloomberg#466) Signed-off-by: Yuan Jing Vincent Yan <[email protected]> Fix[MQB]: misc warnings (bloomberg#464) Allow dots in subscription property names Message properties allow arbitrary strings for property names, but our subscription expression language is more limited, requiring an initial alphabetic character followed by any number of alphanumeric characters and underscores. Some producers have begun using hierarchical message property names, separated by dots (“.”), and are unable to use subscriptions to filter or route according to these message properties. This patch extends the expression language grammar to enable matching on subscription property names with dots in them. This change is a pure extension: the language recognized by the subscription expression grammar after this patch is a strict superset of the language recognized by the subscription expression grammar before this patch. This patch also extends the unit test for the lexer to ensure this is a strict superset. Signed-off-by: Patrick M. Niedzielski <[email protected]> fix: clean app subscriptions on reconfigure Signed-off-by: dorjesinpo <[email protected]> Fix[mqbstat_domainstats.cpp]: empty tier StringRef (bloomberg#431) Signed-off-by: Evgeny Malygin <[email protected]> Fix Solaris build, it does not support ctor delegation Signed-off-by: Aleksandr Ivanov <[email protected]> Doc: Document app subscriptions (bloomberg#463) * Docs upgrade jekyll -> 4.3.3 Signed-off-by: Christopher Beard <[email protected]> * Docs: Document app subscriptions Signed-off-by: Christopher Beard <[email protected]> * Expand on difference in subscriptions Signed-off-by: Christopher Beard <[email protected]> * Minor subscription doc clarifications Signed-off-by: Christopher Beard <[email protected]> * Elaborate on subscription details Signed-off-by: Christopher Beard <[email protected]> * Clarify consumer subscription on broker Signed-off-by: Christopher Beard <[email protected]> --------- Signed-off-by: Christopher Beard <[email protected]> fix: enhanced detection of duplciate PUSHes (bloomberg#472) Signed-off-by: dorjesinpo <[email protected]> Fix ntf-core version in build_darwin.sh Signed-off-by: Aleksandr Ivanov <[email protected]> Add logAppsSubscriptionInfoCb into InMemoryStorage Signed-off-by: Aleksandr Ivanov <[email protected]> Add IT for capacity meter enhanced log Signed-off-by: Aleksandr Ivanov <[email protected]> Fix comments Signed-off-by: Aleksandr Ivanov <[email protected]> Fix [CI] ntf-core version for macosx build (bloomberg#473) Merge mwc into bmq MWC or "MiddleWare Core" was a package group developed to support a myriad of applications at Bloomberg. It's been useful to share common middleware components between similar technologies, but doesn't make much sense to support as its own open source library. Moving forward we are merging it into the BMQ package group to better maintain it for the BlazingMQ project. Signed-off-by: Taylor Foxhall <[email protected]> Fix conflict Signed-off-by: Aleksandr Ivanov <[email protected]> Fix conflict Signed-off-by: Aleksandr Ivanov <[email protected]> Fix mwctst Signed-off-by: Aleksandr Ivanov <[email protected]>
pniedzielski
added a commit
to pniedzielski/blazingmq
that referenced
this pull request
Nov 7, 2024
This patch introduces three new targets to the build system when Doxygen
is present:
- `apidocs`: Build the public API documentation for public libbmq
components. This target functions similarly to how the current
`Doxyfile` builds documentation.
- `internaldocs`: Build the internal documentation for all libbmq and
libmqb components. The documentation built by this target is
currently incomplete, and needs work along the lines of PRs bloomberg#443 and
bloomberg#444.
- `docs`: Build both the above documentation targets. This is a
dependency of `make all`, so it will run by default.
Signed-off-by: Patrick M. Niedzielski <[email protected]>
pniedzielski
added a commit
to pniedzielski/blazingmq
that referenced
this pull request
Nov 7, 2024
This patch introduces three new targets to the build system when Doxygen
is present:
- `apidocs`: Build the public API documentation for public libbmq
components. This target functions similarly to how the current
`Doxyfile` builds documentation.
- `internaldocs`: Build the internal documentation for all libbmq and
libmqb components. The documentation built by this target is
currently incomplete, and needs work along the lines of PRs bloomberg#443 and
bloomberg#444.
- `docs`: Build both the above documentation targets. This is a
dependency of `make all`, so it will run by default.
Signed-off-by: Patrick M. Niedzielski <[email protected]>
pniedzielski
added a commit
to pniedzielski/blazingmq
that referenced
this pull request
Nov 7, 2024
This patch introduces three new targets to the build system when Doxygen
is present:
- `apidocs`: Build the public API documentation for public libbmq
components. This target functions similarly to how the current
`Doxyfile` builds documentation.
- `internaldocs`: Build the internal documentation for all libbmq and
libmqb components. The documentation built by this target is
currently incomplete, and needs work along the lines of PRs bloomberg#443 and
bloomberg#444.
- `docs`: Build both the above documentation targets. This is a
dependency of `make all`, so it will run by default.
Signed-off-by: Patrick M. Niedzielski <[email protected]>
pniedzielski
added a commit
that referenced
this pull request
Nov 8, 2024
This patch introduces three new targets to the build system when Doxygen
is present:
- `apidocs`: Build the public API documentation for public libbmq
components. This target functions similarly to how the current
`Doxyfile` builds documentation.
- `internaldocs`: Build the internal documentation for all libbmq and
libmqb components. The documentation built by this target is
currently incomplete, and needs work along the lines of PRs #443 and
#444.
- `docs`: Build both the above documentation targets. This is a
dependency of `make all`, so it will run by default.
Signed-off-by: Patrick M. Niedzielski <[email protected]>
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.
Relates to: #118
Describe your changes
This PR fixes a few places where tooling failed to migrate BDE-style docs to doxygen for data members and associated types/enums. I've tried to keep the comment style intact without changing the structure.