added #ifndef DOXYGEN to forward declarations #8585
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Sure, go ahead. #8566 was recently going in a similar direction. |
|
Do you want us to merge this as-is and follow up with potential other places separately (which I'm ok with), or do you want to include it all in this PR by pushing more changes? |
|
I am going to push more changes to the this PR. |
bangerth
approved these changes
Aug 17, 2019
|
I have no idea why this is no tested. Let's try again. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Forward declarations cause doxygen to report an incorrect location for the definition of a class/struct. For example, at the end of the documentation of
SymmetricTensorit saysinstead of
This PR attempts to fix it. My first commit is a proof of concept that fixes this issue for the documentation of
TensorandSymmetricTensor. If you agree with these changes, I will add apply the same modifications to all forward declarations of all header files.In my observation, the issue is seen only for forward-declared classes/structs. doxygen does not have a problem with forward-declared functions.