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

Duplicated class if forward declared when using category directives #114

Open
jmillan opened this issue Jan 25, 2016 · 1 comment
Open

Comments

@jmillan
Copy link

jmillan commented Jan 25, 2016

Hi,

The following code perfectly generates the documentation for the given classes

/* cldoc:begin-category(core::A) */
class A;
/* cldoc:end-category() */

/* cldoc:begin-category(core::A) */
class A {
  public:
  int a;
};
/* cldoc:end-category() */

Whereas removing the category directive around the forward declaration duplicates the A class on the documentation. It generates an A class object in the root space and another one in the core category.

This is not a bug. I would expect it to work as it does. I just want to ask whether I need to surround with these directives every forward declaration which canonical declaration is also 'categorized', or whether there's another way (less manual) to do it.

Any feedback is very appreciated.

@jmillan
Copy link
Author

jmillan commented Feb 1, 2016

I can't think of any solution which does not imply surrounding the forward declarations with the (begin-category and end-category) directives, which I can't afford.

It's a pity, other than this I find the project very useful.

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