1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
|
## generate API documentation with doxygen
apidox-am-yes:
@if test "$(subdir)" == "."; then \
$(mkinstalldirs) $(top_builddir)/apidocs/$(subdir) ;\
if test "$(DOXYGEN_LINK_WITH_KDE_QT_APIDOX)" == "YES"; then \
if test ! -x $(top_builddir)/apidocs/common; then \
if test -d $(top_srcdir)/doc/common; then \
common_dir=`cd $(top_srcdir)/doc/common && pwd` ;\
else \
common_dir=$(kde_libs_htmldir)/en/common ;\
fi ;\
$(LN_S) $$common_dir $(top_builddir)/apidocs/common; \
fi ;\
fi ;\
cp $(top_srcdir)/admin/Doxyfile.global Doxyfile; \
echo "PROJECT_NAME = $(DOXYGEN_PROJECT_NAME)" >> Doxyfile; \
echo "PROJECT_NUMBER = \"Version $(VERSION)\"" >> Doxyfile; \
echo "OUTPUT_DIRECTORY = $(PWD)/apidocs/en" >> Doxyfile; \
echo "BRIEF_MEMBER_DESC = NO" >> Doxyfile; \
echo "FULL_PATH_NAMES = YES" >> Doxyfile; \
echo "STRIP_FROM_PATH = $(top_srcdir)/" >> Doxyfile; \
echo "ALIASES += \"feature=\xrefitem features \\\"Feature(s)\\\" \\\"Features\\\"\" " >> Doxyfile; \
echo "ALIASES += \"maintainer=\xrefitem maintainers \\\"Maintainer(s)\\\" \\\"Maintainers\\\"\" " >> Doxyfile; \
echo "ALIASES += \"unmaintained=\xrefitem unmaintained \\\"Unmaintained\\\" \\\"Unmaintained\\\"\" " >> Doxyfile; \
echo "ALIASES += \"requirement=\xrefitem requirements \\\"Requirement(s)\\\" \\\"Requirements\\\"\" " >> Doxyfile; \
echo "ALIASES += \"faq=\xrefitem FAQ \\\"F.A.Q.\\\" \\\"F.A.Q.\\\"\" " >> Doxyfile; \
echo "ALIASES += \"authors=\xrefitem authors \\\"Author(s)\\\" \\\"Authors\\\"\" " >> Doxyfile; \
echo "ALIASES += \"FIXME=\xrefitem fixme \\\"Fixme\\\" \\\"Fixme\\\"\" " >> Doxyfile; \
echo "EXTRACT_ALL = NO" >> Doxyfile; \
echo "EXTRACT_PRIVATE = NO" >> Doxyfile; \
echo "EXTRACT_LOCAL_CLASSES = YES" >> Doxyfile; \
echo "HIDE_UNDOC_CLASSES = NO" >> Doxyfile; \
echo "HIDE_UNDOC_MEMBERS = NO" >> Doxyfile; \
echo "SORT_MEMBER_DOCS = YES" >> Doxyfile; \
echo "GENERATE_TODOLIST = YES" >> Doxyfile; \
if test -n "$(DOXYGEN_INPUT)"; then \
patterns= ;\
dirs= ;\
include_items='$(DOXYGEN_INPUT) '; for item in $$include_items; do \
if test -d "$(top_srcdir)/$$item"; then \
dirs="$$dirs $$item" ;\
else \
patterns="$$patterns $$item" ;\
fi ;\
done ;\
echo "INPUT += $$dirs" >> Doxyfile ;\
echo "FILE_PATTERNS += $$patterns" >> Doxyfile; \
fi ;\
if test -n "$(DOXYGEN_EXCLUDE)"; then \
patterns= ;\
dirs= ;\
exclude_items='$(DOXYGEN_EXCLUDE) '; for item in $$exclude_items; do \
if test -d "$(top_srcdir)/$$item"; then \
dirs="$$dirs $$item" ;\
else \
patterns="$$patterns $$item" ;\
fi ;\
done ;\
echo "EXCLUDE += $$dirs" >> Doxyfile ;\
echo "EXCLUDE_PATTERNS += $$patterns" >> Doxyfile; \
fi ;\
echo "EXAMPLE_PATH = $(DOXYGEN_EXAMPLE_PATH)" >> Doxyfile; \
echo "IMAGE_PATH = $(top_srcdir)/doc/api" >> Doxyfile ;\
echo "VERBATIM_HEADERS = NO" >> Doxyfile ;\
echo "IGNORE_PREFIX = K" >> Doxyfile ;\
echo "GENERATE_HTML = $(GENERATE_FLAG)" >> Doxyfile ;\
echo "HTML_OUTPUT = html" >> Doxyfile; \
if test "$(DOXYGEN_LINK_WITH_KDE_QT_APIDOX)" == "YES"; then \
if test "$(DOXYGEN_SEARCHENGINE)" == "YES"; then \
echo "HTML_HEADER = $(PWD)/apidocs/common/appheader.html" >> Doxyfile ;\
else \
echo "HTML_HEADER = $(PWD)/apidocs/common/header.html" >> Doxyfile ;\
fi ;\
echo "HTML_FOOTER = $(PWD)/apidocs/common/footer.html" >> Doxyfile ;\
echo "HTML_STYLESHEET = $(PWD)/apidocs/common/doxygen.css" >> Doxyfile ;\
else \
echo "HTML_HEADER = " >> Doxyfile ;\
echo "HTML_FOOTER = " >> Doxyfile ;\
echo "HTML_STYLESHEET = " >> Doxyfile ;\
echo "DISABLE_INDEX = NO" >> Doxyfile ;\
fi ;\
echo "GENERATE_LATEX = NO" >> Doxyfile ; \
echo "LATEX_OUTPUT = $(subdir)/latex" >> Doxyfile; \
echo "RTF_OUTPUT = $(subdir)/rtf" >> Doxyfile; \
echo "GENERATE_MAN = NO" >> Doxyfile ;\
echo "MAN_OUTPUT = $(subdir)/man" >> Doxyfile; \
echo "MACRO_EXPANSION = YES" >> Doxyfile ; \
echo "PREDEFINED = ANTLR_USE_NAMESPACE(_x_)=_x_::" >> Doxyfile ; \
if test "$(DOXYGEN_LINK_WITH_KDE_QT_APIDOX)" == "YES"; then \
echo "TAGFILES = \\" >> Doxyfile; \
tags='$(DOXYGEN_REFERENCES) qt'; for tag in $$tags; do \
tagpath= ;\
path="../../$$tag" ;\
if test -f $(top_builddir)/apidocs/$$tag/$$tag.tag; then \
tagpath="$(top_builddir)/apidocs/$$tag/$$tag.tag" ;\
else \
tagpath=`ls -1 $(kde_htmldir)/en/*-apidocs/$$tag/$$tag.tag 2> /dev/null` ;\
if test -n "$$tagpath"; then \
path=`echo $$tagpath | sed -e "s,.*/\([^/]*-apidocs\)/$$tag/$$tag.tag,../../\1/$$tag,"` ;\
else \
tagpath=`ls -1 $(kdelibs_doxydir)/$$tag/$$tag.tag 2> /dev/null` ;\
if test -n "$$tagpath"; then \
path=`echo $$tagpath | sed -e "s,.*/\([^/]*-apidocs\)/$$tag/$$tag.tag,$(kdelibs_doxydir)/$$tag,"` ;\
else \
tagpath=/home/apidox/public/cvs-api/$$tag/$$tag.tag ;\
fi ;\
fi ;\
fi ;\
if test "$$tag" = qt; then \
echo $$tagpath=$(QTDOCDIR) >> Doxyfile ;\
else if test -n "$$tagpath"; then \
echo "$$tagpath=$$path/html \\" >> Doxyfile ;\
fi ;\
fi ;\
done ;\
fi ;\
echo "HAVE_DOT = $(KDE_HAVE_DOT)" >> Doxyfile ; \
echo "SEARCHENGINE = $(DOXYGEN_SEARCHENGINE)" >> Doxyfile ; \
if test "$(DOXYGEN_LINK_WITH_KDE_QT_APIDOX)" == "YES"; then \
rm -f $(top_builddir)/apidocs/common ; \
if test -d $(top_srcdir)/doc/common; then \
common_dir=`cd $(top_srcdir)/doc/common && pwd` ;\
else \
common_dir=$(kde_libs_htmldir)/en/common ;\
fi ;\
$(LN_S) $$common_dir $(top_builddir)/apidocs/common ;\
fi ;\
$(DOXYGEN) -s -u Doxyfile ; \
cp Doxyfile Doxyfile.in ; \
path_to_doxyfile=$(PWD) ;\
cd $(top_srcdir) ;\
$(DOXYGEN) $$path_to_doxyfile/Doxyfile ; \
cd $$path_to_doxyfile ;\
rm -f Doxyfile; \
fi
apidox-am-no:
## Let's only install the API documentation if the user explicitly invokes it's instalation
##install-data-local: install-apidox
## install API documentation
install-apidox:
$(mkinstalldirs) $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/$(subdir)/html
@if test -f $(top_builddir)/apidocs/$(DOXYGEN_PROJECT_NAME).tag; then \
echo $(INSTALL_DATA) $(top_builddir)/apidocs/$(DOXYGEN_PROJECT_NAME).tag $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/$(subdir); \
$(INSTALL_DATA) $(top_builddir)/apidocs/$(DOXYGEN_PROJECT_NAME).tag $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/$(subdir); \
fi;
@if test -d $(top_builddir)/apidocs/$(subdir)/html; then \
list=`ls $(top_builddir)/apidocs/$(subdir)/html`; \
echo "installing $(top_builddir)/apidocs/$(subdir)/html" ;\
for file in $$list; do \
$(INSTALL_DATA) $(top_builddir)/apidocs/$(subdir)/html/$$file $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/$(subdir)/html; \
done; \
fi;
@if test "$(DOXYGEN_LINK_WITH_KDE_QT_APIDOX)" == "YES"; then \
rm -f $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/common; \
$(LN_S) $(kde_libs_htmldir)/en/common $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/common; \
fi;
@echo ""
@echo ""
@echo "************************* Important ***************************"
@echo ""
@echo "The $(PACKAGE) API documentation was successfuly installed at:"
@echo " $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/html"
@echo ""
uninstall-local: uninstall-apidox
## uninstall API documentation
uninstall-apidox:
@if test -d $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs; then \
echo "*** Uninstaling $(PACKAGE) API documentation" ; \
echo "rm -rfv $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs" ; \
rm -rfv $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs; \
fi
apidox:
$(MAKE) apidox-am-@KDE_HAS_DOXYGEN@
@set fnord $(MAKEFLAGS); amf=$$2; if test -n '$(SUBDIRS)'; then \
list='$(SUBDIRS)'; \
for subdir in $$list; do \
if grep '^include .*Doxyfile.am' $(srcdir)/$$subdir/Makefile.am; then \
echo "Making apidox in $$subdir"; \
if test "$$subdir" != "."; then \
(cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) GENERATE_FLAG=no apidox) || exit 1; \
fi ; fi ;\
done; \
for subdir in $$list; do \
if grep '^include .*Doxyfile.am' $(srcdir)/$$subdir/Makefile.am; then \
echo "Making apidox in $$subdir"; \
if test "$$subdir" != "."; then \
(cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) GENERATE_FLAG=yes apidox) || exit 1; \
fi ; fi ;\
done; \
if test "$(DOXYGEN_LINK_WITH_KDE_QT_APIDOX)" == "YES"; then \
echo ""; \
echo ""; \
echo "******************* Important *********************"; \
echo ""; \
echo "Before you can browse the API documentation you MUST issue:"; \
echo " make install-apidox (as root)"; \
echo ""; \
echo "The API documentation will then be installed at:"; \
echo " $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/html"; \
echo ""; \
fi ;\
fi
.PHONY: apidox-am-yes apidox-am-no install-data-local install-apidox install-apidox uninstall-local uninstall-apidox uninstall-apidox apidox
# Local Variables:
# mode: makefile
# End:
|