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

Set EXTRACT_ALL to no for doxygen document builds and resolve all WARN_IF_UNDOCUMENTED and WARN_NO_PARAMDOC warnings #389

Open
skliper opened this issue Nov 1, 2019 · 3 comments
Labels
continuous-integration docs This change only affects documentation. enhancement

Comments

@skliper
Copy link
Contributor

skliper commented Nov 1, 2019

Is your feature request related to a problem? Please describe.
The EXTRACT_ALL flag set to YES defeats the WARN_IF_UNDOCUMENTED and WARN_NO_PARAMDOC enabled errors

Describe the solution you'd like
Set EXTRACT_ALL to NO and explicitly document all elements for at minimum the usersguide documentation.

Describe alternatives you've considered
None

Additional context
None

Requester Info
Jacob Hageman - NASA/GSFC

EDIT - separated original issue, warning file name now in #1589

@skliper skliper added this to the 6.8.0 milestone Nov 1, 2019
@skliper skliper self-assigned this Feb 26, 2020
@skliper skliper removed their assignment Mar 31, 2020
@skliper skliper removed this from the 6.8.0 milestone Mar 31, 2020
@skliper skliper added the docs This change only affects documentation. label May 12, 2020
@skliper skliper added this to the 7.0.0 milestone Jan 6, 2021
@skliper
Copy link
Contributor Author

skliper commented Jan 6, 2021

Note the warning file updates will require updating CI that checks those files.

@astrogeco
Copy link
Contributor

Note the warning file updates will require updating CI that checks those files.

Which update?

@skliper
Copy link
Contributor Author

skliper commented Jan 6, 2021

Note the warning file updates will require updating CI that checks those files.

Which update?

If the warning file name is updated to be unique per document build (suggestion in 2. above).

Note really a requirement, so feel free to reject if you want.

@skliper skliper removed this from the 7.0.0 milestone May 25, 2021
@skliper skliper changed the title Doxygen configuration cleanup Set EXTRACT_ALL to no for doxygen document builds and resolve all WARN_IF_UNDOCUMENTED and WARN_NO_PARAMDOC warnings May 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
continuous-integration docs This change only affects documentation. enhancement
Projects
None yet
Development

No branches or pull requests

2 participants