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

Warnings due to multiple "sectioning" commands inside an \if type construct #10817

Merged
merged 2 commits into from Apr 26, 2024

Conversation

albert-github
Copy link
Collaborator

When having a construct like:

/*!
@if LANG_ENGLISH
@file test.h

This is the description of test.h

@class Dtk::Core::Fn_Test test.h
@brief Fn_Test class.

Details about Fn_Test.

@fn const char *Fn_Test::member(char c,int n)
@brief A member function.

Details of the function

@param c a character.
@param n an integer.
@exception std::out_of_range parameter is out of range.
@return a character pointer.

@fn void Fn_Test::undocumented()
@brief test

@endif
*/

we get warnings like:

.../test.en_US.dox:7: warning: Documentation block ended in the middle of a conditional section!
.../test.en_US.dox:25: warning: found \endif without matching start command

due to the fact that the part about the \file is ended by means of the \class command and later restarted but the test about the \if termination does not know about this restart (and thus the warning), and when restarted the \if... stack is newly defined specified so the \endif is on its own.

We need to "save" the stack for further use.

Example: example.tar.gz

…onstruct

When having a construct like:
```
/*!
@if LANG_ENGLISH
@file test.h

This is the description of test.h

@Class Dtk::Core::Fn_Test test.h
@brief Fn_Test class.

Details about Fn_Test.

@fn const char *Fn_Test::member(char c,int n)
@brief A member function.

Details of the function

@param c a character.
@param n an integer.
@exception std::out_of_range parameter is out of range.
@return a character pointer.

@fn void Fn_Test::undocumented()
@brief test

@endif
*/
```
we get warnings like:
```
.../test.en_US.dox:7: warning: Documentation block ended in the middle of a conditional section!
.../test.en_US.dox:25: warning: found \endif without matching start command
```
due to the fact that the part about the `\file` is ended by means of the `\class` command and later restarted but the test about the `\if` termination does not know about this restart (and thus the warning), and when restarted the `\if...` stack is newly defined specified so the `\endif` is on its own.

We need to "save" the stack for further use.
…onstruct

Corrected typo for internal documentation
@doxygen doxygen merged commit 09ef0d5 into doxygen:master Apr 26, 2024
8 checks passed
@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Apr 27, 2024
@albert-github albert-github deleted the feature/bug_if_section branch April 27, 2024 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug fixed but not released Bug is fixed in github, but still needs to make its way to an official release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants