From b3fab1f2cd22bfaee95831af57a65f803f03083c Mon Sep 17 00:00:00 2001 From: Janne Grunau Date: Mon, 29 Oct 2012 16:26:59 +0100 Subject: [PATCH] doc: add apidoc target for doxygen API documentation Documentation includes only the externally visible API of the installed headers. Based on a patch by Anton Khirnov . Signed-off-by: Anton Khirnov --- doc/Makefile | 9 +++++++-- doc/doxy-wrapper.sh | 14 ++++++++++++++ library.mak | 2 ++ 3 files changed, 23 insertions(+), 2 deletions(-) create mode 100755 doc/doxy-wrapper.sh diff --git a/doc/Makefile b/doc/Makefile index 63530342b3..d22de79df5 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -14,6 +14,7 @@ DOCS = $(HTMLPAGES) $(MANPAGES) $(PODPAGES) all-$(CONFIG_DOC): documentation +apidoc: doc/doxy/html documentation: $(DOCS) TEXIDEP = awk '/^@include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d) @@ -39,7 +40,10 @@ doc/%.1: TAG = MAN doc/%.1: doc/%.pod $(GENTEXI) $(M)pod2man --section=1 --center=" " --release=" " $< > $@ -$(DOCS): | doc/ +$(DOCS) doc/doxy/html: | doc/ + +doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(INSTHEADERS) + $(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $^ install-progs-$(CONFIG_DOC): install-man @@ -54,7 +58,8 @@ uninstall-man: clean:: $(RM) doc/*.html doc/*.pod doc/*.1 $(CLEANSUFFIXES:%=doc/%) doc/avoptions_*.texi + $(RM) -r doc/doxy/html -include $(wildcard $(DOCS:%=%.d)) -.PHONY: documentation +.PHONY: apidoc documentation diff --git a/doc/doxy-wrapper.sh b/doc/doxy-wrapper.sh new file mode 100755 index 0000000000..6650e38850 --- /dev/null +++ b/doc/doxy-wrapper.sh @@ -0,0 +1,14 @@ +#!/bin/sh + +SRC_PATH="${1}" +DOXYFILE="${2}" + +shift 2 + +doxygen - <