issue #9615 doxygen C# regression #9633
Open
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
The problem is that in case non of the output generators HTML, LaTeX, RTF, docbook or Man are used not all the settings are done before the tests are started. We see this problem also when we just set `GENERATE_XML`, we get the warning like" ``` Main.cs(21): warning: parameters of member CSharpTutorials.Program.Main are not documented ``` by introducing a new output generator that will only be enabled in case non of the generators HTML, LaTeX, RTF, docbook or Man is enabled, the settings are done, so the tests can be executed properly.
doxygen
reviewed
Nov 1, 2022
| g_outputList->add<ValidatingGenerator>(); | ||
| ValidatingGenerator::init(); | ||
| } | ||
|
|
There was a problem hiding this comment.
Would it be easier to do this instead?
if (g_outputList->size()==0)
{
Doxygen::suppressDocWarnings=TRUE;
} There was a problem hiding this comment.
No I don't think so.
Doxygen consists, unfortunately, over 2 types of output generators (HTML / RTF / LaTeX / Docbook / Man / ... versus XML / SQLite / ...) and a number of tests / updates are only done in the first type of generators and hence when none of these generators we need a dummy generator that sees to it that the tests / updates are executed.
It might be that the test could be reduced to g_outputList->size()==0 (or even !g_outputList->size()) though as this would be safer for the future.
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.
The problem is that in case none of the output generators HTML, LaTeX, RTF, docbook or Man are used not all the settings are done before the tests are started. We see this problem also when we just set
GENERATE_XML, we get the warning like:by introducing a new output generator that will only be enabled in case non of the generators HTML, LaTeX, RTF, docbook or Man is enabled, the settings are done, so the tests can be executed properly.