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

Add preprocessor macros for documentation #543

Merged
merged 2 commits into from
May 10, 2023
Merged

Add preprocessor macros for documentation #543

merged 2 commits into from
May 10, 2023

Conversation

sandro-elsweijer
Copy link
Collaborator

@sandro-elsweijer sandro-elsweijer commented May 9, 2023

Describe your changes here:
Adds our link flags to the preprocessor macros of Doxygen. This way, Doxygen also generates the documentation behind a T8_ENABLE_DEBUG, T8_WITH_VTK, ... macro.
Fixes #426

All these boxes must be checked by the reviewers before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

General

  • The reviewer executed the new code features at least once and checked the results manually

  • The code follows the t8code coding guidelines

  • New source/header files are properly added to the Makefiles

  • The code is well documented

  • All function declarations, structs/classes and their members have a proper doxygen documentation

  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue)

Tests

  • The code is covered in an existing or new test case using Google Test

Github action

  • The code compiles without warning in debugging and release mode, with and without MPI (this should be executed automatically in a github action)

  • All tests pass (in various configurations, this should be executed automatically in a github action)

    If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

    • Should this use case be added to the github action?
    • If not, does the specific use case compile and all tests pass (check manually)

Scripts and Wiki

  • If a new directory with source-files is added, it must be covered by the script/find_all_source_files.scp to check the indentation of these files.
  • New Datatypes are added to t8indent_custom_datatypes.txt
  • If this PR introduces a new feature, it must be covered in an example/tutorial and a Wiki article.

Licence

  • The author added a BSD statement to doc/ (or already has one)

@sandro-elsweijer sandro-elsweijer added enhancement Enhances already existing code shouldn't take long Can be resolved in under 30 mins documentation labels May 9, 2023
doc/Doxyfile.in Outdated Show resolved Hide resolved
@Davknapp Davknapp merged commit 7e41882 into main May 10, 2023
3 checks passed
@Davknapp Davknapp deleted the fix-issue_426 branch May 10, 2023 11:57
jfussbro pushed a commit to jfussbro/t8code that referenced this pull request Jun 27, 2023
Add preprocessor macros for documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement Enhances already existing code shouldn't take long Can be resolved in under 30 mins
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Macros in documentation
2 participants