From: Moritz Schlarb Date: Wed, 11 Nov 2020 11:45:36 +0000 (+0000) Subject: Import seafile-client_7.0.10.orig.tar.xz X-Git-Tag: archive/raspbian/7.0.10-2+rpi1^2~6 X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=630820ea7fb9d095bef0e0171147b144ea73a989;p=seafile-client.git Import seafile-client_7.0.10.orig.tar.xz [dgit import orig seafile-client_7.0.10.orig.tar.xz] --- 630820ea7fb9d095bef0e0171147b144ea73a989 diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..a189b1d --- /dev/null +++ b/.clang-format @@ -0,0 +1,113 @@ +--- +BasedOnStyle: Google + +# Good: +# +# class Foo +# { +# public: +# +# Foo() = default; +# +# }; +# +# Bad: +# +# class Foo +# { +# public: +# +# Foo() = default; +# +# }; +# +AccessModifierOffset: -4 + +# Good: +# +# clang = Clang(); // Comment 1 +# format = Format(); // Comment 2 +# +# Bad: +# clang = Clang(); // Comment 1 +# format = Format(); // Comment 2 +# +AlignTrailingComments: false +AllowShortFunctionsOnASingleLine: false +AllowShortBlocksOnASingleLine: false +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false + +# Good: +# +# void F(int first, +# int second, +# int third, +# int fourth, +# int fifth, +# int sixth, +# int seventh, +# int eighth) {} +# +# Bad: +# +# void F(int first, int second, int third, int fourth, int fifth, int sixth, +# int seventh, int eighth) {} +# +BinPackParameters: false +BinPackArguments: false + +# Like 'Attach', but break before braces on function, namespaces, class, struct +# and union definitions. +# +BreakBeforeBraces: Linux + +# Good: +# +# class Foo +# { +# public: +# +# Foo() +# : first(1), second(2) {} +# +# }; +# +# Bad: +# +# class Foo +# { +# public: +# +# Foo() +# : first(1), second(2) {} +# +# }; +# +ConstructorInitializerIndentWidth: 4 +IndentWidth: 4 + +# Continuation indents such as assignment statements are indented by 2 spaces. +ContinuationIndentWidth: 4 + +PointerAlignment: Right +# Don't try to guess the pointer alignment +DerivePointerAlignment: false + +# List of foreach macros due to lack of range-based for loops. +ForEachMacros: [ foreach, foreachkey, foreachvalue, foreachpair ] + +# Maximum number of empty lines to keep. +MaxEmptyLinesToKeep: 2 + +# Good: +# +# x = 42; // Comment +# +# Bad: +# +# x = 42; // Comment +# +SpacesBeforeTrailingComments: 1 +... diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bc8fba0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,107 @@ +# Compiled Object files +*.slo +*.lo +*.o +*.obj + +# Compiled Dynamic libraries +*.so +*.dylib +*.dll + +# Compiled Static libraries +*.lai +*.la +*.a +*.dll.a + +# executables +seafile-applet +orig-seafile-applet +*.exe + +# backup file +*# +*~ +*.bak + +# other formats +cscope* +core +*.pyc +.DS_Store + +# CMake files goes here +build/ +CMakeCache.txt +CMakeFiles/ +Makefile +cmake_install.cmake +CTestTestfile.cmake +Testing/ +install_manifest.txt + +#### Qt files goes here +### moc +moc_*.cxx* +moc_*.cpp* +*.moc + +### ui +ui_*.h + +### qrc +*.qrc.depends +qrc_*.cxx +qrc_*.cpp + +i18n/*.qm + +### emacs files +.emacs* +.#* + +### ninja files +.ninja_deps +.ninja_log +build.ninja +rules.ninja + +## xcode related +Debug +Release +seafile-client.xcodeproj +CMakeScripts +seafile-applet.app +seafile-fsplugin.xcodeproj +Seafile FinderSync.appex + +## unittest related +test_* +!test_*.cpp +!test_*.h + +## doxygen related +docs +Doxyfile + +## breakpad related +third_party/gyp +third_party/breakpad + +/GPATH +/GTAGS +/GRTAGS +/gtags.files + +.deps +compile_commands.json +.ycm_extra_conf.py +seafile-applet.rc +*.dmp + +*seafile-applet +*.lib + +## vscode +.vscode/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..2755761 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,27 @@ +sudo: required +dist: trusty +language: cpp +matrix: + include: + - os: linux + compiler: gcc + env: BUILD_SHIBBOLETH_SUPPORT=ON + - os: linux + compiler: gcc + env: BUILD_SHIBBOLETH_SUPPORT=OFF + exclude: + - os: osx + compiler: gcc +before_install: + - ./scripts/install-deps-${TRAVIS_OS_NAME}.sh +script: + - ./scripts/ci-build.sh +notifications: + email: + recipients: + - linshuai2012@gmail.com + - rwindz0@gmail.com + slack: + secure: RhwjY2BL0bR6MD+ASvFptH9GJmT0CshRN4YoZgK80D/H1kK60nVjfYIwU0apmhG8J3Sz9jqQ5xGPBUXvAgKB9VzdGQVgo23kGm9P2AY6xM43HHcPJvuXEBeX6zCx1O2HyGmENq36Z9ZnDWxW9yswnXKmeb05lE+PisBn1XvWQrs= + on_success: change + on_failure: always diff --git a/.tx/config b/.tx/config new file mode 100644 index 0000000..00a636b --- /dev/null +++ b/.tx/config @@ -0,0 +1,9 @@ +[main] +host = https://www.transifex.com + +[seafile-client.master] +file_filter = i18n/seafile_.ts +source_file = i18n/seafile_en.ts +source_lang = en +type = TS + diff --git a/Application.manifest b/Application.manifest new file mode 100644 index 0000000..f0f460c --- /dev/null +++ b/Application.manifest @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..8bef36c --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,858 @@ +CMAKE_MINIMUM_REQUIRED(VERSION 2.8.9) + +PROJECT(seafile-client) +SET(SEAFILE_CLIENT_VERSION_MAJOR 7) +SET(SEAFILE_CLIENT_VERSION_MINOR 0) +SET(SEAFILE_CLIENT_VERSION_PATCH 10) +SET(PROJECT_VERSION "${SEAFILE_CLIENT_VERSION_MAJOR}.${SEAFILE_CLIENT_VERSION_MINOR}.${SEAFILE_CLIENT_VERSION_PATCH}") +ADD_DEFINITIONS(-DSEAFILE_CLIENT_VERSION=${PROJECT_VERSION}) +INCLUDE(FindPkgConfig) + +## Build crash repoter on release build as default +IF (NOT (${CMAKE_BUILD_TYPE} MATCHES Release)) + SET(CMAKE_BUILD_TYPE Debug) +ENDIF() + +# CMake's builtin UNIX variable is true on Mac/Linux/BSD, but sometimes we want +# to detect for LINUX. +IF (UNIX AND NOT APPLE) + SET(LINUX TRUE) +ENDIF() + +IF (APPLE AND NOT CMAKE_OSX_DEPLOYMENT_TARGET) + SET(CMAKE_OSX_DEPLOYMENT_TARGET "10.9") +ENDIF() + +FIND_PROGRAM(git_executable NAMES git git.exe git.cmd) +IF (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/.git AND NOT (${CMAKE_BUILD_TYPE} MATCHES Release)) + EXECUTE_PROCESS(COMMAND + ${git_executable} rev-list HEAD --count + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + OUTPUT_VARIABLE SEAFILE_CLIENT_REVISION + OUTPUT_STRIP_TRAILING_WHITESPACE ) + ADD_DEFINITIONS(-DSEAFILE_CLIENT_REVISION=${SEAFILE_CLIENT_REVISION}) +ENDIF() + +SET(PATH_TO_BREAKPAD_ROOT CACHE "Path to breakpad's root" "") + +OPTION(BUILD_TESTING "Build Test" OFF) + +OPTION(BUILD_DOCS "Build Documents" OFF) + +OPTION(BUILD_SHIBBOLETH_SUPPORT "Build Shibboleth support" OFF) + +option(BUILD_ENABLE_WARNINGS "Enable compiler warnings." ON) + +option(USE_QT_WEBKIT "Build use QT webkit" OFF) + +option(BUILD_SPARKLE_SUPPORT "Build Sparkle support" OFF) +IF (BUILD_SPARKLE_SUPPORT) + ADD_DEFINITIONS(-DHAVE_SPARKLE_SUPPORT) + IF (LINUX) + message(FATAL_ERROR "Sparkle Support is not available for linux." ) + ENDIF() + SET(platform_specific_moc_headers ${platform_specific_moc_headers} src/auto-update-service.h) + SET(platform_specific_sources ${platform_specific_sources} src/auto-update-service.cpp) + IF (NOT (${CMAKE_BUILD_TYPE} MATCHES Release)) + ADD_DEFINITIONS(-DSEAFILE_SPARKLE_DEBUG) + ENDIF() +ENDIF() + +MESSAGE("Build type: ${CMAKE_BUILD_TYPE}") + +## build in PIC mode +IF (NOT WIN32) + SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fPIC") + SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC") +ENDIF() + +## Setup warnings ouput if enabled +## but don't warning on unsupported warnings +if(BUILD_ENABLE_WARNINGS) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wsign-compare -Wno-long-long -Wno-unused-parameter") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wsign-compare -Wno-long-long -Wno-unused-parameter -Woverloaded-virtual") + if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-unknown-warning-option") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-unknown-warning-option -Wno-inconsistent-missing-override") + endif() +endif() + +## color diagnostics fix +if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang") + SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fcolor-diagnostics") + SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fcolor-diagnostics") +elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU") + execute_process(COMMAND ${CMAKE_CXX_COMPILER} + -dumpversion OUTPUT_VARIABLE GCC_VERSION) + if(GCC_VERSION VERSION_GREATER 4.9 OR GCC_VERSION VERSION_EQUAL 4.9) + SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fdiagnostics-color=always") + SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fdiagnostics-color=always") + endif() +endif() + +IF (WIN32) + CONFIGURE_FILE( + ${CMAKE_SOURCE_DIR}/seafile-applet.rc.in + ${CMAKE_BINARY_DIR}/seafile-applet.rc + ) + SET(EXTRA_LIBS ${EXTRA_LIBS} psapi ws2_32 shlwapi mpr crypt32) + SET(EXTRA_SOURCES ${EXTRA_SOURCES} ${CMAKE_BINARY_DIR}/seafile-applet.rc) + IF (${CMAKE_BUILD_TYPE} MATCHES Release) + SET(GUI_TYPE WIN32) + ENDIF() + SET(platform_specific_moc_headers ${platform_specific_moc_headers} src/ext-handler.h) + SET(platform_specific_sources ${platform_specific_sources} src/ext-handler.cpp) + IF (BUILD_SPARKLE_SUPPORT) + IF(NOT EXISTS "${CMAKE_SOURCE_DIR}/WinSparkle.lib") + message(FATAL_ERROR "File ${CMAKE_SOURCE_DIR}/WinSparkle.lib not found in current directory. Please setup winsparkle correctly." ) + ENDIF() + SET(SPARKLE_LIBS ${CMAKE_SOURCE_DIR}/WinSparkle.lib) + ENDIF() + +ELSEIF (LINUX) + INCLUDE_DIRECTORIES(${QT_QTDBUS_INCLUDE_DIR}) + LINK_DIRECTORIES(${QT_QTDBUS_LIBRARIES}) + SET(EXTRA_LIBS ${EXTRA_LIBS} ${QT_QTDBUS_LIBRARIES}) +ELSEIF (APPLE) + IF (BUILD_SPARKLE_SUPPORT) + SET(platform_specific_sources ${platform_specific_sources} src/mac-sparkle-support.mm) + SET_SOURCE_FILES_PROPERTIES(src/mac-sparkle-support.mm + PROPERTIES COMPILE_FLAGS -fobjc-arc) + + SET(SPARKLE_FRAMEWORK /usr/local/Sparkle.framework) + IF(NOT EXISTS "${SPARKLE_FRAMEWORK}") + message(FATAL_ERROR "File ${SPARKLE_FRAMEWORK} not found. Please setup it correctly.") + ENDIF() + INCLUDE_DIRECTORIES(${SPARKLE_FRAMEWORK}/Headers) + SET(EXTRA_LIBS ${EXTRA_LIBS} ${SPARKLE_FRAMEWORK}) + ENDIF() + + SET(platform_specific_sources ${platform_specific_sources} src/application.cpp) + ## Enforce ARC for this file, since ARC is only supported after the objc + ## runtime changes in os x 10.10 + SET_SOURCE_FILES_PROPERTIES(src/utils/utils-mac.mm + PROPERTIES COMPILE_FLAGS -fobjc-arc) + + FIND_LIBRARY(COCOA_LIBRARY Cocoa) + MARK_AS_ADVANCED (COCOA_LIBRARY) + FIND_LIBRARY(Sec_LIBRARY Security) + MARK_AS_ADVANCED (Sec_LIBRARY) + SET(EXTRA_LIBS ${EXTRA_LIBS} ${COCOA_LIBRARY} ${Sec_LIBRARY}) +ENDIF() + +IF(APPLE) + ADD_DEFINITIONS(-DHAVE_FINDER_SYNC_SUPPORT) + SET(platform_specific_moc_headers ${platform_specific_moc_headers} src/finder-sync/finder-sync-host.h) + SET(platform_specific_sources ${platform_specific_sources} + src/finder-sync/finder-sync.cpp src/finder-sync/finder-sync-listener.mm + src/finder-sync/finder-sync-host.cpp) + SET_SOURCE_FILES_PROPERTIES(src/finder-sync/finder-sync-listener.mm + PROPERTIES COMPILE_FLAGS -fobjc-arc) +ENDIF() + +#################### +###### BEGIN: QT configuration +#################### +SET(QT_VERSION_MAJOR 5) + +# Qt 5.6.0 removes QtWebKit, we need to use QtWebEnigne. First we detect the +# current qt version, then use proper name based on the version. However we +# have to keep using QtWebKit on windows because QtWebEngine can't be +# compiled in msys2/mingw (QtWebEnigne is based on chrome, which has to be +# compiled with MSVC.) +FIND_PROGRAM(qmake_executable NAMES qmake qmake.exe) +EXECUTE_PROCESS(COMMAND + bash -c "${qmake_executable} --version | grep -iE '^using qt version [0-9.]+' | awk '{print $4}'" + OUTPUT_VARIABLE DETECTED_QT_VERSION + OUTPUT_STRIP_TRAILING_WHITESPACE) +MESSAGE("qt5 version: ${DETECTED_QT_VERSION}") +IF(WIN32 OR USE_QT_WEBKIT) + ADD_DEFINITIONS(-DSEAFILE_USE_WEBKIT) + SET(WEBKIT_NAME "WebKit") + SET(WEBKIT_WIDGETS_NAME "WebKitWidgets") +ELSE() + SET(WEBKIT_NAME "WebEngine") + SET(WEBENGINE_CORE "WebEngineCore") + SET(WEBKIT_WIDGETS_NAME "WebEngineWidgets") + SET(SHIB_EXTRA_HEADER "src/shib/shib-helper.h") +ENDIF() + +SET(USE_QT_LIBRARIES + Core Gui Widgets LinguistTools Network + ) +IF (BUILD_SHIBBOLETH_SUPPORT) + SET(USE_QT_LIBRARIES ${USE_QT_LIBRARIES} ${WEBENGINE_CORE} ${WEBKIT_NAME} ${WEBKIT_WIDGETS_NAME}) + ADD_DEFINITIONS(-DHAVE_SHIBBOLETH_SUPPORT) +ENDIF() + +IF (${CMAKE_SYSTEM_NAME} MATCHES "Linux") + SET(USE_QT_LIBRARIES ${USE_QT_LIBRARIES} "DBus") +ENDIF() + +FIND_PACKAGE(Qt5 REQUIRED ${USE_QT_LIBRARIES}) +SET(QT_LUPDATE_EXECUTABLE ${Qt5_LUPDATE_EXECUTABLE}) +# from QT 5.4.0 Changelog +# The Qt binary packages are now configured with C++11 enabled. +# this requires your gcc compiler newer than 4.8.1 or clang newer than 3.3 + +if (CYGWIN OR MINGW) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=gnu++11") +else() + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11") +endif() + +# for OS X, we requires libc++ instead +if (APPLE) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++") + SET(CMAKE_XCODE_ATTRIBUTE_CLANG_CXX_LANGUAGE_STANDARD "c++11") + SET(CMAKE_XCODE_ATTRIBUTE_CLANG_CXX_LIBRARY "libc++") +endif() + +ADD_DEFINITIONS(-DQUAZIP_STATIC) + +# MOC FILES +SET(moc_headers + src/seafile-applet.h + src/account-mgr.h + src/configurator.h + src/daemon-mgr.h + src/auto-login-service.h + src/repo-service.h + src/repo-service-helper.h + src/events-service.h + src/avatar-service.h + src/open-local-helper.h + src/server-status-service.h + src/account-info-service.h + src/customization-service.h + src/message-poller.h + src/network-mgr.h + src/settings-mgr.h + src/traynotificationwidget.h + src/traynotificationmanager.h + src/log-uploader.h + src/api/api-client.h + src/api/api-request.h + src/api/requests.h + src/rpc/rpc-client.h + src/rpc/rpc-server.h + src/ui/main-window.h + src/ui/init-seafile-dialog.h + src/ui/login-dialog.h + src/ui/account-settings-dialog.h + src/ui/check-repo-root-perm-dialog.h + src/ui/create-repo-dialog.h + src/ui/repo-detail-dialog.h + src/ui/settings-dialog.h + src/ui/download-repo-dialog.h + src/ui/cloud-view.h + src/ui/tray-icon.h + src/ui/about-dialog.h + src/ui/repo-tree-model.h + src/ui/repo-tree-view.h + src/ui/repo-item-delegate.h + src/ui/clone-tasks-dialog.h + src/ui/clone-tasks-table-model.h + src/ui/clone-tasks-table-view.h + src/ui/server-status-dialog.h + src/ui/search-tab.h + src/ui/search-tab-items.h + src/ui/init-vdrive-dialog.h + src/ui/uninstall-helper-dialog.h + src/ui/ssl-confirm-dialog.h + src/ui/private-share-dialog.h + src/ui/user-name-completer.h + src/ui/account-view.h + src/ui/seafile-tab-widget.h + src/ui/tab-view.h + src/ui/loading-view.h + src/ui/logout-view.h + src/ui/repos-tab.h + src/ui/starred-files-tab.h + src/ui/starred-files-list-view.h + src/ui/starred-files-list-model.h + src/ui/starred-file-item-delegate.h + src/ui/activities-tab.h + src/ui/events-list-view.h + src/ui/event-details-dialog.h + src/ui/event-details-tree.h + src/ui/set-repo-password-dialog.h + src/ui/sync-errors-dialog.h + src/ui/search-bar.h + src/ui/two-factor-dialog.h + src/filebrowser/file-browser-manager.h + src/filebrowser/file-browser-dialog.h + src/filebrowser/file-browser-requests.h + src/filebrowser/file-browser-search-tab.h + src/filebrowser/file-table.h + src/filebrowser/data-mgr.h + src/filebrowser/tasks.h + src/filebrowser/reliable-upload.h + src/filebrowser/progress-dialog.h + src/filebrowser/sharedlink-dialog.h + src/filebrowser/seafilelink-dialog.h + src/filebrowser/auto-update-mgr.h + src/filebrowser/transfer-mgr.h + src/filebrowser/thumbnail-service.h + third_party/QtAwesome/QtAwesome.h + third_party/quazip/quazipfile.h + ${platform_specific_moc_headers} +) + +IF (APPLE) + SET(moc_headers ${moc_headers} src/application.h) +ENDIF() + +IF (BUILD_SHIBBOLETH_SUPPORT) + SET(moc_headers ${moc_headers} src/shib/shib-login-dialog.h ${SHIB_EXTRA_HEADER}) +ENDIF() + +# UI FILES +SET(ui_files + ui/about-dialog.ui + ui/login-dialog.ui + ui/account-settings-dialog.ui + ui/create-repo-dialog.ui + ui/repo-detail-dialog.ui + ui/settings-dialog.ui + ui/download-repo-dialog.ui + ui/init-seafile-dialog.ui + ui/cloud-view.ui + ui/clone-tasks-dialog.ui + ui/server-status-dialog.ui + ui/init-vdrive-dialog.ui + ui/uninstall-helper-dialog.ui + ui/ssl-confirm-dialog.ui + ui/private-share-dialog.ui + ui/account-view.ui + ui/two-factor-dialog.ui + ui/set-repo-password-dialog.ui + ${platform_specific_ui_files} +) + +# RESOURCES +SET(qrc_files + seafile-client.qrc + third_party/QtAwesome/QtAwesome.qrc +) + +QT5_WRAP_UI(ui_output ${ui_files}) + +# meta object compliation(moc) +QT5_WRAP_CPP(moc_output ${moc_headers}) + +# resources files +QT5_ADD_RESOURCES(resources_ouput ${qrc_files}) + +# MESSAGE("moc output: ${moc_output}") +# MESSAGE("ui output: ${ui_output}") + +#################### +###### END: QT configuration +#################### + +#################### +###### BEGIN: pthread support is required explicitly on linux +#################### + +IF(NOT WIN32 AND NOT APPLE) + SET(CMAKE_THREAD_PREFER_PTHREAD ON) + INCLUDE(FindThreads) + LINK_LIBRARIES(${CMAKE_THREAD_LIBS_INIT}) +ENDIF(NOT WIN32 AND NOT APPLE) + +#################### +###### BEGIN: other libraries configuration +#################### +FIND_PACKAGE(PkgConfig REQUIRED) + +PKG_CHECK_MODULES(SQLITE3 REQUIRED sqlite3>=3.0.0) + +PKG_CHECK_MODULES(JANSSON REQUIRED jansson>=2.0) + +PKG_CHECK_MODULES(LIBSEARPC REQUIRED libsearpc>=1.0) + +PKG_CHECK_MODULES(OPENSSL REQUIRED openssl>=0.98) + +PKG_CHECK_MODULES(LIBSEAFILE REQUIRED libseafile>=1.7) + +PKG_CHECK_MODULES(LIBEVENT REQUIRED libevent>=2.0) + +PKG_CHECK_MODULES(ZLIB REQUIRED zlib>=1.2) +#################### +###### END: other libraries configuration +#################### + + +# c/cpp sources +SET(seafile_client_sources + src/i18n.cpp + src/main.cpp + src/seafile-applet.cpp + src/account.cpp + src/account-mgr.cpp + src/daemon-mgr.cpp + src/configurator.cpp + src/open-local-helper.cpp + src/message-poller.cpp + src/network-mgr.cpp + src/auto-login-service.cpp + src/repo-service.cpp + src/repo-service-helper.cpp + src/events-service.cpp + src/server-status-service.cpp + src/account-info-service.cpp + src/customization-service.cpp + src/avatar-service.cpp + src/settings-mgr.cpp + src/traynotificationwidget.cpp + src/traynotificationmanager.cpp + src/certs-mgr.cpp + src/log-uploader.cpp + src/sync-error-service.cpp + src/api/api-client.cpp + src/api/api-request.cpp + src/api/api-error.cpp + src/api/requests.cpp + src/api/server-repo.cpp + src/api/starred-file.cpp + src/api/event.cpp + src/api/commit-details.cpp + src/api/contact-share-info.cpp + src/rpc/rpc-client.cpp + src/rpc/rpc-server.cpp + src/rpc/local-repo.cpp + src/rpc/clone-task.cpp + src/rpc/sync-error.cpp + src/ui/about-dialog.cpp + src/ui/main-window.cpp + src/ui/init-seafile-dialog.cpp + src/ui/login-dialog.cpp + src/ui/account-settings-dialog.cpp + src/ui/check-repo-root-perm-dialog.cpp + src/ui/repo-detail-dialog.cpp + src/ui/settings-dialog.cpp + src/ui/create-repo-dialog.cpp + src/ui/download-repo-dialog.cpp + src/ui/tray-icon.cpp + src/ui/cloud-view.cpp + src/utils/uninstall-helpers.cpp + src/ui/repo-item.cpp + src/ui/repo-tree-model.cpp + src/ui/repo-tree-view.cpp + src/ui/repo-item-delegate.cpp + src/ui/clone-tasks-dialog.cpp + src/ui/clone-tasks-table-model.cpp + src/ui/clone-tasks-table-view.cpp + src/ui/server-status-dialog.cpp + src/ui/init-vdrive-dialog.cpp + src/ui/uninstall-helper-dialog.cpp + src/ui/search-tab.cpp + src/ui/search-tab-items.cpp + src/ui/ssl-confirm-dialog.cpp + src/ui/private-share-dialog.cpp + src/ui/user-name-completer.cpp + src/ui/proxy-style.cpp + src/ui/account-view.cpp + src/ui/seafile-tab-widget.cpp + src/ui/tab-view.cpp + src/ui/loading-view.cpp + src/ui/logout-view.cpp + src/ui/repos-tab.cpp + src/ui/starred-files-tab.cpp + src/ui/starred-files-list-view.cpp + src/ui/starred-files-list-model.cpp + src/ui/starred-file-item.cpp + src/ui/starred-file-item-delegate.cpp + src/ui/activities-tab.cpp + src/ui/events-list-view.cpp + src/ui/event-details-dialog.cpp + src/ui/event-details-tree.cpp + src/ui/set-repo-password-dialog.cpp + src/ui/sync-errors-dialog.cpp + src/ui/search-bar.cpp + src/ui/two-factor-dialog.cpp + src/filebrowser/file-browser-manager.cpp + src/filebrowser/file-browser-dialog.cpp + src/filebrowser/file-browser-requests.cpp + src/filebrowser/file-browser-search-tab.cpp + src/filebrowser/data-mgr.cpp + src/filebrowser/data-cache.cpp + src/filebrowser/file-table.cpp + src/filebrowser/seaf-dirent.cpp + src/filebrowser/reliable-upload.cpp + src/filebrowser/tasks.cpp + src/filebrowser/progress-dialog.cpp + src/filebrowser/sharedlink-dialog.cpp + src/filebrowser/seafilelink-dialog.cpp + src/filebrowser/auto-update-mgr.cpp + src/filebrowser/transfer-mgr.cpp + src/filebrowser/thumbnail-service.cpp + third_party/QtAwesome/QtAwesome.cpp + ${platform_specific_sources} +) + +IF (BUILD_SHIBBOLETH_SUPPORT) + SET(seafile_client_sources ${seafile_client_sources} src/shib/shib-login-dialog.cpp) +ENDIF() + +INCLUDE_DIRECTORIES( + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_CURRENT_BINARY_DIR} + ${CMAKE_CURRENT_SOURCE_DIR}/src + ${CMAKE_CURRENT_SOURCE_DIR}/third_party/QtAwesome + ${CMAKE_CURRENT_SOURCE_DIR}/third_party/quazip + ) + +FOREACH(USE_QT_LIBRARY ${USE_QT_LIBRARIES}) +INCLUDE_DIRECTORIES( +${Qt5${USE_QT_LIBRARY}_INCLUDE_DIRS} +) +ENDFOREACH() + +INCLUDE_DIRECTORIES( + ${OPENSSL_INCLUDE_DIRS} + ${LIBEVENT_INCLUDE_DIRS} + ${SQLITE3_INCLUDE_DIRS} + ${JANSSON_INCLUDE_DIRS} + ${LIBSEARPC_INCLUDE_DIRS} + ${LIBSEAFILE_INCLUDE_DIRS} +) + +LINK_DIRECTORIES( + ${QT_LIBRARY_DIR} + ${OPENSSL_LIBRARY_DIRS} + ${LIBEVENT_LIBRARY_DIRS} + ${LIBSEAFILE_LIBRARY_DIRS} + ${LIBSEARPC_LIBRARY_DIRS} + ${SQLITE3_LIBRARRY_DIRS} + ${JANSSON_LIBRARRY_DIRS} + ${ZLIB_LIBRARRY_DIRS} +) + +#################### +###### begin: lib +#################### + +# Helper Function to Add Seafile-Client Library +# Usage: +# ADD_SC_LIBRARY (name sources +# MOC_HEADERS moc_headers +# UI_FILES ui_files +# DEPENDS part +# LINK_LIBS libs +# ) +FUNCTION(ADD_SC_LIBRARY name) + MESSAGE(STATUS "Found internal library: ${name}") + CMAKE_PARSE_ARGUMENTS(ARG + "" + "" + "MOC_HEADERS;UI_FILES;DEPENDS;LINK_LIBS" + ${ARGN}) + IF(ARG_MOC_HEADERS) + QT5_WRAP_CPP(MOC_OUTPUT ${ARG_MOC_HEADERS}) + ENDIF() + IF(ARG_UI_FILES) + QT5_WRAP_UI(UI_OUTPUT ${ARG_UI_FILES}) + ENDIF() + + ADD_LIBRARY(${name} STATIC ${ARG_UNPARSED_ARGUMENTS} + ${MOC_OUTPUT} ${UI_OUTPUT}) + + TARGET_LINK_LIBRARIES(${name} ${QT_LIBRARIES} + ${SQLITE3_LIBRARIES} ${JANSSON_LIBRARIES} + ${EXTRA_LIBS} -lglib-2.0 ${ARG_LINK_LIBS} ${ZLIB_LIBRARIES}) +ENDFUNCTION(ADD_SC_LIBRARY) + +# library utils +LIST(APPEND utils_sources + src/utils/utils.cpp + src/utils/rsa.cpp + src/utils/api-utils.cpp + src/utils/paint-utils.cpp + src/utils/file-utils.cpp + src/utils/translate-commit-desc.cpp + src/utils/json-utils.cpp + src/utils/log.c + src/utils/stl.cpp + src/utils/seafile-error.cpp + ) +IF (WIN32) + LIST(APPEND utils_sources + src/utils/process-win.cpp + src/utils/registry.cpp + src/utils/utils-win.cpp + ) +ELSEIF (${CMAKE_SYSTEM_NAME} MATCHES "Linux" OR ${CMAKE_SYSTEM_NAME} MATCHES "BSD") + LIST(APPEND utils_sources + src/utils/process-linux.cpp + ) +ELSEIF(APPLE) + LIST(APPEND utils_sources + src/utils/process-mac.cpp + src/utils/utils-mac.mm) +ENDIF() + +ADD_SC_LIBRARY(utils ${utils_sources}) + +# library quazip +LIST(APPEND quazip_sources + third_party/quazip/JlCompress.cpp + third_party/quazip/quazip.cpp + third_party/quazip/quazipfile.cpp + third_party/quazip/quazipfileinfo.cpp + third_party/quazip/quaziodevice.cpp + third_party/quazip/quagzipfile.cpp + third_party/quazip/quazipnewinfo.cpp + third_party/quazip/quaadler32.cpp + third_party/quazip/quazipdir.cpp + third_party/quazip/quacrc32.cpp + third_party/quazip/qioapi.cpp + third_party/quazip/zip.c + third_party/quazip/unzip.c + ) + +ADD_SC_LIBRARY(quazip ${quazip_sources}) + +SET(SC_LIBS utils quazip) +#SET(SC_LIBS utils) + +#################### +###### end: lib +#################### + +#################### +###### start: translations +#################### + +SET(SEAFILE_TRANSLATE_SOURCES ${seafile_client_sources} ${utils_sources} ${moc_output} ${ui_output}) +SET(LANGUAGES + ca + de_DE + en + es + es_AR + es_MX + fr_FR + he_IL + hu_HU + is + it + ko_KR + nl_BE + pl_PL + pt_BR + pt_PT + ru + sk_SK + uk + zh_CN + zh_TW + tr + nl_NL + lv + ja + sv + cs_CZ + el_GR + nb_NO + ) + +SET(LANGUAGE_TS_FILES) +SET(SEAFILE_TS_TARGETS) +FOREACH(LANGUAGE ${LANGUAGES}) + SET(TS_FILE "${PROJECT_SOURCE_DIR}/i18n/seafile_${LANGUAGE}.ts") + SET(LANGUAGE_TS_FILES ${LANGUAGE_TS_FILES} ${TS_FILE}) + SET_SOURCE_FILES_PROPERTIES(${TS_FILE} PROPERTIES OUTPUT_LOCATION "${PROJECT_SOURCE_DIR}/i18n") + + SET(TS_TARGET "${LANGUAGE}_ts") + ADD_CUSTOM_TARGET(${TS_TARGET} + COMMAND ${QT_LUPDATE_EXECUTABLE} ${SEAFILE_TRANSLATE_SOURCES} + -ts "${PROJECT_SOURCE_DIR}/i18n/seafile_${LANGUAGE}.ts" + -I "${PROJECT_SOURCE_DIR}/src" + -locations none + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}) + + SET(SEAFILE_TS_TARGETS ${SEAFILE_TS_TARGETS} ${TS_TARGET}) + +ENDFOREACH(LANGUAGE ${LANGUAGES}) + +QT5_ADD_TRANSLATION(qm_files ${LANGUAGE_TS_FILES}) + +ADD_CUSTOM_TARGET(update-ts DEPENDS ${SEAFILE_TS_TARGETS}) + +#################### +###### end: translations +#################### + +################### +##### begin: doxygen +################## +FIND_PACKAGE(Doxygen) + +IF (DOXYGEN_FOUND) + CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in + ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) + + ADD_CUSTOM_TARGET(doxygen + COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating doxygen documentation." VERBATIM) + + IF(BUILD_DOCS) + ADD_CUSTOM_TARGET(doxygen ALL) + ENDIF() +ENDIF() + +################### +##### end: doxygen +################## + +#################### +###### begin: crash reporter +#################### + +# if you haven't installed it, please visit +# https://code.google.com/p/google-breakpad/ to get a copy of it +# or run the script build_breakpad.sh under the scripts directory + +## set up our crash reporter: breakpad + +IF (WIN32) +FIND_LIBRARY(BREAKPAD_LIBRARY breakpad) +FIND_LIBRARY(BREAKPAD_CLIENT_LIBRARY breakpad_client) +MESSAGE(STATUS "Found library: ${BREAKPAD_LIBRARY}") +MESSAGE(STATUS "Found library: ${BREAKPAD_CLIENT_LIBRARY}") +SET(seafile_client_sources ${seafile_client_sources} src/crash-handler.cpp) +ADD_DEFINITIONS(-DSEAFILE_CLIENT_HAS_CRASH_REPORTER) +SET(EXTRA_LIBS ${EXTRA_LIBS} ${BREAKPAD_LIBRARY} ${BREAKPAD_CLIENT_LIBRARY}) +ENDIF() + +#################### +###### end: crash reporter +#################### + +#################### +###### start: freedesktop files +#################### + +if(NOT WIN32) +install(DIRECTORY + ${CMAKE_SOURCE_DIR}/data/icons/16x16 + ${CMAKE_SOURCE_DIR}/data/icons/22x22 + ${CMAKE_SOURCE_DIR}/data/icons/24x24 + ${CMAKE_SOURCE_DIR}/data/icons/32x32 + ${CMAKE_SOURCE_DIR}/data/icons/48x48 + ${CMAKE_SOURCE_DIR}/data/icons/128x128 + ${CMAKE_SOURCE_DIR}/data/icons/scalable + DESTINATION share/icons/hicolor +) + +install(FILES + ${CMAKE_SOURCE_DIR}/data/seafile.desktop + DESTINATION share/applications +) + +install(FILES + ${CMAKE_SOURCE_DIR}/data/icons/128x128/apps/seafile.png + DESTINATION share/pixmaps +) + +endif() + +#################### +###### end: freedesktop files +#################### + +ADD_EXECUTABLE(seafile-applet ${GUI_TYPE} + ${seafile_client_sources} + ${moc_output} + ${ui_output} + ${resources_ouput} + ${EXTRA_SOURCES} +) + +INSTALL(TARGETS seafile-applet DESTINATION bin) + +TARGET_LINK_LIBRARIES(seafile-applet + ${SPARKLE_LIBS} + ${SC_LIBS} + ${QT_LIBRARIES} + ${OPENSSL_LIBRARIES} + ${LIBEVENT_LIBRARIES} + ${SQLITE3_LIBRARIES} + ${JANSSON_LIBRARIES} + ${LIBSEARPC_LIBRARIES} + ${LIBSEAFILE_LIBRARIES} + ${ZLIB_LIBRARIES} + ${EXTRA_LIBS} +) + +target_link_libraries(seafile-applet Qt5::Core Qt5::Gui Qt5::Widgets Qt5::Network) +IF (BUILD_SHIBBOLETH_SUPPORT) +target_link_libraries(seafile-applet Qt5::${WEBKIT_NAME} Qt5::${WEBKIT_WIDGETS_NAME}) +ENDIF() + +## QtBus +IF (${CMAKE_SYSTEM_NAME} MATCHES "Linux" OR ${CMAKE_SYSTEM_NAME} MATCHES "BSD") + target_link_libraries(seafile-applet Qt5::DBus) +ENDIF() + +### Xcode-related, build as a osx bundle +IF(CMAKE_GENERATOR STREQUAL Xcode) + ADD_DEFINITIONS(-DXCODE_APP) + SET_TARGET_PROPERTIES(seafile-applet PROPERTIES + MACOSX_BUNDLE true + MACOSX_BUNDLE_INFO_PLIST ${CMAKE_CURRENT_SOURCE_DIR}/Info.plist + ) + FIND_PROGRAM(seaf-daemon seaf-daemon) + SET(RESOURCES_DIR ${CMAKE_CURRENT_BINARY_DIR}/\${CONFIGURATION}/seafile-applet.app/Contents/Resources) + ADD_CUSTOM_COMMAND(TARGET seafile-applet + POST_BUILD + COMMAND ${CMAKE_COMMAND} -E make_directory ${RESOURCES_DIR} + COMMAND ${CMAKE_COMMAND} -E copy seafile.icns ${RESOURCES_DIR}/. + COMMAND ${CMAKE_COMMAND} -E copy ${seaf-daemon} ${RESOURCES_DIR}/. + ) + SET(CMAKE_XCODE_ATTRIBUTE_GCC_GENERATE_DEBUGGING_SYMBOLS "YES") + SET(CMAKE_XCODE_ATTRIBUTE_DEBUG_INFORMATION_FORMAT "dwarf-with-dsym") + SET(CMAKE_XCODE_ATTRIBUTE_GCC_ENABLE_PASCAL_STRINGS "NO") + SET(CMAKE_XCODE_ATTRIBUTE_CLANG_ENABLE_OBJC_ARC "YES") + SET(CMAKE_XCODE_ATTRIBUTE_ENABLE_HARDENED_RUNTIME "TRUE") +ENDIF() + +SET(ARCHIVE_NAME ${CMAKE_PROJECT_NAME}-${PROJECT_VERSION}) +ADD_CUSTOM_TARGET(dist + COMMAND ${git_executable} archive -v --prefix=${ARCHIVE_NAME}/ HEAD + | gzip > ${CMAKE_BINARY_DIR}/${ARCHIVE_NAME}.tar.gz + WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}) + +### Test related +IF (BUILD_TESTING) + MACRO(ADD_QTEST testname) + QT5_WRAP_CPP(${testname}_MOCHEADER tests/${testname}.h) + + SET(${testname}_SRCS tests/${testname}.cpp ${${testname}_MOCHEADER}) + + ADD_EXECUTABLE(${testname} ${${testname}_SRCS}) + + TARGET_LINK_LIBRARIES(${testname} ${QT_LIBRARIES} + ${QTESTLIB} ${SQLITE3_LIBRARIES} ${JANSSON_LIBRARIES} + ${EXTRA_LIBS} -lglib-2.0 ${SC_LIBS} ${ZLIB_LIBRARIES}) + SET_TARGET_PROPERTIES(${testname} PROPERTIES + RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tests ) + + INCLUDE_DIRECTORIES(${Qt5Test_INCLUDE_DIRS}) + + QT5_USE_MODULES(${testname} ${USE_QT_LIBRARIES} Test) + + ADD_TEST(${testname} ${CMAKE_CURRENT_BINARY_DIR}/tests/${testname}) + + ENDMACRO(ADD_QTEST) + + ENABLE_TESTING() + INCLUDE_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR}/tests) + ADD_QTEST(test_server-info) + ADD_QTEST(test_utils) + ADD_QTEST(test_file-utils) + ADD_QTEST(test_stl) +ENDIF() diff --git a/Doxyfile.in b/Doxyfile.in new file mode 100644 index 0000000..328c439 --- /dev/null +++ b/Doxyfile.in @@ -0,0 +1,2351 @@ +# Doxyfile 1.8.8 + +# 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 http://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 = "Seafile Client" + +# 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 = @PACKAGE_VERSION@ + +# 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 = + +# With the PROJECT_LOGO tag one can specify an logo or 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 = @CMAKE_CURRENT_SOURCE_DIR/seafile.ico + +# 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 = @CMAKE_CURRENT_BINARY_DIR@/docs + +# 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 = + +# 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 = NO + +# 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 = NO + +# 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 = 4 + +# 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. + +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 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 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: +# http://www.riverbankcomputing.co.uk/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 = 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. When 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 = NO + +# 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 = NO + +# 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 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 = YES + +# 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 = YES + +# 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 = YES + +# 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 = YES + +# 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 http://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 + +# 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. +# Note: If this tag is empty the current directory is searched. + +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src \ + @CMAKE_CURRENT_SOURCE_DIR@/README.md + +# 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: http://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. 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, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# 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 = + +# 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 = + +# 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. + +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. + +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 http://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 = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# 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 = . + +# 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 therefor more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra stylesheet files is of importance (e.g. the last +# stylesheet 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 = + +# 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 stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://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 NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = 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: http://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 http://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 = "Doxygen 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 = org.doxygen.Project + +# 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 = org.doxygen.Publisher + +# 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 = Publisher + +# 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://qt-project.org/doc/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.seafile.seafile-applet + +# 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://qt-project.org/doc/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://qt-project.org/doc/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://qt-project.org/doc/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://qt-project.org/doc/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 = org.doxygen.Project + +# 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 = NO + +# 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 stylesheets (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 = NO + +# 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 = 250 + +# When 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_TRANPARENT 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 +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered 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 http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# 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 +# , /