Skip to content

doxygen: address unresolved reference warnings in range.hpp #1231

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

Merged
merged 1 commit into from
Oct 9, 2024

Conversation

eramongodb
Copy link
Contributor

A small followup to 0f990ca to address the following Doxygen warning:

src/mongocxx/include/mongocxx/v_noabi/mongocxx/options/range.hpp:36: warning: unable to resolve reference to 'trimFactor' for \ref command

Demotes mentions of encryptedFields members to inline monospace text rather than ambiguous or non-existent references to Doxygen entities. (Note: the valid references happen to link to the getter overload for each member function.)

Before:

image

After:

image

@eramongodb eramongodb requested a review from kevinAlbs October 9, 2024 15:14
@eramongodb eramongodb self-assigned this Oct 9, 2024
Copy link
Collaborator

@kevinAlbs kevinAlbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oop. Thank you for the fix.

@eramongodb eramongodb merged commit cd536b3 into mongodb:master Oct 9, 2024
2 of 5 checks passed
@eramongodb eramongodb deleted the cxx-doxygen branch October 9, 2024 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants