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

doxygenclass for a template specialization not found #569

Closed
cary-ilm opened this issue Aug 27, 2020 · 3 comments · Fixed by #570
Closed

doxygenclass for a template specialization not found #569

cary-ilm opened this issue Aug 27, 2020 · 3 comments · Fixed by #570
Assignees
Labels
documentation Generated html, changelog, inline comments enhancement Improvements, additions (also cosmetics)

Comments

@cary-ilm
Copy link
Contributor

I'm trying to reference a C++ template specialization in a doxygenclass directive:

/// Foo<T>
template <class T> class Foo
{
  public:
    Foo() {}
};

/// Foo<std::vector<T>>
template <class T> class Foo<std::vector<T>>
{
  public:
   Foo() {}

    /// bar
    void bar();
};

In rst, this works fine:

.. doxygenclass:: Foo

but is there syntax to reference the Foo<std::vector> specialization? No incarnation like this seems to work:

.. doxygenclass: Foo<std::vector>

.. doxygenclass:: Foo<std::vector<T>>

This gives: WARNING: doxygenclass: Cannot find class "Foo<std::vector>" in doxygen xml output"

Is this supported? What is the syntax? Thanks for any guidance.

foo.tar.gz

@utzig
Copy link
Contributor

utzig commented Aug 27, 2020

You have to use: .. doxygenclass:: Foo< std::vector< T > > (correct spacing here is important!)

@vermeeren
Copy link
Collaborator

On a side note, issue itself seems a lot like #442. Based upon the above by @utzig I think it's safe to resolve that one too if this is confirmed to be ok by @cary-ilm .

@cary-ilm
Copy link
Contributor Author

That works like a charm, with the proper spacing inside the <>, it correctly processes the class. Thanks for the speedy response! I submitted #570 to add a note to the documentation about the spacing requirements.

@vermeeren vermeeren added documentation Generated html, changelog, inline comments enhancement Improvements, additions (also cosmetics) labels 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.

3 participants