From 3f26e055364ac36a70ae0d2241f62868f9bb3ce0 Mon Sep 17 00:00:00 2001 From: Simon Duquennoy Date: Sun, 29 Oct 2017 12:54:58 +0100 Subject: [PATCH 1/4] Doxygen: cleanup makefile --- doc/Makefile | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index c4af84ca1..1377e410c 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,16 +1,13 @@ +contiking := .. basedirs := os arch -manuals := $(shell find ./ -name "*.txt") -filetypes := -iwholename "*/doc/*.txt" empty := space := $(empty) $(empty) -pwd := $(shell cd ..; pwd) +pwd := $(shell cd $(contiking); pwd) # Doxyfile configuration variables export docdir := . -export docdirs -export docsrc export doclatex := NO -export docroot := ../ +export docroot := $(contiking) # Get appropriate root for doxygen path cutoff ifeq ($(HOST_OS),Windows) @@ -21,12 +18,12 @@ ifeq ($(HOST_OS),Windows) endif endif -docdirs = $(sort $(foreach dir,$(basedirs),${shell find ../${dir} -type d -not -path "*/.*" -not -path "*/obj_*"})) -docsrc = $(docdirs) $(foreach dir,$(docdirs),${shell find $(dir) -type f $(filetypes)}) $(manuals) +export docdirs = $(sort $(foreach dir,$(basedirs),${shell find $(contiking)/${dir} -type d})) +export docsrc = $(docdirs) $(foreach dir,$(docdirs) .,${shell find $(dir) -type f -name "*.txt"}) .PHONY: clean html -html: +html: clean @doxygen Doxyfile clean: From f40492ade9afff0eb63bfc05c0f948437bb1a43c Mon Sep 17 00:00:00 2001 From: Simon Duquennoy Date: Sun, 29 Oct 2017 12:56:39 +0100 Subject: [PATCH 2/4] Moving /doc to /tools/doxygen --- tests/00-doxygen/Makefile | 2 +- {doc => tools/doxygen}/Doxyfile | 0 {doc => tools/doxygen}/Makefile | 2 +- {doc => tools/doxygen}/doc-style.css | 0 {doc => tools/doxygen}/mainpage.txt | 0 {doc => tools/doxygen}/modules.txt | 0 {doc => tools/doxygen}/pt-doc.txt | 0 7 files changed, 2 insertions(+), 2 deletions(-) rename {doc => tools/doxygen}/Doxyfile (100%) rename {doc => tools/doxygen}/Makefile (98%) rename {doc => tools/doxygen}/doc-style.css (100%) rename {doc => tools/doxygen}/mainpage.txt (100%) rename {doc => tools/doxygen}/modules.txt (100%) rename {doc => tools/doxygen}/pt-doc.txt (100%) diff --git a/tests/00-doxygen/Makefile b/tests/00-doxygen/Makefile index b8d933aee..ba3600b79 100644 --- a/tests/00-doxygen/Makefile +++ b/tests/00-doxygen/Makefile @@ -25,7 +25,7 @@ # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF # SUCH DAMAGE. -DOCDIR=../../doc +DOCDIR=../../tools/doxygen all: summary diff --git a/doc/Doxyfile b/tools/doxygen/Doxyfile similarity index 100% rename from doc/Doxyfile rename to tools/doxygen/Doxyfile diff --git a/doc/Makefile b/tools/doxygen/Makefile similarity index 98% rename from doc/Makefile rename to tools/doxygen/Makefile index 1377e410c..e370fca6e 100644 --- a/doc/Makefile +++ b/tools/doxygen/Makefile @@ -1,4 +1,4 @@ -contiking := .. +contiking := ../.. basedirs := os arch empty := space := $(empty) $(empty) diff --git a/doc/doc-style.css b/tools/doxygen/doc-style.css similarity index 100% rename from doc/doc-style.css rename to tools/doxygen/doc-style.css diff --git a/doc/mainpage.txt b/tools/doxygen/mainpage.txt similarity index 100% rename from doc/mainpage.txt rename to tools/doxygen/mainpage.txt diff --git a/doc/modules.txt b/tools/doxygen/modules.txt similarity index 100% rename from doc/modules.txt rename to tools/doxygen/modules.txt diff --git a/doc/pt-doc.txt b/tools/doxygen/pt-doc.txt similarity index 100% rename from doc/pt-doc.txt rename to tools/doxygen/pt-doc.txt From 189ed6e79bdc787755739b14cd455cbd290c85c6 Mon Sep 17 00:00:00 2001 From: Simon Duquennoy Date: Sun, 29 Oct 2017 13:02:28 +0100 Subject: [PATCH 3/4] Update Doxygen mainpage --- tools/doxygen/mainpage.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tools/doxygen/mainpage.txt b/tools/doxygen/mainpage.txt index 3a62b4d61..49f8de249 100644 --- a/tools/doxygen/mainpage.txt +++ b/tools/doxygen/mainpage.txt @@ -1,9 +1,9 @@ /** -\mainpage The \os Operating System +\mainpage \os: The Next Generation Contiki -This is the code documentation for \os. More documentation, including -feature description, tutorials etc, can be found at -https://github.com/sics-iot/contiki/wiki. +This page provides API description. + +Full documentation can be found on the wiki: https://github.com/contiki-ng/contiki-ng/wiki */ From a33e5eddcb18b4bbb3425f7c53a99ab6f8eb8f35 Mon Sep 17 00:00:00 2001 From: Simon Duquennoy Date: Sun, 29 Oct 2017 13:35:53 +0100 Subject: [PATCH 4/4] Doxygen: fix path to hello-world example --- tools/doxygen/Doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/doxygen/Doxyfile b/tools/doxygen/Doxyfile index 236b3884b..8073a8239 100644 --- a/tools/doxygen/Doxyfile +++ b/tools/doxygen/Doxyfile @@ -827,7 +827,7 @@ EXCLUDE_SYMBOLS = # command). EXAMPLE_PATH = . \ - ../examples/hello-world + ../../examples/hello-world # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and