Skip to content
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.

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

Fix etag.hpp comment that breaks Doxygen 1.12.0 #6014

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

chewi
Copy link
Contributor

@chewi chewi commented Sep 20, 2024

Unfortunately, "*" breaks Doxygen 1.12.0 with the following error:

error: end of comment block while expecting command </em>

I have no idea why. Anything else like '*' or "x" works, but "*" was clearly intended here. The best I can suggest is: * in quotes.

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.

  • C++ Guidelines -- N/A
  • Doxygen docs
  • Unit tests -- N/A
  • No unwanted commits/changes
  • Descriptive title/description
    • PR is single purpose
    • Related issue listed
  • Comments in source
  • No typos
  • Update changelog -- N/A
  • Not work-in-progress
  • External references or docs updated
  • Self review of PR done
  • Any breaking changes?

Unfortunately, "*" breaks Doxygen 1.12.0 with the following error:

    error: end of comment block while expecting command </em>

I have no idea why. Anything else like '*' or "x" works, but "*" was
clearly intended here. The best I can suggest is: * in quotes.
@github-actions github-actions bot added Azure.Core Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization. labels Sep 20, 2024
Copy link

Thank you for your contribution @chewi! We will review the pull request and get back to you soon.

@LarryOsterman
Copy link
Member

Thank you for this change.

@LarryOsterman LarryOsterman merged commit 7fea3ff into Azure:main Sep 20, 2024
51 checks passed
@chewi chewi deleted the doxygen-1.12 branch September 20, 2024 15:55
@ahsonkhan ahsonkhan added the Docs label Sep 21, 2024
azure-sdk added a commit to azure-sdk/vcpkg that referenced this pull request Oct 3, 2024
## 1.14.0 (2024-10-03)

### Features Added

- Added a new constructor for `Azure::Core::Context` that takes an `Azure::DateTime` deadline. This enables creating a new context directly with a deadline.
- Request logs to now include the `accept-range`, `content-range`, `range`, `WWW-Authenticate`, `x-ms-date`, `x-ms-error-code`, `x-ms-range`, and `x-ms-version` headers.
- Added default constructor, `Parse()`, and equality comparison operators to `Azure::Core::Uuid`.
- Added an `Azure::Core::ResourceIdentifier` type.

### Breaking Changes

- Deprecated the `Azure::Core::Context::ApplicationContext` object.
  - If customer code is using `Azure::Core::Context::ApplicationContext`, the customer should instead create their own root context object which is used
  wherever the customer would have previously used `Azure::Core::Context::ApplicationContext`, i.e. `Azure::Core::Context(deadline)` instead of `Azure::Core::Context::ApplicationContext.WithDeadline(deadline)`.

### Bugs Fixed

- Throw `std::invalid_argument` if the value of `TimeFractionFormat` enum passed in to `DateTime::ToString()` is invalid.
- `Azure::Core::Uuid::ToString()` is now `const`.
- Make the HTTP transport behavior consistent between WinHTTP and libcurl by disabling automatically following redirects on Windows.
- Added basic input validation to `Azure::Core::ResourceIdentifier` to ensure the prefix match what is expected.

### Other Changes

- [[microsoft#5851]](Azure/azure-sdk-for-cpp#5851) Remove unneeded `<regex>` includes. (A community contribution, courtesy of _[rschu1ze](https://github.com/rschu1ze)_)
- [[microsoft#6014]](Azure/azure-sdk-for-cpp#6014), [[microsoft#6016]](Azure/azure-sdk-for-cpp#6016) Fixes for Doxygen generation. (A community contribution, courtesy of _[chewi](https://github.com/chewi)_)

### Acknowledgments

Thank you to our developer community members who helped to make Azure Core better with their contributions to this release:

- Robert Schulze _([GitHub](https://github.com/rschu1ze))_
- James Le Cuirot _([GitHub](https://github.com/chewi))_
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Azure.Core Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants