RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

doccheck: check without building

Browse Source
This commit is contained in:
Karl Fessel 2023-01-31 17:11:01 +01:00
parent bd9ce34288
commit 3de68c7651
3 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
dist/tools/doccheck/check.sh vendored
View File

@ -15,6 +15,10 @@ RIOTBASE="$(cd "${SCRIPTDIR}"/../../..; pwd)"
EXCLUDE_PATTERN_FILE="${SCRIPTDIR}/exclude_patterns"
GENERIC_EXCLUDE_PATTERN_FILE="${SCRIPTDIR}/generic_exclude_patterns"
if [[ -z ${DOCUMENTATION_FORMAT+x} ]]; then
export DOCUMENTATION_FORMAT=check
fi
. "${RIOTBASE}"/dist/tools/ci/github_annotate.sh
github_annotate_setup
@ -33,7 +37,6 @@ DOXY_OUTPUT=$(make -C "${RIOTBASE}" doc 2>&1 | grep -Evf "${EXCLUDE_PATTERN_FILE
DOXY_ERRCODE=$?
RESULT=0
if [ "${DOXY_ERRCODE}" -ne 0 ] ; then
echo "'make doc' exited with non-zero code (${DOXY_ERRCODE})"
echo "${DOXY_OUTPUT}"
@ -53,6 +56,8 @@ else
sed -e 's/^[ \t]*//' -e 's/[ \t]*$//')
github_annotate_error "${FILENAME}" "${LINENR}" "${DETAILS}"
done
# show errors not matching the pattern above
echo "${ERRORS}" | grep -v "^.\+:[0-9]\+: warning:"
else
echo -e "${CERROR}ERROR: Doxygen generates the following warnings:${CRESET}"
echo "${ERRORS}"

1
dist/tools/doccheck/exclude_patterns vendored
View File

@ -12743,3 +12743,4 @@ boards/xg23\-pk6068a/include/periph_conf\.h:[0-9]+: warning: Member TIMER_1_ISR
boards/xg23\-pk6068a/include/periph_conf\.h:[0-9]+: warning: Member TIMER_0_MAX_VALUE \(macro definition\) of file periph_conf\.h is not documented\.
boards/xg23\-pk6068a/include/periph_conf\.h:[0-9]+: warning: Member TIMER_1_MAX_VALUE \(macro definition\) of file periph_conf\.h is not documented\.
boards/xg23\-pk6068a/include/periph_conf\.h:[0-9]+: warning: Member UART_0_ISR_RX \(macro definition\) of file periph_conf\.h is not documented\.
warning: No output formats selected! Set at least one of the main GENERATE_\* options to YES\.

8
doc/doxygen/Makefile
View File

@ -9,14 +9,20 @@ export STRIP_FROM_INC_PATH_LIST=$(shell \
# It can also be installed in ubuntu with the `node-less` package
LESSC ?= $(shell command -v lessc 2>/dev/null)
DOCUMENTATION_FORMAT ?= html
.PHONY: doc
doc: html
doc: $(DOCUMENTATION_FORMAT)
# by marking html as phony we force make to re-run Doxygen even if the directory exists.
.PHONY: html
html: src/css/riot.css src/changelog.md
( cat riot.doxyfile ; echo "GENERATE_HTML = yes" ) | doxygen -
.PHONY: check
check: src/changelog.md
( cat riot.doxyfile) | doxygen -
.PHONY: man
man: src/changelog.md
( cat riot.doxyfile ; echo "GENERATE_MAN = yes" ) | doxygen -