mirror of
https://github.com/jerryscript-project/jerryscript.git
synced 2025-12-15 16:29:21 +00:00
ff9ff8f36c
Update Doxyfile to version 1.9.1
Re-enable doxygen CI checker
Fix some regular comments that should have been doc comments
Document void return types for some inline functions explicitly
Move start of some doxygen groups so they are included always, and not left
out of certain ifdefs
Ignore some doxygen warnings:
Member (function) is not documented in headers
Documented empty return type in headers
Argument has multiple @param documentation sections
JerryScript-DCO-1.0-Signed-off-by: Máté Tokodi mate.tokodi@szteszoftver.hu
30 lines
1.0 KiB
Bash
Executable File
30 lines
1.0 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
# Copyright JS Foundation and other contributors, http://js.foundation
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
doxygen 2>&1 >/dev/null \
|
|
| grep -Pv "^\/.+\.h:\d+: warning: Member .+ \(function\) of group \w+ is not documented.$" \
|
|
| grep -Pv "^\/.+\.h:\d+: warning: documented empty return type of \w+$" \
|
|
| grep -Pv "^\/.+\.h:\d+: warning: argument '.+' from the argument list of .+ has multiple @param documentation sections$" \
|
|
| head -n 1000 | tee doxygen.log
|
|
if [ -s doxygen.log ]
|
|
then
|
|
EXIT=1
|
|
else
|
|
EXIT=0
|
|
fi
|
|
rm -f doxygen.log
|
|
exit $EXIT
|