xref: /aosp_15_r20/external/mbedtls/scripts/apidoc_full.sh (revision 62c56f9862f102b96d72393aff6076c951fb8148)
1*62c56f98SSadaf Ebrahimi#!/bin/sh
2*62c56f98SSadaf Ebrahimi
3*62c56f98SSadaf Ebrahimi# Generate doxygen documentation with a full mbedtls_config.h (this ensures that every
4*62c56f98SSadaf Ebrahimi# available flag is documented, and avoids warnings about documentation
5*62c56f98SSadaf Ebrahimi# without a corresponding #define).
6*62c56f98SSadaf Ebrahimi#
7*62c56f98SSadaf Ebrahimi# /!\ This must not be a Makefile target, as it would create a race condition
8*62c56f98SSadaf Ebrahimi# when multiple targets are invoked in the same parallel build.
9*62c56f98SSadaf Ebrahimi#
10*62c56f98SSadaf Ebrahimi# Copyright The Mbed TLS Contributors
11*62c56f98SSadaf Ebrahimi# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
12*62c56f98SSadaf Ebrahimi
13*62c56f98SSadaf Ebrahimiset -eu
14*62c56f98SSadaf Ebrahimi
15*62c56f98SSadaf EbrahimiCONFIG_H='include/mbedtls/mbedtls_config.h'
16*62c56f98SSadaf Ebrahimi
17*62c56f98SSadaf Ebrahimiif [ -r $CONFIG_H ]; then :; else
18*62c56f98SSadaf Ebrahimi    echo "$CONFIG_H not found" >&2
19*62c56f98SSadaf Ebrahimi    exit 1
20*62c56f98SSadaf Ebrahimifi
21*62c56f98SSadaf Ebrahimi
22*62c56f98SSadaf EbrahimiCONFIG_BAK=${CONFIG_H}.bak
23*62c56f98SSadaf Ebrahimicp -p $CONFIG_H $CONFIG_BAK
24*62c56f98SSadaf Ebrahimi
25*62c56f98SSadaf Ebrahimiscripts/config.py realfull
26*62c56f98SSadaf Ebrahimimake apidoc
27*62c56f98SSadaf Ebrahimi
28*62c56f98SSadaf Ebrahimimv $CONFIG_BAK $CONFIG_H
29