Skip to content

Commit 04b8b40

Browse files
committed
[CI] testing doxygen
1 parent ddccb15 commit 04b8b40

File tree

2 files changed

+10
-15
lines changed

2 files changed

+10
-15
lines changed

.github/workflows/doc-check.yml

+10-2
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,8 @@ jobs:
104104
libboost-graph-dev \
105105
postgresql-${PGVER} \
106106
postgresql-server-dev-${PGVER} \
107-
graphviz
107+
graphviz \
108+
doxygen
108109
python -m pip install --upgrade pip
109110
pip install -r requirements.txt
110111
pip list
@@ -117,7 +118,7 @@ jobs:
117118
mkdir build
118119
cd build
119120
cmake -DLINKCHECK=ON -DWITH_DOC=ON \
120-
-DES=ON \
121+
-DES=ON -DBUILD_DOXY=ON \
121122
-DPOSTGRESQL_VERSION=${PGVER} -DCMAKE_BUILD_TYPE=Release ..
122123
123124
- name: Check Documentation
@@ -126,6 +127,13 @@ jobs:
126127
cd build
127128
make html-${{ matrix.language }}
128129
130+
- name: Check Developers Documentation
131+
if: env.PROCESS == 'true'
132+
run: |
133+
cd build
134+
make doxy
135+
[ ! -s build/doxygen/LOG ] || exit 1
136+
129137
- name: Check Links
130138
if: env.CHK_LINK == 'true'
131139
run: |

doxygen/Doxyfile.in

-13
Original file line numberDiff line numberDiff line change
@@ -230,12 +230,6 @@ TAB_SIZE = 4
230230

231231
ALIASES =
232232

233-
# This tag can be used to specify a number of word-keyword mappings (TCL only).
234-
# A mapping has the form "name=value". For example adding "class=itcl::class"
235-
# will allow you to use the command class in the itcl::class meaning.
236-
237-
TCL_SUBST =
238-
239233
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240234
# only. Doxygen will then generate output that is more tailored for C. For
241235
# instance, some of the names that are used will be different. The list of all
@@ -992,13 +986,6 @@ VERBATIM_HEADERS = YES
992986

993987
ALPHABETICAL_INDEX = YES
994988

995-
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
996-
# which the alphabetical index list will be split.
997-
# Minimum value: 1, maximum value: 20, default value: 5.
998-
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
999-
1000-
COLS_IN_ALPHA_INDEX = 5
1001-
1002989
# In case all classes in a project start with a common prefix, all classes will
1003990
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1004991
# can be used to specify a prefix (or a list of prefixes) that should be ignored

0 commit comments

Comments
 (0)