Skip to content

Remove header lines for Doxygen #398

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 2 commits into from
Sep 22, 2024
Merged

Conversation

fktn-k
Copy link
Owner

@fktn-k fktn-k commented Sep 22, 2024

In this PR, all the header lines /// @file in the library sources have been removed.
That was added when this project was using Doxygen as a documentation generator, but now MkDocs is used and those lines are completely useless.
Note that doxygen style comments for functions and variables remains as-is because they are very useful as a commnon method to grasp how implementations work for what, especially in internal library sources.


Pull Request Checklist

Read the CONTRIBUTING.md file for detailed information.

  • Changes are described in the pull request or in a referenced issue.
  • The test suite compiles and runs without any error.
  • The code coverage on your branch is 100%.
  • The documentation is updated if you added/changed a feature.

Please don't

  • The C++11 support varies between different compilers and versions. Please note the list of supported compilers. Some compilers like GCC 4.7 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support. Please refrain from proposing changes that work around these compiler's limitations with #ifdefs or other means.
  • Please refrain from proposing changes that would break YAML specifications. If you propose a conformant extension of YAML to be supported by the library, please motivate this extension.
  • Please do not open pull requests that address multiple issues.

@fktn-k fktn-k self-assigned this Sep 22, 2024
@fktn-k fktn-k added this to the Release v0.3.13 milestone Sep 22, 2024
Copy link

:octocat: Upload Coverage Event Notification

Coverage data has been uploaded for the commit cb210f10dd9dd60327cbdd6cd71ab7aa6d814818.
You can download the artifact which contains the same file uploaded to the Coveralls and its HTML version.

Name fkYAML_coverage.pr398.zip
ID 1963144042
URL https://github.com/fktn-k/fkYAML/actions/runs/10981019634/artifacts/1963144042

@fktn-k fktn-k merged commit ede6da8 into develop Sep 22, 2024
165 checks passed
@fktn-k fktn-k deleted the remove_header_line_for_doxygen branch September 22, 2024 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant