Merge pull request #126 from simonduq/pr/move-doxygen
Updates and moves Doxygen
This commit is contained in:
commit
2eda4992c2
@ -1,9 +0,0 @@
|
|||||||
/**
|
|
||||||
|
|
||||||
\mainpage The \os Operating System
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
*/
|
|
@ -25,7 +25,7 @@
|
|||||||
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||||
# SUCH DAMAGE.
|
# SUCH DAMAGE.
|
||||||
|
|
||||||
DOCDIR=../../doc
|
DOCDIR=../../tools/doxygen
|
||||||
|
|
||||||
all: summary
|
all: summary
|
||||||
|
|
||||||
|
@ -827,7 +827,7 @@ EXCLUDE_SYMBOLS =
|
|||||||
# command).
|
# command).
|
||||||
|
|
||||||
EXAMPLE_PATH = . \
|
EXAMPLE_PATH = . \
|
||||||
../examples/hello-world
|
../../examples/hello-world
|
||||||
|
|
||||||
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
# 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
|
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
|
@ -1,16 +1,13 @@
|
|||||||
|
contiking := ../..
|
||||||
basedirs := os arch
|
basedirs := os arch
|
||||||
manuals := $(shell find ./ -name "*.txt")
|
|
||||||
filetypes := -iwholename "*/doc/*.txt"
|
|
||||||
empty :=
|
empty :=
|
||||||
space := $(empty) $(empty)
|
space := $(empty) $(empty)
|
||||||
pwd := $(shell cd ..; pwd)
|
pwd := $(shell cd $(contiking); pwd)
|
||||||
|
|
||||||
# Doxyfile configuration variables
|
# Doxyfile configuration variables
|
||||||
export docdir := .
|
export docdir := .
|
||||||
export docdirs
|
|
||||||
export docsrc
|
|
||||||
export doclatex := NO
|
export doclatex := NO
|
||||||
export docroot := ../
|
export docroot := $(contiking)
|
||||||
|
|
||||||
# Get appropriate root for doxygen path cutoff
|
# Get appropriate root for doxygen path cutoff
|
||||||
ifeq ($(HOST_OS),Windows)
|
ifeq ($(HOST_OS),Windows)
|
||||||
@ -21,12 +18,12 @@ ifeq ($(HOST_OS),Windows)
|
|||||||
endif
|
endif
|
||||||
endif
|
endif
|
||||||
|
|
||||||
docdirs = $(sort $(foreach dir,$(basedirs),${shell find ../${dir} -type d -not -path "*/.*" -not -path "*/obj_*"}))
|
export docdirs = $(sort $(foreach dir,$(basedirs),${shell find $(contiking)/${dir} -type d}))
|
||||||
docsrc = $(docdirs) $(foreach dir,$(docdirs),${shell find $(dir) -type f $(filetypes)}) $(manuals)
|
export docsrc = $(docdirs) $(foreach dir,$(docdirs) .,${shell find $(dir) -type f -name "*.txt"})
|
||||||
|
|
||||||
.PHONY: clean html
|
.PHONY: clean html
|
||||||
|
|
||||||
html:
|
html: clean
|
||||||
@doxygen Doxyfile
|
@doxygen Doxyfile
|
||||||
|
|
||||||
clean:
|
clean:
|
9
tools/doxygen/mainpage.txt
Normal file
9
tools/doxygen/mainpage.txt
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
/**
|
||||||
|
|
||||||
|
\mainpage \os: The Next Generation Contiki
|
||||||
|
|
||||||
|
This page provides API description.
|
||||||
|
|
||||||
|
Full documentation can be found on the wiki: https://github.com/contiki-ng/contiki-ng/wiki
|
||||||
|
|
||||||
|
*/
|
Loading…
Reference in New Issue
Block a user