oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: generate API documentation with doxygen

Browse Source 
When configured with --enable-documentation, use doxygen.
This commit is contained in:
Max Kellermann 2009-02-13 09:11:22 +01:00
parent df9245c2aa
commit ef64449cb6
4 changed files with 1436 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -36,3 +36,5 @@ tags
*~ *~
.stgit* .stgit*
doc/protocol.html doc/protocol.html
doc/protocol
doc/api

7
configure.ac
View File

@ -1077,6 +1077,13 @@ if test x$enable_documentation = xyes; then
fi fi
AC_SUBST(XMLTO) AC_SUBST(XMLTO)
AC_PATH_PROG(DOXYGEN, doxygen)
if test x$DOXYGEN = x; then
AC_MSG_ERROR([doxygen not found])
fi
AC_SUBST(DOXYGEN)
fi fi
AM_CONDITIONAL(ENABLE_DOCUMENTATION, test x$enable_documentation = xyes) AM_CONDITIONAL(ENABLE_DOCUMENTATION, test x$enable_documentation = xyes)

11
doc/Makefile.am
View File

@ -12,8 +12,17 @@ protocol_DATA = $(wildcard protocol/*.html)
$(DOCBOOK_HTML): %/index.html: %.xml $(DOCBOOK_HTML): %/index.html: %.xml
$(XMLTO) -o protocol --stringparam chunker.output.encoding=utf-8 html $< $(XMLTO) -o protocol --stringparam chunker.output.encoding=utf-8 html $<
all-local: $(DOCBOOK_HTML) api/html/index.html: doxygen.conf
$(DOXYGEN) $<
all-local: $(DOCBOOK_HTML) api/html/index.html
clean-local: clean-local:
rm -rf $(patsubst %.xml,%,$(DOCBOOK_FILES)) rm -rf $(patsubst %.xml,%,$(DOCBOOK_FILES))
rm -rf api
install-data-local: api/html/index.html
$(mkinstalldirs) $(docdir)/api/html
$(INSTALL_DATA) -c -m 644 api/html/*.html api/html/*.css api/html/*.png api/html/*.gif $(docdir)/api/html
endif endif

1417
doc/doxygen.conf Normal file
View File

File diff suppressed because it is too large Load Diff