Mark deprecated entities in Doxygen and in the codebase #249
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
During the process of open-sourcing BlazingMQ, we converted our public SDK documentation from the BDE style (which our broker implementation still uses) to the more common and standard Doxygen style. However, we seem to have missed a few documentation comments along the way. This patch converts two such comments, moving them above the function to which they apply and converting BDE markup to the Doxygen-supported Markdown markup. Signed-off-by: Patrick M. Niedzielski <[email protected]>
This patch converts the unstructured, artisanal API deprecation warnings in the documentation for MWC and for our public SDK (`bmqa`, `bmqt`) into Doxygen `@deprecated` tags, and also adds corresponding `BSLA_DEPRECATED` attributes to the affected entities. First, by converting deprecation warnings into tags that Doxygen knows about, Doxygen is able to construct a list of deprecated entities in the library, as well as gray them out in generated documentation for the classes or components they appear in. The changes here consist of converting handwritten `DEPRECATED:` sections into `@deprecated` paragraphs, and correcting minor grammatical errors in those paragraphs. Second, introducing `@deprecated` tags into the Doxygen documentation comments causes clang to issue warnings that there is no corresponding `[[deprecated]]` annotation on the entity that the documentation comment applies to. Thus, for each modified Doxygen documentation comment, we also add the `BSLA_DEPRECATED` annotation, which expands to `[[deprecated]]` when compiled with an implementation that supports this attribute. Signed-off-by: Patrick M. Niedzielski <[email protected]>
The `bsls_annotation` component, which provides macros like `BSLS_ANNOTATION_DEPRECATED` which wrap standard C++ attributes for use with earlier compilers, has been deprecated in favor of the `bsla` package. In particular, the `bsla_annotations` component exports macros like `BSLA_DEPRECATED`, which supersede `BSLS_ANNOTATION_DEPRECATED`. This patch converts uses of `BSLS_ANNOTATION_DEPRECATED` to `BSLA_DEPRECATED`, including in cases where the annotation is marked in comments rather than code. We also take this opportunity to convert notices in the documentation to Doxygen style, bringing them into line with other locations in the codebase. Signed-off-by: Patrick M. Niedzielski <[email protected]>
pniedzielski
added
documentation
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.
This PR continues the work started with #242, converting our existing BDE-style documentation to a format that Doxygen understands. The changes here are independent of those in #242, though, so we contribute them as a separate PR. Please see individual commit messages for more detailed information.
Three changes are included:
@deprecatedparagraphs where possible.BSLA_DEPRECATEDannotations where possible.The patches break these changes up somewhat differently so each commit builds without introducing new warnings at each stage.