Fix unresolvable doxygen links that are fatal with doxygen 1.16#7229
Open
chewi wants to merge 1 commit into
Open
Fix unresolvable doxygen links that are fatal with doxygen 1.16#7229chewi wants to merge 1 commit into
chewi wants to merge 1 commit into
Conversation
For example:
Generating code for file sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_client_options.hpp:79: error: explicit link request to 'KeyClient::CreateKey' could not be resolved
Signed-off-by: James Le Cuirot <jlecuirot@microsoft.com>
github-actions
Bot
added
Community Contribution
|
Thank you for your contribution @chewi! We will review the pull request and get back to you soon. |
|
Azure Pipelines: Successfully started running 3 pipeline(s). 7 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Key Vault Keys public header documentation to avoid Doxygen 1.16 “explicit link request … could not be resolved” failures by adjusting symbol-reference formatting, and records the change in the package changelog.
Changes:
- Replace Doxygen explicit-link syntaxes (e.g.,
#Type.Member) with C++-style references (e.g.,Type::Member) in KeyClient and Cryptography docs. - Fix/adjust various documentation references in cryptography models to avoid unresolvable links.
- Add an entry to
CHANGELOG.mdnoting the Doxygen 1.16 documentation-generation fix.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_client.hpp | Updates Doxygen references in KeyClient method docs to avoid unresolvable explicit links. |
| sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_client_options.hpp | Updates Doxygen reference style for CreateKey options documentation. |
| sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/cryptography/cryptography_client.hpp | Updates Verify/VerifyData docs to use VerifyResult::IsValid style references. |
| sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/cryptography/cryptography_client_models.hpp | Updates multiple model docs to use Type::Member references and removes explicit-link forms that can fail under Doxygen 1.16. |
| sdk/keyvault/azure-security-keyvault-keys/CHANGELOG.md | Adds an unreleased changelog note for the Doxygen 1.16 doc-generation fix. |
| * @param iv Optional initialization vector. If null, a cryptographically random initialization | ||
| * vector will be generated using RandomNumberGenerator. | ||
| * @return An instance of the #DecryptParameters class for the #EncryptionAlgorithm::A192Cbc | ||
| * @return An instance of the #DecryptParameters class for the EncryptionAlgorithm::A192Cbc |
| * @param iv Optional initialization vector. If null, a cryptographically random initialization | ||
| * vector will be generated using RandomNumberGenerator. | ||
| * @return An instance of the #EncryptParameters class for the #EncryptionAlgorithm::A192Cbc | ||
| * @return An instance of the #EncryptParameters class for the EncryptionAlgorithm::A192Cbc |
This file contains hidden or 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
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.
For example, the build would include failures like this:
I don't know much about doxygen, but Copilot advised me to remove the
#characters and replace.with::. I checked most of the affected pages afterwards, and the links were still generated and valid.Pull Request Checklist
Please leverage this checklist as a reminder to address commonly occurring feedback when submitting a pull request to make sure your PR can be reviewed quickly:
See the detailed list in the contributing guide.