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.

Sign up for GitHub

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

Jump to bottom

Unexpected include in the documentation of struct within a namespace #57

Closed
vitaut opened this issue Jan 12, 2013 · 3 comments
Closed

Unexpected include in the documentation of struct within a namespace #57

vitaut opened this issue Jan 12, 2013 · 3 comments

Comments

@vitaut
Copy link
Contributor

vitaut commented Jan 12, 2013

Running the testsuite on the latest version of breathe (b4d53b9...) produces the following output for foo::ns::FooStruct:

struct foo::ns::FooStruct
#include <namespacefile.h>
     Documentation here.

Note the line "#include <namespacefile.h>". It is not in the example on the website: http://michaeljones.github.com/breathe/struct.html#example-with-namespace and the documentation of a struct without a namespace (in global scope) doesn't have such line either.

I am using doxygen 1.8.1.2.
@michaeljones
Copy link
Collaborator

Thank you for this. The presence of the "#include" part is intentional as I think it is valuable information but maybe the positioning could be improved. I'm sorry it it only appearing in some circumstances and not others.

Would you like to see it consistently there? Or optional so that you can remove it?

Cheers,
Michael

@vitaut
Copy link
Contributor Author

vitaut commented Jan 15, 2013

Ideally an option, but consistency would be nice too. Whether it one way or another it doesn't really matter for me.

@vitaut
Copy link
Contributor Author

vitaut commented Dec 18, 2014

Closing the issue as it is possible not to render the include by using a different directive (doxygenstruct instead of doxygenindex).

@vitaut vitaut closed this as completed Dec 18, 2014
rhssk added a commit to rhssk/breathe that referenced this issue Aug 12, 2021
@rhssk
Allow to hide in which headers the struct is defined
9fcd93f 
When something like "doxygennamespace" is used, structures gain
additional line about in which header they are defined.

If the API simply serves as a generic description and not public headers
are provided, this info is redundant. This can be worked around by
manually by using "doxygenstruct" directive instead, but this can get
messy quickly with large namespaces. Also, namespace description is
lost.

Allow to hide these lines by setting 'breathe_show_struct_include' to
'False'. The default behavior is not changed.

Fixes breathe-doc#57.
rhssk added a commit to rhssk/breathe that referenced this issue Aug 12, 2021
@rhssk
Allow to hide in which headers the struct is defined
fef8b04 
When something like "doxygennamespace" is used, structures gain
additional line about in which header they are defined.

If the API simply serves as a generic description and no public headers
are provided, this info is redundant. This can be worked around by
manually by using "doxygenstruct" directive instead, but this can get
messy quickly with large namespaces. Also, namespace description is
lost.

Allow to hide these lines by setting 'breathe_show_struct_include' to
'False'. The default behavior is stays unchanged.

Fixes breathe-doc#57.
rhssk added a commit to rhssk/breathe that referenced this issue Aug 12, 2021
@rhssk
Allow to hide in which headers the struct is defined
8bb8424 
When something like "doxygennamespace" is used, structures gain
additional line about in which header they are defined.

If the API simply serves as a generic description and no public headers
are provided, this info is redundant. This can be worked around by
manually by using "doxygenstruct" directive instead, but this can get
messy quickly with large namespaces. Also, namespace description is
lost.

Allow to hide these lines by setting 'breathe_show_struct_include' to
'False'. The default behavior stays unchanged.

Fixes breathe-doc#57.
@rhssk rhssk mentioned this issue Aug 12, 2021
Closed
rhssk added a commit to rhssk/breathe that referenced this issue Aug 12, 2021
@rhssk
Allow to hide in which headers the struct is defined
f32afb3 
When something like "doxygennamespace" is used, structures gain
additional line about in which header they are defined.

If the API simply serves as a generic description and no public headers
are provided, this info is redundant. This can be worked around by
manually by using "doxygenstruct" directive instead, but this can get
messy quickly with large namespaces. Also, namespace description is
lost.

Allow to hide these lines by setting 'breathe_show_struct_include' to
'False'. The default behavior stays unchanged.

Fixes breathe-doc#57.
rhssk added a commit to rhssk/breathe that referenced this issue Aug 13, 2021
@rhssk
Allow to hide in which headers the struct is defined
e16c9fe 
When something like "doxygennamespace" is used, structures gain
additional line about in which header they are defined.

If the API simply serves as a generic description and no public headers
are provided, this info is redundant. This can be worked around by
manually by using "doxygenstruct" directive instead, but this can get
messy quickly with large namespaces. Also, namespace description is
lost.

Allow to hide these lines by setting 'breathe_show_struct_include' to
'False'. The default behavior stays unchanged.

Fixes breathe-doc#57.
rhssk added a commit to rhssk/breathe that referenced this issue Sep 20, 2021
@rhssk
Allow to hide in which headers the entity is defined
7550ec9 
When something like "doxygennamespace" is used, structures gain
additional line about in which header they are defined.

If the API simply serves as a generic description and no public headers
are provided, this info is redundant. This can be worked around by
manually by using "doxygenstruct" directive instead, but this can get
messy quickly with large namespaces. Also, namespace description is
lost.

Allow to hide these lines by setting 'breathe_show_include' to
'False'. The default behavior stays unchanged.

See breathe-doc#57.
rhssk added a commit to rhssk/breathe that referenced this issue Sep 20, 2021
@rhssk
Allow to hide in which headers the entity is defined
b0ed71f 
When something like "doxygennamespace" is used, structures gain
additional line about in which header they are defined.

If the API simply serves as a generic description and no public headers
are provided, this info is redundant. This can be worked around by
manually by using "doxygenstruct" directive instead, but this can get
messy quickly with large namespaces. Also, namespace description is
lost.

Allow to hide these lines by setting 'breathe_show_include' to
'False'. The default behavior stays unchanged.

See breathe-doc#57.
jakobandersen pushed a commit to jakobandersen/breathe that referenced this issue Nov 20, 2021
@rhssk @jakobandersen
Allow to hide in which headers the entity is defined
4fb7bd5 
When something like "doxygennamespace" is used, structures gain
additional line about in which header they are defined.

If the API simply serves as a generic description and no public headers
are provided, this info is redundant. This can be worked around by
manually by using "doxygenstruct" directive instead, but this can get
messy quickly with large namespaces. Also, namespace description is
lost.

Allow to hide these lines by setting 'breathe_show_include' to
'False'. The default behavior stays unchanged.

See breathe-doc#57.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Allow to hide in which headers the struct is defined rhssk/breathe
2 participants
@michaeljones @vitaut