Skip to content

Better warning when in Fortran a comment block is not closed #10587

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

Merged
merged 1 commit into from
Jan 23, 2024

Conversation

albert-github
Copy link
Collaborator

When having e.g. a stray @code in the comment we get a warning like:

Error in file .../gmsh-4.12.2-source/api/gmsh.f90 line: 15475, state: 29(DocCopyBlock)

where the line 15475 is the end of the file.
It is a bit hard to find where the problem actually occurs, so a warning like:

Error in file .../gmsh-4.12.2-source/api/gmsh.f90 line: 15475, state: 29(DocCopyBlock), starting command: '@code' probable line reference: 6689

is better

When having e.g. a stray `@code` in the comment we get a warning like:
```
Error in file .../gmsh-4.12.2-source/api/gmsh.f90 line: 15475, state: 29(DocCopyBlock)
```
where the line 15475 is the end of the file.
It is a bit hard to find where the problem actually occurs, so a warning like:
```
Error in file .../gmsh-4.12.2-source/api/gmsh.f90 line: 15475, state: 29(DocCopyBlock), starting command: '@code' probable line reference: 6689
```
is better
@albert-github albert-github added enhancement a request to enhance doxygen, not a bug Fortran labels Jan 23, 2024
Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@doxygen doxygen merged commit 49e0a34 into doxygen:master Jan 23, 2024
@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 Jan 24, 2024
@albert-github albert-github deleted the feature/bug_ftn_warn_block branch January 24, 2024 08:39
albert-github added a commit to albert-github/doxygen that referenced this pull request Jan 29, 2024
Analogues to doxygen#10587 we also need warnings for program units and as it can be nested we need a stack to record what is still open.
@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement a request to enhance doxygen, not a bug Fortran
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants