summaryrefslogtreecommitdiffstats
path: root/Makefile
diff options
context:
space:
mode:
authorHåkan Jonsson <hakan.jonsson@ericsson.com>2016-09-13 10:44:32 +0200
committerEd Warnicke <hagbard@gmail.com>2016-10-04 22:18:17 +0000
commit440cde6899d2113c07d192b3490b546d8a62a5b9 (patch)
tree510c9f1746e20815f0e16fcd3e947e71484e076b /Makefile
parent45fec8fd68f6b65784670fe079f1c0a8d332b405 (diff)
doc: Initial doxygen framework for NSH SFC project
A first attempt for a documentation generation using Doxygen for the NSH SFC project. Doxygen tagging and documentation in the code still need to be done. Based on a copy of the Doxygen framework in VPP. Top Makefile added to (only) build documentation. Change-Id: Ibd09d9f5338609a7f57a384ded86fca874f4efdc Signed-off-by: Håkan Jonsson <hakan.jonsson@ericsson.com> Signed-off-by: Ed Warnicke <eaw@cisco.com>
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile53
1 files changed, 53 insertions, 0 deletions
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..dd5faab
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,53 @@
+# Copyright (c) 2016 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+WS_ROOT=$(CURDIR)
+BR=$(WS_ROOT)/build-root
+
+#
+# OS Detection
+#
+OS_ID = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
+OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
+
+help:
+ @echo "Make Targets:"
+ @echo " doxygen - (re)generate documentation"
+ @echo " bootstrap-doxygen - setup Doxygen dependencies"
+ @echo " wipe-doxygen - wipe all generated documentation"
+ @echo ""
+
+
+
+#
+# Build the documentation
+#
+
+# Doxygen configuration and our utility scripts
+export DOXY_DIR ?= $(WS_ROOT)/doxygen
+
+define make-doxy
+ @OS_ID="$(OS_ID)" WS_ROOT="$(WS_ROOT)" BR="$(BR)" make -C $(DOXY_DIR) $@
+endef
+
+.PHONY: bootstrap-doxygen doxygen wipe-doxygen
+
+bootstrap-doxygen:
+ $(call make-doxy)
+
+doxygen:
+ $(call make-doxy)
+
+wipe-doxygen:
+ $(call make-doxy)
+