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

No doxygen for BoundingBox::NeighborType enumerator #7730

Closed
davydden opened this issue Feb 14, 2019 · 6 comments · Fixed by #9855
Closed

No doxygen for BoundingBox::NeighborType enumerator #7730

davydden opened this issue Feb 14, 2019 · 6 comments · Fixed by #9855

Comments

@davydden
Copy link
Contributor

davydden commented Feb 14, 2019

subj.

@davydden davydden added this to the Release 9.1 milestone Feb 14, 2019
@kronbichler kronbichler modified the milestones: Release 9.1, Release 9.2 May 10, 2019
@kronbichler
Copy link
Member

Uncritical, postponing for the 9.2 release.

@bangerth
Copy link
Member

bangerth commented Feb 3, 2020

As reported by @peterrum over at #9486:

The following enum classes seem to make also problems: Storage, ComponentExtractor and SIMDComparison...

@bangerth
Copy link
Member

bangerth commented Apr 4, 2020

I've tried to figure out what's going on here several times but can't seem to make progress. There is no error in doxygen.log, and no other indication of what's going wrong. I've also tried to replace the enum class by enum or class to see whether doxygen likes that better, but the answer is no for enum. For class, it seems to work, but that's of course not useful. I'm not sure what we should do.

@tjhei
Copy link
Member

tjhei commented Apr 4, 2020

I changed the settings

--- a/doc/doxygen/options.dox.in
+++ b/doc/doxygen/options.dox.in
@@ -39,12 +39,12 @@ BUILTIN_STL_SUPPORT    = YES
 # Build related configuration options
 #---------------------------------------------------------------------------
 
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 EXTRACT_PRIVATE        = YES
 EXTRACT_STATIC         = YES
 EXTRACT_LOCAL_CLASSES  = YES
-HIDE_UNDOC_MEMBERS     = YES
-HIDE_UNDOC_CLASSES     = YES
+HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_CLASSES     = NO
 SORT_MEMBER_DOCS       = NO

and now it shows up for me. I am not sure which of those settings did it, though. Worth changing the defaults for?

@bangerth
Copy link
Member

bangerth commented Apr 4, 2020

Which of these settings is it?

@tjhei
Copy link
Member

tjhei commented Apr 5, 2020

I played with this some more (including other extract_* flags we don't have in our options, setting @file, settings @relates, etc.): The only thing that makes this enum show up is EXTRACT_ALL=YES or putting it into a namespace (*).
*: we delete the "namespace dealii{" for doxygen, which makes this enum a global symbol. A workaround would be to move it into a namespace (or class scope).
Or, we could just enable EXTRACT_ALL?

tjhei added a commit to tjhei/dealii that referenced this issue Apr 7, 2020
doxygen has a bug to not extract global enums (see dealii#7730). The only
current know option is to change the default to extract everything by
setting EXTRACT_ALL=YES.
Also add other options while we are here and enable generating
documentation for undocumented members/classes.
tjhei added a commit to tjhei/dealii that referenced this issue Apr 8, 2020
doxygen has a bug to not extract global enums (see dealii#7730). The only
current know option is to change the default to extract everything by
setting EXTRACT_ALL=YES.
Also add other options while we are here and enable generating
documentation for undocumented members/classes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants