blob: b6a1d45949d9f7665e6c19826b1ec6ed79168446 [file] [log] [blame]
Manuel Pégourié-Gonnard1d552e72016-01-04 16:49:09 +01001#!/bin/sh
2
3# Make sure the doxygen documentation builds without warnings
Bence Szépkúti700ee442020-05-26 00:33:31 +02004#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnard1d552e72016-01-04 16:49:09 +01007
Jan Bruckner1aabe5c2023-02-06 12:54:53 +01008# Abort on errors (and uninitialised variables)
Manuel Pégourié-Gonnard1d552e72016-01-04 16:49:09 +01009set -eu
10
11if [ -d library -a -d include -a -d tests ]; then :; else
Gilles Peskinee820c0a2023-08-03 17:45:20 +020012 echo "Must be run from Mbed TLS root" >&2
Manuel Pégourié-Gonnard1d552e72016-01-04 16:49:09 +010013 exit 1
14fi
15
Manuel Pégourié-Gonnardd091ed12016-01-12 14:17:52 +000016if scripts/apidoc_full.sh > doc.out 2>doc.err; then :; else
Manuel Pégourié-Gonnard1d552e72016-01-04 16:49:09 +010017 cat doc.err
18 echo "FAIL" >&2
19 exit 1;
20fi
21
Manuel Pégourié-Gonnardde7ae7b2016-01-08 16:47:33 +010022cat doc.out doc.err | \
23 grep -v "warning: ignoring unsupported tag" \
24 > doc.filtered
25
Ville Skyttä66edfe42023-01-01 18:19:49 +020026if grep -E "(warning|error):" doc.filtered; then
Manuel Pégourié-Gonnard1d552e72016-01-04 16:49:09 +010027 echo "FAIL" >&2
28 exit 1;
29fi
30
31make apidoc_clean
Manuel Pégourié-Gonnardde7ae7b2016-01-08 16:47:33 +010032rm -f doc.out doc.err doc.filtered