mirrors/SFML
1
0
Fork 0
mirror of https://github.com/SFML/SFML.git synced 2024-11-25 04:41:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Treat Doxygen warnings as errors

Browse Source
This commit is contained in:
Chris Thrasher 2024-08-30 10:14:27 -06:00
parent 44339c3d67
commit 8ed98e337b
2 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
.github/workflows/ci.yml vendored
View File

@ -428,3 +428,23 @@ jobs:
- name: Test - name: Test
run: ctest --test-dir build --output-on-failure run: ctest --test-dir build --output-on-failure
docs:
name: Documentation
runs-on: ubuntu-22.04
steps:
- name: Install Linux Dependencies
run: sudo apt-get update && sudo apt-get install xorg-dev libxrandr-dev libxcursor-dev libxi-dev libudev-dev libflac-dev libvorbis-dev libgl1-mesa-dev libegl1-mesa-dev libdrm-dev libgbm-dev xvfb fluxbox && sudo apt-get remove -y libasound2
- name: Install Doxygen
run: sudo apt-get install doxygen graphviz
- name: Checkout
uses: actions/checkout@v4
- name: Configure
run: cmake -B build -DSFML_BUILD_DOC=ON
- name: Build Doxygen Site
run: cmake --build build --target doc

2
doc/doxyfile.in
View File

@ -924,7 +924,7 @@ WARN_IF_UNDOC_ENUM_VAL = NO
# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. # Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
# The default value is: NO. # The default value is: NO.
WARN_AS_ERROR = NO WARN_AS_ERROR = YES
# The WARN_FORMAT tag determines the format of the warning messages that doxygen # The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which # can produce. The string should contain the $file, $line, and $text tags, which