numam-dpdk/doc/api/generate_doxygen.sh

#! /bin/sh -e
# SPDX-License-Identifier: BSD-3-Clause
# Copyright 2018 Luca Boccassi <bluca@debian.org>

DOXYCONF=$1
OUTDIR=$2
SCRIPTCSS=$3

OUT_FILE=$(dirname $OUTDIR)/doxygen.out

# run doxygen, capturing all the header files it processed
doxygen "${DOXYCONF}" > $OUT_FILE
echo "$OUTDIR: $(awk '/Preprocessing/ {printf("%s ", substr($2, 1, length($2) - 3))}' $OUT_FILE)" > $OUTDIR.d

"${SCRIPTCSS}" "${OUTDIR}"/doxygen.css
build: generate API documentation with meson Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com> 2018-09-11 20:42:36 +00:00			`#! /bin/sh -e`
			`# SPDX-License-Identifier: BSD-3-Clause`
			`# Copyright 2018 Luca Boccassi <bluca@debian.org>`

			`DOXYCONF=$1`
			`OUTDIR=$2`
			`SCRIPTCSS=$3`

doc: put doxygen log file in build directory The meson documentation states that projects should not rely upon the custom_target build commands are run from any given directory. Therefore, rather than writing the standout output from doxygen to the current directory - which could be anywhere in future, put it into the api directory, so that it is in a known location. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> 2020-09-29 16:54:59 +00:00			`OUT_FILE=$(dirname $OUTDIR)/doxygen.out`

doc: add dependency on header files for API doxygen Generate a dependency file for the header files used in the API guide so that the docs can be rebuilt if a header changes. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Luca Boccassi <bluca@debian.org> 2020-01-17 11:22:36 +00:00			`# run doxygen, capturing all the header files it processed`
doc: put doxygen log file in build directory The meson documentation states that projects should not rely upon the custom_target build commands are run from any given directory. Therefore, rather than writing the standout output from doxygen to the current directory - which could be anywhere in future, put it into the api directory, so that it is in a known location. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> 2020-09-29 16:54:59 +00:00			`doxygen "${DOXYCONF}" > $OUT_FILE`
			`echo "$OUTDIR: $(awk '/Preprocessing/ {printf("%s ", substr($2, 1, length($2) - 3))}' $OUT_FILE)" > $OUTDIR.d`
doc: add dependency on header files for API doxygen Generate a dependency file for the header files used in the API guide so that the docs can be rebuilt if a header changes. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Luca Boccassi <bluca@debian.org> 2020-01-17 11:22:36 +00:00
build: generate API documentation with meson Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com> 2018-09-11 20:42:36 +00:00			`"${SCRIPTCSS}" "${OUTDIR}"/doxygen.css`