From cd533815917043584546a6d1a4da6f163a56ad3e Mon Sep 17 00:00:00 2001 From: Jeremy Sowden Date: Wed, 3 Aug 2022 21:12:45 +0100 Subject: doc: move doxygen config file into doxygen directory Now that the `INPUT` directory is correct, we can update `OUTPUT_DIRECTORY` to `.` and we don't need to cd out of the doxygen directory to run doxygen. Signed-off-by: Jeremy Sowden Signed-off-by: Florian Westphal --- .gitignore | 1 - configure.ac | 15 ++++++++++++++- doxygen.cfg.in | 23 ----------------------- doxygen/.gitignore | 1 + doxygen/Makefile.am | 2 +- doxygen/doxygen.cfg.in | 23 +++++++++++++++++++++++ 6 files changed, 39 insertions(+), 26 deletions(-) delete mode 100644 doxygen.cfg.in create mode 100644 doxygen/doxygen.cfg.in diff --git a/.gitignore b/.gitignore index 0276c98..b6b8d60 100644 --- a/.gitignore +++ b/.gitignore @@ -15,7 +15,6 @@ Makefile.in /libtool /stamp-h1 -/doxygen.cfg /libmnl.pc /libmnl-*.tar.bz2 diff --git a/configure.ac b/configure.ac index 314481d..dcdd424 100644 --- a/configure.ac +++ b/configure.ac @@ -27,7 +27,20 @@ regular_CFLAGS="-Wall -Waggregate-return -Wmissing-declarations \ -Wformat=2 -pipe" AC_SUBST([regular_CPPFLAGS]) AC_SUBST([regular_CFLAGS]) -AC_CONFIG_FILES([Makefile src/Makefile include/Makefile include/libmnl/Makefile include/linux/Makefile include/linux/netfilter/Makefile examples/Makefile examples/genl/Makefile examples/kobject/Makefile examples/netfilter/Makefile examples/rtnl/Makefile libmnl.pc doxygen.cfg doxygen/Makefile]) +AC_CONFIG_FILES([Makefile + src/Makefile + include/Makefile + include/libmnl/Makefile + include/linux/Makefile + include/linux/netfilter/Makefile + examples/Makefile + examples/genl/Makefile + examples/kobject/Makefile + examples/netfilter/Makefile + examples/rtnl/Makefile + libmnl.pc + doxygen/doxygen.cfg + doxygen/Makefile]) AC_ARG_WITH([doxygen], [AS_HELP_STRING([--with-doxygen], [create doxygen documentation])], diff --git a/doxygen.cfg.in b/doxygen.cfg.in deleted file mode 100644 index d6db004..0000000 --- a/doxygen.cfg.in +++ /dev/null @@ -1,23 +0,0 @@ -# Difference with default Doxyfile 1.8.20 -PROJECT_NAME = @PACKAGE@ -PROJECT_NUMBER = @VERSION@ -OUTPUT_DIRECTORY = doxygen -ABBREVIATE_BRIEF = -FULL_PATH_NAMES = NO -TAB_SIZE = 8 -OPTIMIZE_OUTPUT_FOR_C = YES -INPUT = @top_srcdir@ -FILE_PATTERNS = */src/*.c -RECURSIVE = YES -EXCLUDE_SYMBOLS = EXPORT_SYMBOL mnl_nlmsg_batch mnl_socket -EXAMPLE_PATTERNS = -INPUT_FILTER = "sed 's/EXPORT_SYMBOL//g'" -SOURCE_BROWSER = YES -ALPHABETICAL_INDEX = NO -SEARCHENGINE = NO -GENERATE_LATEX = NO -LATEX_CMD_NAME = latex -GENERATE_MAN = YES -MAN_LINKS = YES -HAVE_DOT = @HAVE_DOT@ -DOT_TRANSPARENT = YES diff --git a/doxygen/.gitignore b/doxygen/.gitignore index a23345c..2196cf8 100644 --- a/doxygen/.gitignore +++ b/doxygen/.gitignore @@ -1,3 +1,4 @@ doxyfile.stamp +doxygen.cfg html/ man/ diff --git a/doxygen/Makefile.am b/doxygen/Makefile.am index 09124ea..e4fc0eb 100644 --- a/doxygen/Makefile.am +++ b/doxygen/Makefile.am @@ -4,7 +4,7 @@ doc_srcs = $(shell find $(top_srcdir)/src -name '*.c') doxyfile.stamp: $(doc_srcs) Makefile.am rm -rf html man - cd ..; doxygen doxygen.cfg >/dev/null + doxygen doxygen.cfg >/dev/null # We need to use bash for its associative array facility # (`bash -p` prevents import of functions from the environment). # The command has to be a single line so the functions work diff --git a/doxygen/doxygen.cfg.in b/doxygen/doxygen.cfg.in new file mode 100644 index 0000000..24089ac --- /dev/null +++ b/doxygen/doxygen.cfg.in @@ -0,0 +1,23 @@ +# Difference with default Doxyfile 1.8.20 +PROJECT_NAME = @PACKAGE@ +PROJECT_NUMBER = @VERSION@ +OUTPUT_DIRECTORY = . +ABBREVIATE_BRIEF = +FULL_PATH_NAMES = NO +TAB_SIZE = 8 +OPTIMIZE_OUTPUT_FOR_C = YES +INPUT = @top_srcdir@ +FILE_PATTERNS = */src/*.c +RECURSIVE = YES +EXCLUDE_SYMBOLS = EXPORT_SYMBOL mnl_nlmsg_batch mnl_socket +EXAMPLE_PATTERNS = +INPUT_FILTER = "sed 's/EXPORT_SYMBOL//g'" +SOURCE_BROWSER = YES +ALPHABETICAL_INDEX = NO +SEARCHENGINE = NO +GENERATE_LATEX = NO +LATEX_CMD_NAME = latex +GENERATE_MAN = YES +MAN_LINKS = YES +HAVE_DOT = @HAVE_DOT@ +DOT_TRANSPARENT = YES -- cgit v1.2.3