diff options
| author | Janne Grunau <janne-libav@jannau.net> | 2012-10-29 16:26:59 +0100 |
|---|---|---|
| committer | Anton Khirnov <anton@khirnov.net> | 2012-11-02 18:28:56 +0100 |
| commit | b3fab1f2cd22bfaee95831af57a65f803f03083c (patch) | |
| tree | ab5be8965a9c01115abd20dcba3f59143ff75950 | |
| parent | 34871beb5eb6bc59f5e58326a214efd88a4c2ccd (diff) | |
| download | ffmpeg-b3fab1f2cd22bfaee95831af57a65f803f03083c.tar.gz | |
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 <anton@khirnov.net>.
Signed-off-by: Anton Khirnov <anton@khirnov.net>
| -rw-r--r-- | doc/Makefile | 9 | ||||
| -rwxr-xr-x | doc/doxy-wrapper.sh | 14 | ||||
| -rw-r--r-- | library.mak | 2 |
3 files changed, 23 insertions, 2 deletions
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 - <<EOF +@INCLUDE = ${DOXYFILE} +INPUT = $@ +HTML_HEADER = ${SRC_PATH}/doc/doxy/header.html +HTML_FOOTER = ${SRC_PATH}/doc/doxy/footer.html +HTML_STYLESHEET = ${SRC_PATH}/doc/doxy/doxy_stylesheet.css +EOF diff --git a/library.mak b/library.mak index cbfa0d48e1..33ec37f1cd 100644 --- a/library.mak +++ b/library.mak @@ -6,6 +6,8 @@ LIBVERSION := $(lib$(NAME)_VERSION) LIBMAJOR := $(lib$(NAME)_VERSION_MAJOR) INCINSTDIR := $(INCDIR)/lib$(NAME) +INSTHEADERS := $(INSTHEADERS) $(HEADERS:%=$(SUBDIR)%) + all-$(CONFIG_STATIC): $(SUBDIR)$(LIBNAME) all-$(CONFIG_SHARED): $(SUBDIR)$(SLIBNAME) |