Skip to content

227 workflow add checks on cpp documentation #313

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.

Sign up for GitHub

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 9 commits into from
Oct 30, 2025
Merged

227 workflow add checks on cpp documentation #313

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2425684
added doxygen for linting C++ code.
geurto Oct 17, 2025
cedf726
added doxygen to workflow
geurto Oct 20, 2025
9061e45
updated documentation
geurto Oct 20, 2025
5ac73ef
typo
geurto Oct 20, 2025
fbbe101
added private methods to doxyfile; added documentation to private met…
geurto Oct 28, 2025
06729a8
added .clang-format file for consistent formatting; added additional …
geurto Oct 28, 2025
0697533
added REUSE lines to .clang-format
geurto Oct 28, 2025
224079c
changed clang-format style to Google; updated clang-format runner in …
geurto Oct 29, 2025
53dee68
Add support for newer clangd version.
Jelmerdw Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updated documentation 
Signed-off-by: Peter Geurts <[email protected]>
  • Loading branch information
@geurto @Jelmerdw
geurto authored and Jelmerdw committed Oct 30, 2025
commit 9061e45572b9b623c0ab56594c39366bc6b8b84b
3 changes: 3 additions & 0 deletions docs/content/workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ Checks all files in this repository on usage of copyright terms.
- **Ty**:\
Runs static type checks on our Python code using [Ty](https://github.com/astral-sh/ty).

- **doxygen**:\
Runs code documentation checks for .cpp, .hpp, and .h files, using the rules specified in *doxyfile.lint*. In the future, other filetypes may be added as well.

### Local Development

You can run these checks locally before committing by using the [`pre-commit`](https://pre-commit.com/) framework:
Expand Down
4 changes: 1 addition & 3 deletions doxyfile.lint
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ GENERATE_LATEX = NO
GENERATE_HTML = NO
GENERATE_RTF = YES

EXCLUDE_PATTERNS = */__pycache__/*
FILE_PATTERNS = *.cpp \
*.h \
*.hpp \
# *.py
*.hpp