Skip to content

Commit d3c87f2

Browse files
committed
Check doxygen in the CI to avoid errors in projects using this
The ddnet CI has this so any ddnet based project with the default github actions setup will throw errors in caused by twbl so we should keep it clean here.
1 parent eb2b544 commit d3c87f2

3 files changed

Lines changed: 53 additions & 1 deletion

File tree

.github/workflows/style.yml

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,32 @@ jobs:
1818
run: |
1919
sudo apt-get update -y
2020
sudo apt-get install -y pkg-config cmake cmake build-essential shellcheck
21+
mkdir -p ~/.local/bin/
22+
23+
# clang-format
2124
wget https://github.com/muttleyxd/clang-tools-static-binaries/releases/download/master-796e77c/clang-format-20_linux-amd64
2225
echo "bbb30a777d075dfbe91aa146a1ea1fa0c1d4745efa9c5490ebf9f5a7a7dec679c22f1c6015d5c85cb5b5b22964d86ae65002f1d4145bfdd7f27022d981b58979 clang-format-20_linux-amd64" | sha512sum -c
23-
mkdir -p ~/.local/bin/
2426
mv clang-format-20_linux-amd64 ~/.local/bin/clang-format
2527
chmod +x ~/.local/bin/clang-format
28+
29+
# doxygen
30+
wget -O doxygen.tar.gz https://www.doxygen.nl/files/doxygen-1.16.1.linux.bin.tar.gz
31+
tar xf doxygen.tar.gz
32+
mv doxygen-1.16.1/bin/doxygen ~/.local/bin
33+
rm -f doxygen.tar.gz
34+
rm -rf doxygen-1.16.1
2635
- name: Check fix_style
2736
run: scripts/fix_style.py --dry-run
2837
# - name: Shellcheck
2938
# run: find . -type f -name '*.sh' -not -path './deps/*' -print0 | xargs -0 shellcheck
39+
40+
- name: Check documentation style (Doxygen)
41+
run: |
42+
doxygen --version
43+
doxygen -q
44+
if [ -s docs/warn.log ]; then
45+
echo "--------------------------------------------------"
46+
echo "Doxygen warnings:"
47+
cat docs/warn.log
48+
exit 1
49+
fi

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ log.txt
1010
*.exe
1111
*.dll
1212
*.pyc
13+
docs/html
14+
docs/warn.log
1315
build/
1416
build-tidy/
1517
build-*/

Doxyfile

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
PROJECT_NAME = "DDNet documentation"
2+
PROJECT_LOGO = other/icons/DDNet_48x48x32.png
3+
OUTPUT_DIRECTORY = docs
4+
BUILTIN_STL_SUPPORT = YES
5+
NUM_PROC_THREADS = 0
6+
EXTRACT_ALL = YES
7+
EXTRACT_PRIVATE = YES
8+
EXTRACT_PRIV_VIRTUAL = YES
9+
EXTRACT_STATIC = YES
10+
CASE_SENSE_NAMES = YES
11+
WARN_LOGFILE = docs/warn.log
12+
INPUT = src
13+
RECURSIVE = YES
14+
EXCLUDE = src/engine/external \
15+
src/masterping/target \
16+
src/mastersrv/target
17+
USE_MDFILE_AS_MAINPAGE = src/README.md
18+
GENERATE_LATEX = NO
19+
MACRO_EXPANSION = YES
20+
PREDEFINED = CONF_FAMILY_UNIX \
21+
CONF_MYSQL \
22+
CONF_DISCORD \
23+
CONF_OPENSSL \
24+
CONF_UPNP \
25+
CONF_VIDEORECORDER \
26+
CONF_ANTIBOT
27+
DOT_IMAGE_FORMAT = svg
28+
INTERACTIVE_SVG = YES
29+
DOT_GRAPH_MAX_NODES = 200
30+
DOT_MULTI_TARGETS = YES

0 commit comments

Comments
 (0)