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

Documentation of class template specialisation in a group, is not generated #221

Open
Swat-SomeBug opened this issue Apr 4, 2022 · 0 comments

Comments

@Swat-SomeBug
Copy link

Hi,
There is currently no documentation generated for the template specialisation test<int> in the contrived example below.

Sample Code

namespace t3 {

  /// \brief This is the base template
  /// \group temp_test
  template<typename T>
    class test;

  /// \group temp_test
  template<> class test<int> {
    int i{0};

  public:
    /// Public interface
    int operator()() const {
      return i;
    }

    /// Assignment operator
    auto& operator=(int v) {
      i = v;
      return *this;
    }
  };
}

Documentation output

### Class `t3::test`

``` cpp
(1) template <typename T>
class test;

(2) template <>
class test<int>
{
public:
    int operator()() const;

    auto& operator=(int v);
};
```

This is the base template

-----

Trial

  • When I ungroup test and test<int> all documentation is generated as separate entities.
  • When the documentation of the test is removed, test<int> is documented as 'hidden'<int>.

Is there a way to document all entities in a group?

Additional info

  • Standardese v0.5 from docker image
  • Compilation by passing the file directly without additional arguments.
standardese test.hpp

Related: #204

@Swat-SomeBug Swat-SomeBug changed the title Documentation of class template specialisation not generated Documentation of class template specialisation in a group, is not generated Apr 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant