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

Partial template specialisation in a namespace #442

Closed
NOhs opened this issue Jun 16, 2019 · 2 comments · Fixed by #570
Closed

Partial template specialisation in a namespace #442

NOhs opened this issue Jun 16, 2019 · 2 comments · Fixed by #570
Assignees
Labels
documentation Generated html, changelog, inline comments enhancement Improvements, additions (also cosmetics)

Comments

@NOhs
Copy link

NOhs commented Jun 16, 2019

I have the following C++ file

namespace test
{
/*! some doc
 */
template<typename Func, in Dim>
struct Data{};

/*! some doc for partial specialisation
 */
template<typename Func>
struct Data<Func, 1>{};
};

In my rst file the following works:

.. doxygenstruct:: test::Data

But the following fails:

.. doxygenstruct:: test::Data<Func, 1>

With the warning:

doxygenstruct: Cannot find class “test::Data<Func, 1>” in doxygen xml output for project “test_project” from directory: cpp/xml/

Is this type of partial template specialisation supported? Is my call to doxygenstruct wrong?

Sphinx: 2.1.1
Breathe: 4.13.0.post0

Thanks btw for this cool project :).

@vermeeren
Copy link
Collaborator

Could you post the relevant doxygen XML? I am thinking this may be doxygen splitting things up in a certain way with the templates, which then causes breathe's failure to find it.

@vermeeren
Copy link
Collaborator

This might be fixed with #512, released in Breathe v4.17.0. Note that you also need Sphinx 3.x for recent Breathe versions. Could someone try and post results?

@vermeeren vermeeren added code Source code enhancement Improvements, additions (also cosmetics) labels May 1, 2020
@vermeeren vermeeren added documentation Generated html, changelog, inline comments and removed code Source code labels Aug 27, 2020
@vermeeren vermeeren self-assigned this Aug 27, 2020
@vermeeren vermeeren linked a pull request Aug 27, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Generated html, changelog, inline comments enhancement Improvements, additions (also cosmetics)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants