fixes "double friend" issue
#918
Open
Conversation
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
C++ specifiers can go in almost any order, but the `friend` logic was
overlooking this for some cases. In particular, `constexpr friend`
wasn't being accounted for.
The following cases have been verified.
```cpp
struct cat {
/// Checks if the cats are the same.
constexpr friend bool operator==(cat x, cat y)
{
return true;
}
/// Makes the cat cute.
friend void make_cute(cat c)
{
}
/// Makes the cat cuter.
friend void make_cuter(cat c);
/// Makes the cat the cutest.
constexpr friend void make_cutest(cat c);
};
/// This won't be picked up.
constexpr void make_cutest(cat c)
{}
```
Fixes breathe-doc#916
|
Is there a way to add unit tests? I haven't worked out how to do that for this project yet :( |
|
Since I have a vested interest in this getting merged (in that I would love for it to be fixed, and also for the fix for #917 to get merged), I messed around with the testing infrastructure and I wrote what I believe is a sufficient test for this fix. @cjdb, I'm sending it to you as a PR on the |
Merged
|
Hi, I was wondering if this could be reviewed and merged. Are there next steps still needed or is this waiting for a maintainer? |
AA-Turner
reviewed
Apr 24, 2025
Comment on lines
+1989
to
+1992
| # In Doxygen up to somewhere between 1.8.17 to exclusive 1.9.1 | ||
| # the 'friend' part is also left in the type. | ||
| # See also: #767, #916 | ||
| typ = re.sub(r"(^|\s+)friend(\s+)", r"\1\2", typ) |
There was a problem hiding this comment.
We now require Doxygen 1.9.2+. Is this still relevant?
|
Happy to merge if conflicts are resolved |
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.
C++ specifiers can go in almost any order, but the
friendlogic was overlooking this for some cases. In particular,constexpr friendwasn't being accounted for.The following cases have been verified.
Fixes #916