Fix wrong refid when SEPARATE_MEMBER_PAGES is YES #566
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
|
This is clearly a bug in Doxygen's xmlgen, so I will submit a fix there soon. This works as a band-aid and I hope without side-effects. |
vermeeren
reviewed
Aug 18, 2020
utzig
force-pushed
the
fix-ref-refid
branch
2 times, most recently
from
cff4e4f
to
0df7eb9
Compare
utzig
changed the title
utzig
changed the title
utzig
changed the title
|
@vermeeren I updated this PR now that it got clearer what the source of the issue was, doxygen/doxygen#7971 (comment); it works OK for our projects which are rather big but it's hard to say if it handles all possible permutations of ids created by Doxygen, but I guess it does. |
vermeeren
added
code
When Doxygen is configured the SEPARATE_MEMBER_PAGES set to YES, the
following Doxygen input:
```
/**
* This struct must be used with f()
*/
struct t {
int x;
}
/**
* @param tx A struct t pointer
*/
void f(struct t *tx) {
(void)tx;
}
```
The `f()` in struct t's comment generates a <ref> element with `refid`
equal to `some_prefix_compoundid_anchorid`, wheres the `id` in the
refered element ends up with an `id` equal to `some_prefix_anchorid`.
The anchorid here is the compoundid prefix by "_1", with one or two
extra 'g' prefixes for groups, so the `refid` actually has this
information duplicated.
This is a band-aid solution that, when configured enabled in conf.py,
tries to detect the issue in the refids and removes the extra baggage,
so resulting links work.
Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
vermeeren
approved these changes
Sep 10, 2020
vermeeren
added a commit
that referenced
this pull request
Sep 10, 2020
|
@utzig Just released v4.21.0 with both PRs, thanks again! |
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.
When Doxygen is configured the SEPARATE_MEMBER_PAGES set to YES, the following Doxygen input:
The
f()in struct t's comment generates a element withrefidequal tosome_prefix_compoundid_anchorid, wheres theidin the refered element ends up with anidequal tosome_prefix_anchorid. The anchorid here is the compoundid prefix by "_1", with one or two extra 'g' prefixes for groups, so therefidactually has this information duplicated.This is a band-aid solution that, when configured enabled in conf.py, tries to detect the issue in the refids and removes the extra baggage, so resulting links work.