diff --git a/.gitignore b/.gitignore index 7be8236..396e1d4 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,11 @@ _output/ /plugins/ +/3rdparty/opencv/ +/pkginfo.sh +/*.nsi +/*.exe + # ros /wrappers/ros/build diff --git a/CMakeLists.txt b/CMakeLists.txt index 4b25354..2056b4b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -14,10 +14,14 @@ cmake_minimum_required(VERSION 3.0) -project(mynteye VERSION 2.0.0 LANGUAGES C CXX) +project(mynteye VERSION 2.2.2 LANGUAGES C CXX) include(cmake/Common.cmake) +if(NOT CMAKE_DEBUG_POSTFIX) + set(CMAKE_DEBUG_POSTFIX d) +endif() + # options include(cmake/Option.cmake) @@ -55,23 +59,6 @@ macro(target_link_threads NAME) endif() endmacro() -if(WITH_API) - include(cmake/DetectOpenCV.cmake) -endif() - -find_package(Boost COMPONENTS filesystem) -if(Boost_FOUND) - set(WITH_BOOST_FILESYSTEM true) - add_definitions(-DWITH_FILESYSTEM) - add_definitions(-DWITH_BOOST_FILESYSTEM) - message(STATUS "With boost filesystem: ${Boost_VERSION}") - #message(STATUS " Boost_LIBRARIES: ${Boost_LIBRARIES}") -elseif(OS_WIN) - add_definitions(-DWITH_FILESYSTEM) - add_definitions(-DWITH_NATIVE_FILESYSTEM) - message(STATUS "With native filesystem") -endif() - LIST(APPEND CMAKE_MODULE_PATH cmake) include(CMakePackageConfigHelpers) @@ -96,6 +83,17 @@ configure_file( include/mynteye/mynteye.h @ONLY ) +configure_file( + cmake/templates/pkginfo.sh.in + ${CMAKE_CURRENT_SOURCE_DIR}/pkginfo.sh @ONLY +) +if(OS_WIN) + configure_file( + scripts/win/nsis/winpack.nsi.in + ${CMAKE_CURRENT_SOURCE_DIR}/winpack.nsi @ONLY + ) +endif() + # targets add_definitions(-DMYNTEYE_EXPORTS) @@ -107,11 +105,6 @@ set_outdir( "${OUT_DIR}/bin" ) -set(MYNTEYE_CMAKE_INCLUDE_DIR "${CMAKE_INSTALL_PREFIX}/include") -set(MYNTEYE_CMAKE_BINDIR "${CMAKE_INSTALL_PREFIX}/bin") -set(MYNTEYE_CMAKE_LIBDIR "${CMAKE_INSTALL_PREFIX}/lib") -set(MYNTEYE_CMAKE_INSTALLDIR "${MYNTEYE_CMAKE_LIBDIR}/cmake/${MYNTEYE_NAME}") - ## main if(WITH_GLOG) add_executable(main src/main.cc) @@ -124,11 +117,16 @@ endif() ## libmynteye +<<<<<<< HEAD if(NOT WITH_GLOG) +======= +if(NOT WITH_GLOG AND NOT OS_WIN) +>>>>>>> origin/develop set(__MINIGLOG_FLAGS "-Wno-unused-parameter -Wno-format -Wno-return-type") set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${__MINIGLOG_FLAGS}") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${__MINIGLOG_FLAGS}") unset(__MINIGLOG_FLAGS) +<<<<<<< HEAD endif() set(MYNTEYE_PUBLIC_H @@ -150,6 +148,8 @@ if(WITH_API) ${CMAKE_CURRENT_SOURCE_DIR}/src/api/plugin.h ${CMAKE_CURRENT_SOURCE_DIR}/src/api/processor/object.h ) +======= +>>>>>>> origin/develop endif() if(NOT WITH_GLOG) list(APPEND MYNTEYE_PUBLIC_H @@ -158,50 +158,54 @@ if(NOT WITH_GLOG) endif() if(OS_WIN) - set(UVC_SRC src/uvc/uvc-wmf.cc) + set(UVC_SRC src/mynteye/uvc/win/uvc-wmf.cc) elseif(OS_MAC) - set(UVC_SRC src/uvc/uvc-libuvc.cc) + set(UVC_SRC src/mynteye/uvc/macosx/uvc-libuvc.cc) find_package(libuvc REQUIRED) set(UVC_LIB ${libuvc_LIBRARIES}) include_directories(${libuvc_INCLUDE_DIRS}) elseif(OS_LINUX) - set(UVC_SRC src/uvc/uvc-v4l2.cc) + set(UVC_SRC src/mynteye/uvc/linux/uvc-v4l2.cc) else() message(FATAL_ERROR "Unsupported OS.") endif() set(MYNTEYE_SRCS ${UVC_SRC} - src/internal/channels.cc - src/internal/config.cc - src/internal/dl.cc - src/internal/files.cc - src/internal/motions.cc - src/internal/streams.cc - src/internal/strings.cc - src/internal/types.cc - src/public/types.cc - src/public/utils.cc - src/device/context.cc - src/device/device.cc - src/device/device_s.cc + src/mynteye/types.cc + src/mynteye/util/files.cc + src/mynteye/util/strings.cc + src/mynteye/device/channels.cc + src/mynteye/device/config.cc + src/mynteye/device/context.cc + src/mynteye/device/device.cc + src/mynteye/device/device_s.cc + src/mynteye/device/motions.cc + src/mynteye/device/streams.cc + src/mynteye/device/types.cc + src/mynteye/device/utils.cc ) if(WITH_API) list(APPEND MYNTEYE_SRCS - src/api/api.cc - src/api/synthetic.cc - src/api/processor/processor.cc - src/api/processor/rectify_processor.cc - src/api/processor/disparity_processor.cc - src/api/processor/disparity_normalized_processor.cc - src/api/processor/depth_processor.cc - src/api/processor/points_processor.cc + src/mynteye/api/api.cc + src/mynteye/api/dl.cc + src/mynteye/api/processor.cc + src/mynteye/api/synthetic.cc + src/mynteye/api/processor/rectify_processor.cc + src/mynteye/api/processor/disparity_processor.cc + src/mynteye/api/processor/disparity_normalized_processor.cc + src/mynteye/api/processor/depth_processor.cc + src/mynteye/api/processor/points_processor.cc ) endif() if(NOT WITH_GLOG) +<<<<<<< HEAD list(APPEND MYNTEYE_SRCS src/public/miniglog.cc) +======= + list(APPEND MYNTEYE_SRCS src/mynteye/miniglog.cc) +>>>>>>> origin/develop endif() set(MYNTEYE_LINKLIBS ${UVC_LIB}) @@ -218,7 +222,11 @@ endif() add_library(${MYNTEYE_NAME} SHARED ${MYNTEYE_SRCS}) target_link_libraries(${MYNTEYE_NAME} ${MYNTEYE_LINKLIBS}) +<<<<<<< HEAD option(WITH_GLOG "Include glog support" OFF) +======= +target_link_threads(${MYNTEYE_NAME}) +>>>>>>> origin/develop if(OS_WIN) target_compile_definitions(${MYNTEYE_NAME} @@ -230,27 +238,78 @@ target_include_directories(${MYNTEYE_NAME} PUBLIC "$" "$" "$" - "$" + "$" ) set_target_properties(${MYNTEYE_NAME} PROPERTIES VERSION ${PROJECT_VERSION} SOVERSION ${PROJECT_VERSION_MAJOR} ) -set_target_properties(${MYNTEYE_NAME} PROPERTIES - PUBLIC_HEADER "${MYNTEYE_PUBLIC_H}" -) # install -#message(STATUS "MYNTEYE_CMAKE_INCLUDE_DIR: ${MYNTEYE_CMAKE_INCLUDE_DIR}") -#message(STATUS "MYNTEYE_CMAKE_BINDIR: ${MYNTEYE_CMAKE_BINDIR}") -#message(STATUS "MYNTEYE_CMAKE_LIBDIR: ${MYNTEYE_CMAKE_LIBDIR}") -#message(STATUS "MYNTEYE_CMAKE_INSTALLDIR: ${MYNTEYE_CMAKE_INSTALLDIR}") +set(MYNTEYE_CMAKE_INCLUDE_DIR "${CMAKE_INSTALL_PREFIX}/include/${MYNTEYE_NAME}") +set(MYNTEYE_CMAKE_BINDIR "${CMAKE_INSTALL_PREFIX}/bin") +set(MYNTEYE_CMAKE_LIBDIR "${CMAKE_INSTALL_PREFIX}/lib") +set(MYNTEYE_CMAKE_INSTALLDIR "${MYNTEYE_CMAKE_LIBDIR}/cmake/${MYNTEYE_NAME}") + +install(FILES + ${CMAKE_CURRENT_BINARY_DIR}/include/mynteye/mynteye.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/global.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/logger.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/types.h + DESTINATION ${MYNTEYE_CMAKE_INCLUDE_DIR} +) +install(FILES + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/device/callbacks.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/device/context.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/device/device.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/device/utils.h + DESTINATION ${MYNTEYE_CMAKE_INCLUDE_DIR}/device +) +install(FILES + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/util/files.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/util/strings.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/util/times.h + DESTINATION ${MYNTEYE_CMAKE_INCLUDE_DIR}/util +) +if(WITH_API) + install(FILES + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/api/api.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/api/plugin.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/api/object.h + DESTINATION ${MYNTEYE_CMAKE_INCLUDE_DIR}/api + ) +endif() +if(NOT WITH_GLOG) + install(FILES + ${CMAKE_CURRENT_SOURCE_DIR}/include/mynteye/miniglog.h + DESTINATION ${MYNTEYE_CMAKE_INCLUDE_DIR} + ) +endif() + +install(FILES + ${CMAKE_CURRENT_SOURCE_DIR}/include/deprecated/mynteye/callbacks.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/deprecated/mynteye/context.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/deprecated/mynteye/device.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/deprecated/mynteye/files.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/deprecated/mynteye/glog_init.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/deprecated/mynteye/strings.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/deprecated/mynteye/times.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/deprecated/mynteye/utils.h + DESTINATION ${MYNTEYE_CMAKE_INCLUDE_DIR} +) +if(WITH_API) + install(FILES + ${CMAKE_CURRENT_SOURCE_DIR}/include/deprecated/mynteye/api.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/deprecated/mynteye/plugin.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/deprecated/mynteye/object.h + DESTINATION ${MYNTEYE_CMAKE_INCLUDE_DIR} + ) +endif() install(TARGETS ${MYNTEYE_NAME} EXPORT ${MYNTEYE_NAME}-targets - PUBLIC_HEADER DESTINATION ${MYNTEYE_CMAKE_INCLUDE_DIR}/${MYNTEYE_NAME} RUNTIME DESTINATION ${MYNTEYE_CMAKE_BINDIR} LIBRARY DESTINATION ${MYNTEYE_CMAKE_LIBDIR} ARCHIVE DESTINATION ${MYNTEYE_CMAKE_LIBDIR} @@ -278,32 +337,7 @@ install(EXPORT ${MYNTEYE_NAME}-targets ## build.info -macro(set_default_value VARIABLE DEFAULT) - if(NOT ${VARIABLE}) - set(${VARIABLE} ${DEFAULT}) - endif() -endmacro() - -macro(set_version_values VARIABLE) - string(REPLACE "." ";" __version_list "${${VARIABLE}}") - list(LENGTH __version_list __len) - if(${__len} GREATER 0) - list(GET __version_list 0 ${VARIABLE}_MAJOR) - endif() - if(${__len} GREATER 1) - list(GET __version_list 1 ${VARIABLE}_MINOR) - endif() - if(${__len} GREATER 2) - list(GET __version_list 2 ${VARIABLE}_PATCH) - endif() - if(${__len} GREATER 3) - list(GET __version_list 3 ${VARIABLE}_TWEAK) - endif() -endmacro() - -find_package(CUDA QUIET) - -set_version_values(CMAKE_CXX_COMPILER_VERSION) +# set default int values for yaml file (build.info) set_default_value(CMAKE_CXX_COMPILER_VERSION_MAJOR 0) set_default_value(CMAKE_CXX_COMPILER_VERSION_MINOR 0) set_default_value(CMAKE_CXX_COMPILER_VERSION_PATCH 0) diff --git a/CommonDefs.mk b/CommonDefs.mk index 378b7ff..1df3a94 100644 --- a/CommonDefs.mk +++ b/CommonDefs.mk @@ -26,6 +26,16 @@ SINGLE_QUOTE := ' OPEN_PAREN := ( CLOSE_PAREN := ) +# Options +# +# VS_CODE: ignore to auto detect, otherwise specify the version +# 15|2017, 14|2015, 12|2013, 11|2012, 10|2010, 9|2008, 8|2005 +# BUILD_TYPE: Debug|Release +# +# e.g. make [TARGET] VS_CODE=2017 BUILD_TYPE=Debug + +BUILD_TYPE ?= Release + # Host detection ifeq ($(OS),Windows_NT) @@ -124,7 +134,7 @@ ifeq ($(HOST_OS),Win) CC := cl CXX := cl MAKE := make - BUILD := msbuild.exe ALL_BUILD.vcxproj /property:Configuration=Release + BUILD := msbuild.exe ALL_BUILD.vcxproj /property:Configuration=$(BUILD_TYPE) endif else # mac & linux @@ -144,8 +154,7 @@ endif # CMake CMAKE := cmake -# CMAKE := $(CMAKE) -DCMAKE_BUILD_TYPE=Debug -CMAKE := $(CMAKE) -DCMAKE_BUILD_TYPE=Release +CMAKE := $(CMAKE) -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) ifneq ($(CC),) CMAKE := $(CMAKE) -DCMAKE_C_COMPILER=$(CC) endif @@ -202,6 +211,15 @@ endif endif +# Package + +PKGVERSION := $(shell ./scripts/version.sh) +PKGNAME := mynteye-s-$(PKGVERSION)-$(HOST_OS)-$(HOST_ARCH) +ifeq ($(HOST_OS),Linux) + PKGNAME := $(PKGNAME)-gcc$(shell gcc -dumpversion | cut -c 1-1) +endif +PKGNAME := $(call lower,$(PKGNAME)) + # Shell # `sh` is not possible to export a function diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000..619ee8e --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,103 @@ +pipeline { + agent { + // docker { image 'ros:kinetic-ros-base-xenial' } + docker { image 'joinaero/kinetic-ros-opencv-xenial' } + } + + /* + environment { + // FindOpenCV.cmake + OpenCV_DIR = '/opt/ros/kinetic/share/OpenCV-3.3.1-dev' + } + */ + + stages { + stage('Prepare') { + steps { + echo "WORKSPACE: ${env.WORKSPACE}" + echo 'apt-get ..' + sh 'apt-get update' + } + } + stage('Init') { + steps { + echo 'make init ..' + sh 'make init INIT_OPTIONS=-y' + // echo 'skip get submodules and make test' + // sh './scripts/init.sh -y' + } + } + stage('Build') { + steps { + echo 'make build ..' + sh '. /opt/ros/kinetic/setup.sh; make build' + } + } + stage('Install') { + steps { + echo 'make install ..' + sh '. /opt/ros/kinetic/setup.sh; make install SUDO=' + } + } + stage('Test') { + steps { + echo 'make test ..' + sh '. /opt/ros/kinetic/setup.sh; make test SUDO=' + } + } + stage('Samples') { + steps { + echo 'make samples ..' + sh '. /opt/ros/kinetic/setup.sh; make samples SUDO=' + } + } + stage('Tools') { + steps { + echo 'make tools ..' + sh '. /opt/ros/kinetic/setup.sh; make tools SUDO=' + } + } + stage('ROS') { + steps { + echo 'make ros ..' + sh ''' + . /opt/ros/kinetic/setup.sh + rosdep install --from-paths wrappers/ros/src --ignore-src --rosdistro kinetic -y + make ros SUDO= + ''' + } + } + /* + stage('Clean') { + steps { + echo 'clean ..' + sh ''' + rm -rf /var/lib/apt/lists/* + ''' + } + } + */ + } + + post { + always { + echo 'This will always run' + } + success { + echo 'This will run only if successful' + } + failure { + echo 'This will run only if failed' + mail to: 'mynteye-ci@slightech.com', + subject: "Failed Pipeline: ${currentBuild.fullDisplayName}", + body: "Something is wrong with ${env.BUILD_URL}" + } + unstable { + echo 'This will run only if the run was marked as unstable' + } + changed { + echo 'This will run only if the state of the Pipeline has changed' + echo 'For example, if the Pipeline was previously failing but is now successful' + } + } +} diff --git a/Makefile b/Makefile index 6e613f2..640dd2d 100644 --- a/Makefile +++ b/Makefile @@ -16,6 +16,14 @@ include CommonDefs.mk MKFILE_PATH := $(abspath $(lastword $(MAKEFILE_LIST))) MKFILE_DIR := $(patsubst %/,%,$(dir $(MKFILE_PATH))) +# CMAKE_INSTALL_PREFIX: +# https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html +# +# UNIX: /usr/local +# Windows: c:/Program Files/${PROJECT_NAME} + +SUDO ?= sudo + .DEFAULT_GOAL := all help: @@ -29,6 +37,7 @@ help: @echo " make test build test and run" @echo " make samples build samples" @echo " make tools build tools" + @echo " make pkg package sdk" @echo " make ros build ros wrapper" @echo " make py build python wrapper" @echo " make clean|cleanall clean generated or useless things" @@ -43,7 +52,8 @@ all: init samples tools ros apidoc: @$(call echo,Make $@) - @[ -e ./_install/include ] || $(MAKE) install + @# @[ -e ./_install/include ] || $(MAKE) install + @[ -e /usr/local/include/mynteye ] || $(MAKE) install @$(SH) ./doc/build.sh opendoc: apidoc @@ -54,19 +64,26 @@ opendoc: apidoc [ -f "$$html" ] && $(SH) ./scripts/open.sh $$html; \ done -.PHONY: apidoc opendoc +cleandoc: + @$(call rm,./doc/_output/) + +.PHONY: apidoc opendoc cleandoc # deps submodules: @git submodule update --init +<<<<<<< HEAD +======= + +>>>>>>> origin/develop .PHONY: submodules # init init: @$(call echo,Make $@) - @$(SH) ./scripts/init.sh + @$(SH) ./scripts/init.sh $(INIT_OPTIONS) .PHONY: init @@ -74,7 +91,11 @@ init: build: @$(call echo,Make $@) +ifeq ($(HOST_OS),Win) @$(call cmake_build,./_build,..,-DCMAKE_INSTALL_PREFIX=$(MKFILE_DIR)/_install) +else + @$(call cmake_build,./_build,..) +endif .PHONY: build @@ -108,12 +129,27 @@ ifneq ($(HOST_NAME),MinGW) else @cd ./_build; make install endif +else +ifeq ($(HOST_OS),Linux) + @cd ./_build; $(SUDO) make install else @cd ./_build; make install endif +endif .PHONY: install +uninstall: + @$(call echo,Make $@) +ifeq ($(HOST_OS),Linux) + $(SUDO) rm -rf /usr/local/lib/libmynteye* + $(SUDO) rm -rf /usr/local/include/mynteye/ + $(SUDO) rm -rf /usr/local/lib/cmake/mynteye/ + $(SUDO) rm -rf /usr/local/share/mynteye/ +endif + +.PHONY: uninstall + # samples samples: install @@ -130,14 +166,30 @@ tools: install .PHONY: tools +# pkg + +pkg: clean + @$(call echo,Make $@) +ifeq ($(HOST_OS),Win) + @$(SH) ./scripts/win/winpack.sh "$(PKGNAME)" +else + $(error "Can't make pkg on $(HOST_OS)") +endif + +cleanpkg: + @$(call echo,Make $@) + @$(call rm_f,$(PKGNAME)*) + +.PHONY: pkg cleanpkg + # ros ros: install @$(call echo,Make $@) -ifeq ($(HOST_OS),Win) - $(error "Can't make ros on win") +ifeq ($(HOST_OS),Linux) + @cd ./wrappers/ros && catkin_make -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) else - @cd ./wrappers/ros && catkin_make + $(error "Can't make ros on $(HOST_OS)") endif .PHONY: ros @@ -219,8 +271,7 @@ cleanlog: @$(call rm_f,*ERROR*) @$(call rm_f,*FATAL*) -cleanall: clean - @$(call rm,./doc/_output/) +cleanall: clean cleandoc @$(call rm,./test/gtest/_build/) @$(call rm,./third_party/glog/_build/) @$(FIND) . -type f -name ".DS_Store" -print0 | xargs -0 rm -f @@ -247,6 +298,7 @@ host: @echo BUILD: $(BUILD) @echo LDD: $(LDD) @echo CMAKE: $(CMAKE) + @echo PKGNAME: $(PKGNAME) .PHONY: host diff --git a/README.md b/README.md index cdeb595..f478950 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# MYNT® EYE SDK +# MYNT® EYE S SDK -[![](https://img.shields.io/badge/MYNT%20EYE%20SDK-2.0.0--rc-brightgreen.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2) +[![](https://img.shields.io/badge/MYNT%20EYE%20S%20SDK-2.2.2--rc0-brightgreen.svg?style=flat)](https://github.com/slightech/MYNT-EYE-S-SDK) ## Overview -MYNT® EYE SDK 2.0 is a cross-platform library for MYNT® EYE cameras. +MYNT® EYE S SDK is a cross-platform library for MYNT® EYE Standard cameras. The following platforms have been tested: @@ -16,19 +16,20 @@ Please follow the guide doc to install the SDK on different platforms. ## Documentations -* [API Doc](https://github.com/slightech/MYNT-EYE-SDK-2/releases): API reference, some guides and data spec. - * zh-Hans: [![](https://img.shields.io/badge/Download-PDF-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2/files/2083629/mynt-eye-sdk-apidoc-2.0.0-rc-zh-Hans.pdf) [![](https://img.shields.io/badge/Download-HTML-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2/files/2083631/mynt-eye-sdk-apidoc-2.0.0-rc-html-zh-Hans.zip) [![](https://img.shields.io/badge/Online-HTML-blue.svg?style=flat)](https://slightech.github.io/MYNT-EYE-SDK-2/) -* [Guide Doc](https://github.com/slightech/MYNT-EYE-SDK-2-Guide/releases): How to install and start using the SDK. - * zh-Hans: [![](https://img.shields.io/badge/Download-PDF-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2-Guide/files/2083740/mynt-eye-sdk-guide-2.0.0-rc-zh-Hans.pdf) [![](https://img.shields.io/badge/Download-HTML-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-SDK-2-Guide/files/2083745/mynt-eye-sdk-guide-2.0.0-rc-html-zh-Hans.zip) [![](https://img.shields.io/badge/Online-HTML-blue.svg?style=flat)](https://slightech.github.io/MYNT-EYE-SDK-2-Guide/) +* [API Doc](https://github.com/slightech/MYNT-EYE-S-SDK/releases): API reference, some guides and data spec. + * en: [![](https://img.shields.io/badge/Download-PDF-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-S-SDK/files/2562294/mynt-eye-s-sdk-apidoc-2.2.2-rc0-en.pdf) [![](https://img.shields.io/badge/Download-HTML-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-S-SDK/files/2562296/mynt-eye-s-sdk-apidoc-2.2.2-rc0-en.zip) [![](https://img.shields.io/badge/Online-HTML-blue.svg?style=flat)](https://slightech.github.io/MYNT-EYE-S-SDK/) + * zh-Hans: [![](https://img.shields.io/badge/Download-PDF-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-S-SDK/files/2562297/mynt-eye-s-sdk-apidoc-2.2.2-rc0-zh-Hans.pdf) [![](https://img.shields.io/badge/Download-HTML-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-S-SDK/files/2562298/mynt-eye-s-sdk-apidoc-2.2.2-rc0-zh-Hans.zip) [![](https://img.shields.io/badge/Online-HTML-blue.svg?style=flat)](http://doc.myntai.com/resource/api/mynt-eye-s-sdk-apidoc-2.2.2-rc0-zh-Hans/mynt-eye-s-sdk-apidoc-2.2.2-rc0-zh-Hans/index.html) +* [Guide Doc](https://github.com/slightech/MYNT-EYE-S-SDK-Guide/releases): How to install and start using the SDK. + * en: [![](https://img.shields.io/badge/Download-PDF-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-S-SDK-Guide/files/2598115/mynt-eye-s-sdk-guide-2.2.2-rc0-en.pdf) [![](https://img.shields.io/badge/Download-HTML-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-S-SDK-Guide/files/2598116/mynt-eye-s-sdk-guide-2.2.2-rc0-en.zip) [![](https://img.shields.io/badge/Online-HTML-blue.svg?style=flat)](https://slightech.github.io/MYNT-EYE-S-SDK-Guide/) + * zh-Hans: [![](https://img.shields.io/badge/Download-PDF-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-S-SDK-Guide/files/2598117/mynt-eye-s-sdk-guide-2.2.2-rc0-zh-Hans.pdf) [![](https://img.shields.io/badge/Download-HTML-blue.svg?style=flat)](https://github.com/slightech/MYNT-EYE-S-SDK-Guide/files/2598119/mynt-eye-s-sdk-guide-2.2.2-rc0-zh-Hans.zip) [![](https://img.shields.io/badge/Online-HTML-blue.svg?style=flat)](http://doc.myntai.com/resource/sdk/mynt-eye-s-sdk-guide-2.2.2-rc0-zh-Hans/mynt-eye-s-sdk-guide-2.2.2-rc0-zh-Hans/index.html) -> Supported languages: `zh-Hans`. +> Supported languages: `en`, `zh-Hans`. ## Firmwares -[Google Drive]: https://drive.google.com/drive/folders/1tdFCcTBMNcImEGZ39tdOZmlX2SHKCr2f -[百度网盘]: https://pan.baidu.com/s/1yPQDp2r0x4jvNwn2UjlMUQ +[MYNTEYE_BOX]: http://doc.myntai.com/mynteye/s/download -Get firmwares from our online disks: [Google Drive][], [百度网盘][]. The latest version is `2.0.0-rc`. +Get firmwares from our online disks: [MYNTEYE_BOX][]. The latest version is `2.2.2`. ## Usage @@ -60,8 +61,8 @@ make samples ## Mirrors -国内镜像：[码云](https://gitee.com/mynt/MYNT-EYE-SDK-2)。 +国内镜像：[码云](https://gitee.com/mynt/MYNT-EYE-S-SDK)。 ## License -This project is licensed under the Apache License, Version 2.0. Copyright 2018 Slightech Co., Ltd. +This project is licensed under the [Apache License, Version 2.0](LICENSE). Copyright 2018 Slightech Co., Ltd. diff --git a/cmake/Common.cmake b/cmake/Common.cmake index ab14b08..8526d9a 100755 --- a/cmake/Common.cmake +++ b/cmake/Common.cmake @@ -70,7 +70,9 @@ macro(set_outdir ARCHIVE_OUTPUT_DIRECTORY LIBRARY_OUTPUT_DIRECTORY RUNTIME_OUTPU endforeach() endmacro() -set(__exe2bat_relative_path false) +if(NOT __exe2bat_relative_path) + set(__exe2bat_relative_path false) +endif() macro(exe2bat exe_name exe_dir dll_search_paths) message(STATUS "Generating ${exe_name}.bat") diff --git a/cmake/DetectOpenCV.cmake b/cmake/DetectOpenCV.cmake index 4673876..e82e546 100644 --- a/cmake/DetectOpenCV.cmake +++ b/cmake/DetectOpenCV.cmake @@ -15,14 +15,25 @@ include(${CMAKE_CURRENT_LIST_DIR}/IncludeGuard.cmake) cmake_include_guard() -find_package(OpenCV REQUIRED) -message(STATUS "Found OpenCV: ${OpenCV_VERSION}") -if(OpenCV_VERSION VERSION_LESS 3.0) - add_definitions(-DUSE_OPENCV2) -elseif(OpenCV_VERSION VERSION_LESS 4.0) - add_definitions(-DUSE_OPENCV3) +if(OpenCV_FIND_QUIET) + find_package(OpenCV QUIET) else() - add_definitions(-DUSE_OPENCV4) + find_package(OpenCV REQUIRED) +endif() + +if(OpenCV_FOUND) + +#message(STATUS "Found OpenCV: ${OpenCV_VERSION}") + +set(WITH_OPENCV TRUE) +add_definitions(-DWITH_OPENCV) + +if(OpenCV_VERSION VERSION_LESS 3.0) + add_definitions(-DWITH_OPENCV2) +elseif(OpenCV_VERSION VERSION_LESS 4.0) + add_definitions(-DWITH_OPENCV3) +else() + add_definitions(-DWITH_OPENCV4) endif() list(FIND OpenCV_LIBS "opencv_world" __index) @@ -35,3 +46,9 @@ if(MSVC OR MSYS OR MINGW) else() set(OpenCV_LIB_SEARCH_PATH "${OpenCV_LIB_PATH}") endif() + +else() + +set(WITH_OPENCV FALSE) + +endif() diff --git a/cmake/Option.cmake b/cmake/Option.cmake index bb22438..9865c24 100644 --- a/cmake/Option.cmake +++ b/cmake/Option.cmake @@ -12,11 +12,141 @@ # See the License for the specific language governing permissions and # limitations under the License. -option(WITH_API "Build with API layer, need OpenCV" ON) +include(${CMAKE_CURRENT_LIST_DIR}/IncludeGuard.cmake) +cmake_include_guard() -message(STATUS "Options:") -message(STATUS " WITH_API: ${WITH_API}") +include(${CMAKE_CURRENT_LIST_DIR}/Utils.cmake) + + +# build components + +option(WITH_API "Build with API layer, need OpenCV" ON) +option(WITH_DEVICE_INFO_REQUIRED "Build with device info required" ON) + +# 3rdparty components + +option(WITH_BOOST "Include Boost support" ON) # How to install glog? # Ubuntu: `sudo apt-get install libgoogle-glog-dev` option(WITH_GLOG "Include glog support" OFF) + +# packages + +if(WITH_API) + include(${CMAKE_CURRENT_LIST_DIR}/DetectOpenCV.cmake) +endif() + +if(WITH_DEVICE_INFO_REQUIRED) + add_definitions(-DWITH_DEVICE_INFO_REQUIRED) +endif() + +if(WITH_BOOST) + find_package(Boost COMPONENTS filesystem) + if(Boost_FOUND) + set(Boost_VERSION_STRING "${Boost_MAJOR_VERSION}.${Boost_MINOR_VERSION}.${Boost_SUBMINOR_VERSION}") + set(WITH_FILESYSTEM TRUE) + set(WITH_BOOST_FILESYSTEM TRUE) + add_definitions(-DWITH_FILESYSTEM) + add_definitions(-DWITH_BOOST_FILESYSTEM) + endif() +endif() + +if(NOT WITH_FILESYSTEM) + if(MSVC OR MSYS OR MINGW) # win + set(WITH_FILESYSTEM TRUE) + set(WITH_NATIVE_FILESYSTEM TRUE) + add_definitions(-DWITH_FILESYSTEM) + add_definitions(-DWITH_NATIVE_FILESYSTEM) + endif() +endif() + +if(WITH_GLOG) + include(${CMAKE_CURRENT_LIST_DIR}/DetectGLog.cmake) +endif() + +find_package(CUDA QUIET) + +# summary + +set_version_values(CMAKE_CXX_COMPILER_VERSION) + +status("") +status("Platform:") +status(" HOST_OS: ${HOST_OS}") +status(" HOST_NAME: ${HOST_NAME}") +status(" HOST_ARCH: ${HOST_ARCH}") +status(" HOST_COMPILER: ${CMAKE_CXX_COMPILER_ID}") +status(" COMPILER_VERSION: ${CMAKE_CXX_COMPILER_VERSION}") +status(" COMPILER_VERSION_MAJOR: ${CMAKE_CXX_COMPILER_VERSION_MAJOR}") +status(" COMPILER_VERSION_MINOR: ${CMAKE_CXX_COMPILER_VERSION_MINOR}") +status(" COMPILER_VERSION_PATCH: ${CMAKE_CXX_COMPILER_VERSION_PATCH}") +status(" COMPILER_VERSION_TWEAK: ${CMAKE_CXX_COMPILER_VERSION_TWEAK}") +if(CUDA_FOUND) + status(" CUDA_VERSION: ${CUDA_VERSION}") + status(" CUDA_VERSION_MAJOR: ${CUDA_VERSION_MAJOR}") + status(" CUDA_VERSION_MINOR: ${CUDA_VERSION_MINOR}") + status(" CUDA_VERSION_STRING: ${CUDA_VERSION_STRING}") +endif() +if(OpenCV_FOUND) + status(" OpenCV_VERSION: ${OpenCV_VERSION}") + status(" OpenCV_VERSION_MAJOR: ${OpenCV_VERSION_MAJOR}") + status(" OpenCV_VERSION_MINOR: ${OpenCV_VERSION_MINOR}") + status(" OpenCV_VERSION_PATCH: ${OpenCV_VERSION_PATCH}") + status(" OpenCV_VERSION_TWEAK: ${OpenCV_VERSION_TWEAK}") + status(" OpenCV_VERSION_STATUS: ${OpenCV_VERSION_STATUS}") + status(" OpenCV_WITH_WORLD: ${WITH_OPENCV_WORLD}") +endif() +if(mynteye_VERSION) + status(" MYNTEYE_VERSION: ${mynteye_VERSION}") + status(" MYNTEYE_VERSION_MAJOR: ${mynteye_VERSION_MAJOR}") + status(" MYNTEYE_VERSION_MINOR: ${mynteye_VERSION_MINOR}") + status(" MYNTEYE_VERSION_PATCH: ${mynteye_VERSION_PATCH}") + status(" MYNTEYE_VERSION_TWEAK: ${mynteye_VERSION_TWEAK}") +endif() + +status("") +status("Options:") +status(" WITH_API: ${WITH_API}") +if(WITH_API) + if(OpenCV_FOUND) + status(" OpenCV: YES") + status(" OpenCV_VERSION: ${OpenCV_VERSION}") + status(" OpenCV_WORLD: " IF WITH_OPENCV_WORLD "YES" ELSE "NO") + else() + status(" OpenCV: NO") + endif() +endif() + +status(" WITH_DEVICE_INFO_REQUIRED: ${WITH_DEVICE_INFO_REQUIRED}") + +status(" WITH_BOOST: ${WITH_BOOST}") +if(WITH_BOOST) + if(Boost_FOUND) + status(" Boost: YES") + status(" Boost_VERSION: ${Boost_VERSION_STRING}") + #status(" Boost_LIBRARIES: ${Boost_LIBRARIES}") + else() + status(" Boost: NO") + endif() +endif() + +status(" WITH_GLOG: ${WITH_GLOG}") +if(WITH_GLOG) + if(glog_FOUND) + status(" glog: YES") + status(" glog_VERSION: ${glog_VERSION}") + else() + status(" glog: NO") + endif() +endif() + +status("") +status("Features:") +status(" Filesystem: " + IF WITH_BOOST_FILESYSTEM "boost" + ELIF WITH_NATIVE_FILESYSTEM "native" + ELSE "none" +) + +status("") diff --git a/cmake/Utils.cmake b/cmake/Utils.cmake index 1f5a607..3b8ba45 100644 --- a/cmake/Utils.cmake +++ b/cmake/Utils.cmake @@ -49,3 +49,88 @@ macro(make_executable NAME) endif() endif() endmacro() + +# set_default_value(VARIABLE DEFAULT) +macro(set_default_value VARIABLE DEFAULT) + if(NOT ${VARIABLE}) + set(${VARIABLE} ${DEFAULT}) + endif() +endmacro() + +# set_version_values(VARIABLE) +macro(set_version_values VARIABLE) + string(REPLACE "." ";" __version_list "${${VARIABLE}}") + list(LENGTH __version_list __len) + if(${__len} GREATER 0) + list(GET __version_list 0 ${VARIABLE}_MAJOR) + endif() + if(${__len} GREATER 1) + list(GET __version_list 1 ${VARIABLE}_MINOR) + endif() + if(${__len} GREATER 2) + list(GET __version_list 2 ${VARIABLE}_PATCH) + endif() + if(${__len} GREATER 3) + list(GET __version_list 3 ${VARIABLE}_TWEAK) + endif() +endmacro() + +# status(TEXT [IF cond text [ELIF cond text] [ELSE cond text]]) +macro(status TEXT) + set(options) + set(oneValueArgs) + set(multiValueArgs IF ELIF ELSE) + cmake_parse_arguments(THIS "${options}" "${oneValueArgs}" + "${multiValueArgs}" ${ARGN}) + + #message(STATUS "TEXT: ${TEXT}") + #message(STATUS "THIS_IF: ${THIS_IF}") + #message(STATUS "THIS_ELIF: ${THIS_ELIF}") + #message(STATUS "THIS_ELSE: ${THIS_ELSE}") + + set(__msg_list "${TEXT}") + set(__continue TRUE) + + if(__continue AND DEFINED THIS_IF) + #message(STATUS "-- THIS_IF: ${THIS_IF}") + list(LENGTH THIS_IF __if_len) + if(${__if_len} GREATER 1) + list(GET THIS_IF 0 __if_cond) + if(${__if_cond}) + list(REMOVE_AT THIS_IF 0) + list(APPEND __msg_list ${THIS_IF}) + set(__continue FALSE) + endif() + else() + message(FATAL_ERROR "status() IF must have cond and text, >= 2 items") + endif() + endif() + + if(__continue AND DEFINED THIS_ELIF) + #message(STATUS "-- THIS_ELIF: ${THIS_ELIF}") + list(LENGTH THIS_ELIF __elif_len) + if(${__elif_len} GREATER 1) + list(GET THIS_ELIF 0 __elif_cond) + if(${__elif_cond}) + list(REMOVE_AT THIS_ELIF 0) + list(APPEND __msg_list ${THIS_ELIF}) + set(__continue FALSE) + endif() + else() + message(FATAL_ERROR "status() ELIF must have cond and text, >= 2 items") + endif() + endif() + + if(__continue AND DEFINED THIS_ELSE) + #message(STATUS "-- THIS_ELSE: ${THIS_ELSE}") + list(LENGTH THIS_ELSE __else_len) + if(${__else_len} GREATER 0) + list(APPEND __msg_list ${THIS_ELSE}) + else() + message(FATAL_ERROR "status() ELSE must have text, >= 1 items") + endif() + endif() + + string(REPLACE ";" "" __msg_list "${__msg_list}") + message(STATUS "${__msg_list}") +endmacro() diff --git a/cmake/templates/pkginfo.sh.in b/cmake/templates/pkginfo.sh.in new file mode 100644 index 0000000..8778d4e --- /dev/null +++ b/cmake/templates/pkginfo.sh.in @@ -0,0 +1,16 @@ +#!/usr/bin/env bash + +OpenCV_VERSION=@OpenCV_VERSION@ +OpenCV_VERSION_MAJOR=@OpenCV_VERSION_MAJOR@ +OpenCV_VERSION_MINOR=@OpenCV_VERSION_MINOR@ +OpenCV_VERSION_PATCH=@OpenCV_VERSION_PATCH@ +OpenCV_VERSION_STATUS=@OpenCV_VERSION_STATUS@ + +_contains() { + [ `echo $1 | grep -c "$2"` -gt 0 ] +} + +if _contains "@OpenCV_INCLUDE_DIRS@" "/ros/"; then + ROS_VERSION=$(rosversion -d) + OpenCV_VERSION=ros-$ROS_VERSION +fi diff --git a/config/SN07C624160009071F/device.info b/config/SN07C624160009071F/device.info deleted file mode 100644 index 1a515df..0000000 --- a/config/SN07C624160009071F/device.info +++ /dev/null @@ -1,10 +0,0 @@ -%YAML:1.0 ---- -device_name: MYNT-EYE-S210A -serial_number: "07C624160009071F" -firmware_version: "0.1" -hardware_version: "1.0" -spec_version: "1.1" -lens_type: "0000" -imu_type: "0000" -nominal_baseline: 0 diff --git a/config/SN07C624160009071F/img.params b/config/SN07C624160009071F/img.params deleted file mode 100644 index d78da8d..0000000 --- a/config/SN07C624160009071F/img.params +++ /dev/null @@ -1,53 +0,0 @@ -%YAML:1.0 ---- -version: "1.1" -in_left_map: - - - width: 640 - height: 400 - fx: 1.9739641213416058e+02 - fy: 1.9772337597617189e+02 - cx: 3.2611983633916327e+02 - cy: 1.9986969132833946e+02 - model: 0 - coeffs: [ 1.2135236310725651e-01, -8.5442776049177036e-02, - 2.4914898631983504e-03, -3.7752063658256863e-03, 0. ] - - - width: 1280 - height: 800 - fx: 1.9739641213416058e+02 - fy: 1.9772337597617189e+02 - cx: 3.2611983633916327e+02 - cy: 1.9986969132833946e+02 - model: 0 - coeffs: [ 1.2135236310725651e-01, -8.5442776049177036e-02, - 2.4914898631983504e-03, -3.7752063658256863e-03, 0. ] -in_right_map: - - - width: 640 - height: 400 - fx: 2.0335498653655989e+02 - fy: 2.0453858622699008e+02 - cx: 3.1589962248180814e+02 - cy: 2.1871688038954812e+02 - model: 0 - coeffs: [ 2.2904330559241560e-02, -2.9561990079971841e-02, - 3.9725942760981507e-03, -3.9689073214945591e-03, 0. ] - - - width: 1280 - height: 800 - fx: 2.0335498653655989e+02 - fy: 2.0453858622699008e+02 - cx: 3.1589962248180814e+02 - cy: 2.1871688038954812e+02 - model: 0 - coeffs: [ 2.2904330559241560e-02, -2.9561990079971841e-02, - 3.9725942760981507e-03, -3.9689073214945591e-03, 0. ] -ex_left_to_right: - rotation: [ 9.9998850083695123e-01, -1.9263678722299450e-03, - -4.3917309443490191e-03, 1.8166060642710027e-03, - 9.9968925981619028e-01, -2.4861290203142431e-02, - 4.4382582477776426e-03, 2.4853026274046636e-02, - 9.9968126367795229e-01 ] - translation: [ -8.2270200890555529e+01, -1.9535144360069059e+00, - 2.2588034344482368e+00 ] diff --git a/config/SN07C624160009071F/imu.params b/config/SN07C624160009071F/imu.params deleted file mode 100644 index 070f13a..0000000 --- a/config/SN07C624160009071F/imu.params +++ /dev/null @@ -1,15 +0,0 @@ -%YAML:1.0 ---- -in_accel: - scale: [ 0., 0., 0., 0., 0., 0., 0., 0., 0. ] - drift: [ 0., 0., 0. ] - noise: [ 0., 0., 0. ] - bias: [ 0., 0., 0. ] -in_gyro: - scale: [ 0., 0., 0., 0., 0., 0., 0., 0., 0. ] - drift: [ 0., 0., 0. ] - noise: [ 0., 0., 0. ] - bias: [ 0., 0., 0. ] -ex_left_to_imu: - rotation: [ 0., 0., 0., 0., 0., 0., 0., 0., 0. ] - translation: [ 0., 0., 0. ] diff --git a/doc/build.sh b/doc/build.sh index 5775ef5..5160c61 100755 --- a/doc/build.sh +++ b/doc/build.sh @@ -40,8 +40,8 @@ OUTPUT="$BASE_DIR/_output" _texcjk() { tex="$1"; shift; _echo_in "add cjk to $tex" - sed -i "" -e $'s/^\\\\begin{document}$/\\\\usepackage{CJKutf8}\\\n\\\\begin{document}\\\n\\\\begin{CJK}{UTF8}{gbsn}/g' $tex - sed -i "" -e $'s/^\\\\end{document}$/\\\\end{CJK}\\\n\\\\end{document}/g' $tex + sed -i "" -E $'s/^\\\\begin{document}$/\\\\usepackage{CJKutf8}\\\n\\\\begin{document}\\\n\\\\begin{CJK}{UTF8}{gbsn}/g' $tex + sed -i "" -E $'s/^\\\\end{document}$/\\\\end{CJK}\\\n\\\\end{document}/g' $tex } for lang in "${LANGS[@]}"; do @@ -52,11 +52,30 @@ for lang in "${LANGS[@]}"; do _mkdir "$OUTPUT/$lang" _echo_i "doxygen $DOXYFILE" doxygen $DOXYFILE + + version=`cat $DOXYFILE | grep -m1 "^PROJECT_NUMBER\s*=" | \ + sed -E "s/^.*=[[:space:]]*(.*)[[:space:]]*$/\1/g"` + + # html + if [ -d "$OUTPUT/$lang/html" ]; then + dirname="mynt-eye-s-sdk-apidoc"; \ + [ -n "$version" ] && dirname="$dirname-$version"; \ + dirname="$dirname-$lang" + cd "$OUTPUT/$lang" + [ -d "$dirname" ] && rm -rf "$dirname" + mv "html" "$dirname" && zip -r "$dirname.zip" "$dirname" + fi + + # latex if [ $pdflatex_FOUND ] && [ -f "$OUTPUT/$lang/latex/Makefile" ]; then _echo_in "doxygen make latex" + filename="mynt-eye-s-sdk-apidoc"; \ + [ -n "$version" ] && filename="$filename-$version"; \ + filename="$filename-$lang.pdf" cd "$OUTPUT/$lang/latex" && _texcjk refman.tex && make - [ -f "refman.pdf" ] && mv "refman.pdf" "../mynteye-apidoc.pdf" + [ -f "refman.pdf" ] && mv "refman.pdf" "../$filename" fi + _echo_d "doxygen completed" else _echo_e "$DOXYFILE not found" diff --git a/doc/en/api.doxyfile b/doc/en/api.doxyfile new file mode 100644 index 0000000..9f69ae2 --- /dev/null +++ b/doc/en/api.doxyfile @@ -0,0 +1,2495 @@ +# Doxyfile 1.8.14 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "MYNT EYE S SDK" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 2.2.2-rc0 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = http://www.myntai.com/mynteye/standard + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = ../static/images/icon.png + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = ../_output/en + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 2 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = YES + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = YES + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = NO + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = NO + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = NO + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = mainpage.md \ + specs_data.md \ + spec_hardware_info.md \ + spec_image_params.md \ + spec_imu_params.md \ + spec_image_data.md \ + spec_imu_data.md \ + specs_ctrl.md \ + spec_control_api.md \ + spec_control_channel.md \ + /usr/local/include/mynteye + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = /usr/local/include/mynteye/logger.h \ + /usr/local/include/mynteye/miniglog.h + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# 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 +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = ../static/images + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = ../static/custom.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via Javascript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have Javascript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Slightech generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = com.slightech.mynteye + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = com.slightech.mynteye.documentation + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = MYNT EYE S SDK + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = com.slightech.mynteye + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = com.slightech.mynteye + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = YES + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 260 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /