summaryrefslogtreecommitdiff
path: root/mk
diff options
context:
space:
mode:
authorThomas Monjalon <thomas.monjalon@6wind.com>2013-04-19 14:34:40 +0200
committerThomas Monjalon <thomas.monjalon@6wind.com>2014-01-15 18:08:43 +0100
commitbef14485176fe8ea86bb5e99e93470f3bae5d206 (patch)
tree231d814d7c1d2c2a77690da2d92f9f4dbec44fe3 /mk
parentaec52ba38dbf3bf6492385e856363803cfeef918 (diff)
downloaddpdk-bef14485176fe8ea86bb5e99e93470f3bae5d206.zip
dpdk-bef14485176fe8ea86bb5e99e93470f3bae5d206.tar.gz
dpdk-bef14485176fe8ea86bb5e99e93470f3bae5d206.tar.xz
doc: generate HTML for API with doxygen
- add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
Diffstat (limited to 'mk')
-rw-r--r--mk/rte.sdkdoc.mk27
-rw-r--r--mk/rte.sdkroot.mk7
2 files changed, 27 insertions, 7 deletions
diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index b24e591..c90b569 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -1,6 +1,7 @@
# BSD LICENSE
#
# Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
+# Copyright(c) 2013 6WIND S.A.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
@@ -35,8 +36,26 @@ $(error "Cannot use T= with doc target")
endif
endif
-.PHONY: doc
-doc:
+.PHONY: all
+all: htmlapi
-.PHONY: doc-clean
-doc-clean:
+.PHONY: clean
+clean: htmlapi-clean
+
+.PHONY: htmlapi
+htmlapi: htmlapi-clean
+ @echo 'doxygen for API...'
+ $(Q)mkdir -p $(RTE_OUTPUT)/doc/html
+ $(Q)(cat $(RTE_SDK)/doc/doxy-api.conf && \
+ echo OUTPUT_DIRECTORY = $(RTE_OUTPUT)/doc && \
+ echo HTML_OUTPUT = html/api && \
+ echo GENERATE_HTML = YES && \
+ echo GENERATE_LATEX = NO && \
+ echo GENERATE_MAN = NO )| \
+ doxygen -
+ $(Q)$(RTE_SDK)/doc/doxy-html-custom.sh $(RTE_OUTPUT)/doc/html/api/doxygen.css
+
+.PHONY: htmlapi-clean
+htmlapi-clean:
+ $(Q)rm -f $O/doc/html/api/*
+ $(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/html/api 2>&- || true
diff --git a/mk/rte.sdkroot.mk b/mk/rte.sdkroot.mk
index 74dda6d..40a5a6e 100644
--- a/mk/rte.sdkroot.mk
+++ b/mk/rte.sdkroot.mk
@@ -101,9 +101,10 @@ testall:
install uninstall:
$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkinstall.mk $@
-.PHONY: doc doc-clean
-doc doc-clean:
- $(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkdoc.mk $@
+.PHONY: doc
+doc: doc-all
+doc-%:
+ $(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkdoc.mk $*
.PHONY: depdirs depgraph
depdirs depgraph: