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 wrong refid when SEPARATE_MEMBER_PAGES is YES #566

Merged
merged 1 commit into from
Sep 10, 2020

Commits on Sep 4, 2020

  1. Fix wrong refid when SEPARATE_MEMBER_PAGES is YES

    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>
    utzig committed Sep 4, 2020
    Configuration menu
    Copy the full SHA
    82c1a7b View commit details
    Browse the repository at this point in the history