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

How to link in doxygen generated docu #577

Closed
steffenroeber opened this issue Sep 11, 2020 · 4 comments
Closed

How to link in doxygen generated docu #577

steffenroeber opened this issue Sep 11, 2020 · 4 comments
Assignees
Labels
support Not actual issues, but help

Comments

@steffenroeber
Copy link

Hi,
I found that breathe creates/uses links within the doxygen generated xml files. But only partly. For example, function parameter types have working links to other elements.
I I use

.. doxygenclass:: cipp::cCornerHarrisFunctor
   :members:

in one .rst and

************
harrisCorner
************

Registerd Name: ipp/image/computerVision/harrisCorner

.. doxygenclass:: cipp::cHarrisCornerStation

in another .rst: Then, links from cHarrisCornerStation to cCornerHarrisFunctor (in brief description part) are not resolved. Is this by design ow how I can I solve that? Doxygen resolved it properly in .xml.

Best regards

@vermeeren
Copy link
Collaborator

@steffenroeber Can you check if #566 applies to your project? Do you have have SEPARATE_MEMBER_PAGES set in Doxygen config?

@steffenroeber
Copy link
Author

steffenroeber commented Sep 12, 2020

@vermeeren Hi, no SEPARATE_MEMBER_PAGES is set no 'NO'.
The entry is my .xml is following:

<para>This station serves as a wrapper around <ref refid="classcipp_1_1c_corner_harris_functor" kindref="compound">cipp::cCornerHarrisFunctor</ref>. </para>
    </briefdescription>
    <detaileddescription>
<para><bold>Parameters</bold><itemizedlist>
<listitem><para>threshold: This value serves as a filter for output corners. Only pixel values &gt; this values are sent. Default is 0.5. </para>
</listitem></itemizedlist>
</para>

The generated html looks like:

    This station serves as a wrapper around cipp::cCornerHarrisFunctor.

    Parameters

        threshold: This value serves as a filter for output corners. Only pixel values > this values are sent. Default is 0.5.

I' sure fully sure but I would expect cipp::cCornerHarrisFunctor is a link, right?

@steffenroeber
Copy link
Author

Seems to be solved. Don't know exactly. But now it works. Thanx for help.

@vermeeren
Copy link
Collaborator

@steffenroeber Maybe something was wrong with caching, sometimes deleting doc build dir or using sphinx -E to avoid cache can help. Thanks for letting me know.

@vermeeren vermeeren self-assigned this Sep 12, 2020
@vermeeren vermeeren added the support Not actual issues, but help label Sep 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
support Not actual issues, but help
Projects
None yet
Development

No branches or pull requests

2 participants