From 2598a13fa124e6958b0e9c2b1bb4090233e3787b Mon Sep 17 00:00:00 2001 From: Seonah Moon Date: Thu, 8 Apr 2021 11:10:03 +0900 Subject: [PATCH 2/8] Release Vine 1.0.0 Change-Id: I61c273b544eec559ce155165d0525ce47c212ece --- CMakeLists.txt | 122 + LICENSE | 203 ++ README.md | 44 + build.sh | 138 ++ doxygen.conf | 2494 ++++++++++++++++++++ include/CMakeLists.txt | 19 + include/vine.h | 1353 +++++++++++ packaging/vine.manifest | 5 + packaging/vine.spec | 161 ++ pkgconfig/CMakeLists.txt | 28 + pkgconfig/vine.pc.in | 13 + plugins/dns-sd/CMakeLists.txt | 61 + plugins/dns-sd/dns-sd-plugin.cpp | 627 +++++ plugins/dns-sd/dns-sd-plugin.h | 22 + plugins/libwebsockets/CMakeLists.txt | 110 + plugins/libwebsockets/libwebsockets-plugin.cpp | 860 +++++++ plugins/libwebsockets/libwebsockets-plugin.h | 21 + .../tizen/remote-camera/remote-camera/.exportMap | 5 + .../remote-camera/.sign/.manifest.tmp | 8 + .../remote-camera/.sign/author-signature.xml | 70 + .../remote-camera/.sign/signature1.xml | 74 + samples/tizen/remote-camera/remote-camera/build.sh | 33 + .../remote-camera/inc/remote-camera.h | 32 + .../remote-camera/remote-camera/inc/vine-server.h | 8 + .../remote-camera/remote-camera/project_def.prop | 11 + .../remote-camera/shared/res/remote-camera.png | Bin 0 -> 57662 bytes .../remote-camera/src/remote-camera.c | 374 +++ .../remote-camera/remote-camera/src/vine-server.c | 130 + .../remote-camera/remote-camera/tizen-manifest.xml | 14 + .../tizen/remote-camera/taptap-shutter/.exportMap | 5 + .../taptap-shutter/.sign/.manifest.tmp | 10 + .../taptap-shutter/.sign/author-signature.xml | 75 + .../taptap-shutter/.sign/signature1.xml | 79 + .../tizen/remote-camera/taptap-shutter/build.sh | 33 + .../taptap-shutter/inc/taptap-shutter.h | 29 + .../remote-camera/taptap-shutter/inc/vine-client.h | 10 + .../remote-camera/taptap-shutter/project_def.prop | 11 + .../remote-camera/taptap-shutter/res/shutter.png | Bin 0 -> 6896 bytes .../taptap-shutter/shared/res/taptap-shutter.png | Bin 0 -> 57662 bytes .../taptap-shutter/src/taptap-shutter.c | 201 ++ .../remote-camera/taptap-shutter/src/vine-client.c | 152 ++ .../taptap-shutter/tizen-manifest.xml | 14 + src/CMakeLists.txt | 42 + src/include/vine-auth.h | 42 + src/include/vine-constants.h | 32 + src/include/vine-data-path-plugin.h | 107 + src/include/vine-data-path-state.h | 253 ++ src/include/vine-data-path.h | 75 + src/include/vine-disc-plugin.h | 77 + src/include/vine-disc.h | 61 + src/include/vine-dp.h | 253 ++ src/include/vine-event-loop.h | 61 + src/include/vine-private.h | 24 + src/include/vine-queue.h | 68 + src/include/vine-security.h | 42 + src/include/vine-service.h | 73 + src/include/vine-session.h | 56 + src/include/vine-timer.h | 45 + src/include/vine-utils.h | 79 + src/logger/CMakeLists.txt | 32 + src/logger/vine-log.c | 133 ++ src/logger/vine-log.h | 82 + src/vine-auth.cpp | 66 + src/vine-data-path-state.cpp | 766 ++++++ src/vine-data-path.cpp | 731 ++++++ src/vine-disc.cpp | 684 ++++++ src/vine-dp.cpp | 1236 ++++++++++ src/vine-event-loop.cpp | 302 +++ src/vine-private.cpp | 127 + src/vine-security.cpp | 253 ++ src/vine-service.cpp | 369 +++ src/vine-session.cpp | 456 ++++ src/vine-timer.cpp | 97 + src/vine-utils.cpp | 48 + src/vine.cpp | 601 +++++ tests/unittest/CMakeLists.txt | 60 + .../unittest/mocks/vine-mock-data-path-plugin.cpp | 150 ++ tests/unittest/mocks/vine-mock-data-path-plugin.h | 29 + tests/unittest/mocks/vine-mock-dl.cpp | 73 + tests/unittest/mocks/vine-mock-dl.h | 32 + tests/unittest/mocks/vine-mock-dns-sd.cpp | 109 + tests/unittest/mocks/vine-mock-dns-sd.h | 29 + tests/unittest/mocks/vine-mock-memory.cpp | 54 + tests/unittest/mocks/vine-mock-memory.h | 29 + tests/unittest/mocks/vine-mock.cpp | 25 + tests/unittest/vine-unittest-capabilities.cpp | 50 + tests/unittest/vine-unittest-dp.cpp | 362 +++ tests/unittest/vine-unittest-init.cpp | 48 + tests/unittest/vine-unittest-log.cpp | 57 + tests/unittest/vine-unittest-main.cpp | 36 + tests/unittest/vine-unittest-security.cpp | 301 +++ tests/unittest/vine-unittest-service.cpp | 253 ++ tests/unittest/vine-unittest-session.cpp | 171 ++ tests/unittest/vine-unittest-utils.cpp | 60 + tests/unittest/vine-unittest-utils.h | 31 + tests/verifier/CMakeLists.txt | 44 + tests/verifier/certs/rootCA/ca.pem | 18 + tests/verifier/certs/server/test-server.key | 27 + tests/verifier/certs/server/test-server.pem | 19 + tests/verifier/vine-verifier.cpp | 606 +++++ tests/vine-test/CMakeLists.txt | 39 + tests/vine-test/certs/create-test-certs.sh | 42 + tests/vine-test/certs/custom-cert.cnf | 57 + tests/vine-test/vine-multi-thread-test.cpp | 288 +++ tests/vine-test/vine-test.cpp | 904 +++++++ third-party/libwebsockets-4.0-stable.tar.gz | Bin 0 -> 12385094 bytes third-party/prebuilt/README.md | 16 + third-party/prebuilt/android/README.md | 4 + .../prebuilt/android/arm64-v8a/libwebsockets.a | Bin 0 -> 5306516 bytes .../prebuilt/android/arm64-v8a/lws_config.h | 177 ++ .../prebuilt/android/armeabi-v7a/libwebsockets.a | Bin 0 -> 4790332 bytes .../prebuilt/android/armeabi-v7a/lws_config.h | 177 ++ third-party/prebuilt/default/README.md | 4 + .../prebuilt/default/x86_64/libwebsockets.a | Bin 0 -> 6562764 bytes third-party/prebuilt/default/x86_64/lws_config.h | 177 ++ third-party/prebuilt/include/libwebsockets.h | 616 +++++ .../include/libwebsockets/abstract/abstract.h | 138 ++ .../include/libwebsockets/abstract/protocols.h | 88 + .../libwebsockets/abstract/protocols/smtp.h | 115 + .../include/libwebsockets/abstract/transports.h | 65 + .../libwebsockets/abstract/transports/raw-skt.h | 29 + .../libwebsockets/abstract/transports/unit-test.h | 81 + .../prebuilt/include/libwebsockets/lws-adopt.h | 233 ++ .../prebuilt/include/libwebsockets/lws-async-dns.h | 85 + .../prebuilt/include/libwebsockets/lws-callbacks.h | 888 +++++++ .../prebuilt/include/libwebsockets/lws-cgi.h | 104 + .../prebuilt/include/libwebsockets/lws-client.h | 323 +++ .../include/libwebsockets/lws-context-vhost.h | 1136 +++++++++ .../prebuilt/include/libwebsockets/lws-dbus.h | 94 + .../include/libwebsockets/lws-detailed-latency.h | 140 ++ .../prebuilt/include/libwebsockets/lws-diskcache.h | 187 ++ .../prebuilt/include/libwebsockets/lws-dll2.h | 341 +++ .../prebuilt/include/libwebsockets/lws-dsh.h | 145 ++ .../prebuilt/include/libwebsockets/lws-esp32.h | 151 ++ .../prebuilt/include/libwebsockets/lws-freertos.h | 77 + .../prebuilt/include/libwebsockets/lws-fts.h | 215 ++ .../prebuilt/include/libwebsockets/lws-genaes.h | 170 ++ .../prebuilt/include/libwebsockets/lws-gencrypto.h | 130 + .../prebuilt/include/libwebsockets/lws-genec.h | 211 ++ .../prebuilt/include/libwebsockets/lws-genhash.h | 180 ++ .../prebuilt/include/libwebsockets/lws-genrsa.h | 254 ++ .../prebuilt/include/libwebsockets/lws-http.h | 898 +++++++ .../prebuilt/include/libwebsockets/lws-jose.h | 212 ++ .../prebuilt/include/libwebsockets/lws-jwe.h | 164 ++ .../prebuilt/include/libwebsockets/lws-jwk.h | 218 ++ .../prebuilt/include/libwebsockets/lws-jws.h | 405 ++++ .../prebuilt/include/libwebsockets/lws-lejp.h | 299 +++ .../prebuilt/include/libwebsockets/lws-logs.h | 302 +++ .../prebuilt/include/libwebsockets/lws-lwsac.h | 290 +++ .../prebuilt/include/libwebsockets/lws-misc.h | 899 +++++++ .../prebuilt/include/libwebsockets/lws-mqtt.h | 330 +++ .../include/libwebsockets/lws-network-helper.h | 189 ++ .../prebuilt/include/libwebsockets/lws-optee.h | 77 + .../libwebsockets/lws-plugin-generic-sessions.h | 75 + .../include/libwebsockets/lws-protocols-plugins.h | 229 ++ .../prebuilt/include/libwebsockets/lws-purify.h | 105 + .../prebuilt/include/libwebsockets/lws-retry.h | 95 + .../prebuilt/include/libwebsockets/lws-ring.h | 306 +++ .../libwebsockets/lws-secure-streams-client.h | 172 ++ .../libwebsockets/lws-secure-streams-policy.h | 246 ++ .../include/libwebsockets/lws-secure-streams.h | 492 ++++ .../prebuilt/include/libwebsockets/lws-sequencer.h | 241 ++ .../prebuilt/include/libwebsockets/lws-service.h | 200 ++ .../include/libwebsockets/lws-sha1-base64.h | 109 + .../prebuilt/include/libwebsockets/lws-spa.h | 176 ++ .../prebuilt/include/libwebsockets/lws-state.h | 109 + .../prebuilt/include/libwebsockets/lws-stats.h | 81 + .../prebuilt/include/libwebsockets/lws-struct.h | 266 +++ .../prebuilt/include/libwebsockets/lws-system.h | 259 ++ .../include/libwebsockets/lws-test-sequencer.h | 61 + .../include/libwebsockets/lws-threadpool.h | 232 ++ .../include/libwebsockets/lws-timeout-timer.h | 266 +++ .../prebuilt/include/libwebsockets/lws-tokenize.h | 243 ++ .../prebuilt/include/libwebsockets/lws-vfs.h | 273 +++ .../prebuilt/include/libwebsockets/lws-write.h | 264 +++ .../prebuilt/include/libwebsockets/lws-writeable.h | 246 ++ .../prebuilt/include/libwebsockets/lws-ws-close.h | 125 + .../prebuilt/include/libwebsockets/lws-ws-ext.h | 198 ++ .../prebuilt/include/libwebsockets/lws-ws-state.h | 93 + .../prebuilt/include/libwebsockets/lws-x509.h | 279 +++ third-party/prebuilt/include/lws_config.h | 177 ++ third-party/prebuilt/tizen/README.md | 4 + third-party/prebuilt/tizen/aarch64/libwebsockets.a | Bin 0 -> 8041076 bytes third-party/prebuilt/tizen/armv7l/libwebsockets.a | Bin 0 -> 5650368 bytes third-party/prebuilt/tizen/i686/libwebsockets.a | Bin 0 -> 3725890 bytes third-party/prebuilt/tizen/x86_64/libwebsockets.a | Bin 0 -> 5502884 bytes tool/CMakeLists.txt | 37 + tool/tool_config.cpp | 283 +++ tool/tool_config.h | 55 + tool/tool_help.cpp | 80 + tool/tool_help.h | 1 + tool/tool_main.cpp | 36 + tool/tool_parse.cpp | 125 + tool/tool_parse.h | 1 + tool/tool_run.cpp | 538 +++++ tool/tool_run.h | 1 + 196 files changed, 36848 insertions(+) create mode 100755 CMakeLists.txt create mode 100755 LICENSE create mode 100755 README.md create mode 100755 build.sh create mode 100644 doxygen.conf create mode 100755 include/CMakeLists.txt create mode 100755 include/vine.h create mode 100755 packaging/vine.manifest create mode 100755 packaging/vine.spec create mode 100755 pkgconfig/CMakeLists.txt create mode 100755 pkgconfig/vine.pc.in create mode 100755 plugins/dns-sd/CMakeLists.txt create mode 100755 plugins/dns-sd/dns-sd-plugin.cpp create mode 100755 plugins/dns-sd/dns-sd-plugin.h create mode 100755 plugins/libwebsockets/CMakeLists.txt create mode 100755 plugins/libwebsockets/libwebsockets-plugin.cpp create mode 100755 plugins/libwebsockets/libwebsockets-plugin.h create mode 100644 samples/tizen/remote-camera/remote-camera/.exportMap create mode 100644 samples/tizen/remote-camera/remote-camera/.sign/.manifest.tmp create mode 100644 samples/tizen/remote-camera/remote-camera/.sign/author-signature.xml create mode 100644 samples/tizen/remote-camera/remote-camera/.sign/signature1.xml create mode 100755 samples/tizen/remote-camera/remote-camera/build.sh create mode 100644 samples/tizen/remote-camera/remote-camera/inc/remote-camera.h create mode 100644 samples/tizen/remote-camera/remote-camera/inc/vine-server.h create mode 100644 samples/tizen/remote-camera/remote-camera/project_def.prop create mode 100644 samples/tizen/remote-camera/remote-camera/shared/res/remote-camera.png create mode 100644 samples/tizen/remote-camera/remote-camera/src/remote-camera.c create mode 100644 samples/tizen/remote-camera/remote-camera/src/vine-server.c create mode 100644 samples/tizen/remote-camera/remote-camera/tizen-manifest.xml create mode 100644 samples/tizen/remote-camera/taptap-shutter/.exportMap create mode 100644 samples/tizen/remote-camera/taptap-shutter/.sign/.manifest.tmp create mode 100644 samples/tizen/remote-camera/taptap-shutter/.sign/author-signature.xml create mode 100644 samples/tizen/remote-camera/taptap-shutter/.sign/signature1.xml create mode 100755 samples/tizen/remote-camera/taptap-shutter/build.sh create mode 100644 samples/tizen/remote-camera/taptap-shutter/inc/taptap-shutter.h create mode 100644 samples/tizen/remote-camera/taptap-shutter/inc/vine-client.h create mode 100644 samples/tizen/remote-camera/taptap-shutter/project_def.prop create mode 100644 samples/tizen/remote-camera/taptap-shutter/res/shutter.png create mode 100644 samples/tizen/remote-camera/taptap-shutter/shared/res/taptap-shutter.png create mode 100644 samples/tizen/remote-camera/taptap-shutter/src/taptap-shutter.c create mode 100644 samples/tizen/remote-camera/taptap-shutter/src/vine-client.c create mode 100644 samples/tizen/remote-camera/taptap-shutter/tizen-manifest.xml create mode 100755 src/CMakeLists.txt create mode 100644 src/include/vine-auth.h create mode 100644 src/include/vine-constants.h create mode 100755 src/include/vine-data-path-plugin.h create mode 100644 src/include/vine-data-path-state.h create mode 100755 src/include/vine-data-path.h create mode 100755 src/include/vine-disc-plugin.h create mode 100755 src/include/vine-disc.h create mode 100644 src/include/vine-dp.h create mode 100644 src/include/vine-event-loop.h create mode 100755 src/include/vine-private.h create mode 100755 src/include/vine-queue.h create mode 100755 src/include/vine-security.h create mode 100755 src/include/vine-service.h create mode 100755 src/include/vine-session.h create mode 100644 src/include/vine-timer.h create mode 100755 src/include/vine-utils.h create mode 100755 src/logger/CMakeLists.txt create mode 100755 src/logger/vine-log.c create mode 100755 src/logger/vine-log.h create mode 100644 src/vine-auth.cpp create mode 100644 src/vine-data-path-state.cpp create mode 100755 src/vine-data-path.cpp create mode 100755 src/vine-disc.cpp create mode 100644 src/vine-dp.cpp create mode 100644 src/vine-event-loop.cpp create mode 100755 src/vine-private.cpp create mode 100755 src/vine-security.cpp create mode 100755 src/vine-service.cpp create mode 100755 src/vine-session.cpp create mode 100644 src/vine-timer.cpp create mode 100755 src/vine-utils.cpp create mode 100755 src/vine.cpp create mode 100755 tests/unittest/CMakeLists.txt create mode 100644 tests/unittest/mocks/vine-mock-data-path-plugin.cpp create mode 100644 tests/unittest/mocks/vine-mock-data-path-plugin.h create mode 100644 tests/unittest/mocks/vine-mock-dl.cpp create mode 100644 tests/unittest/mocks/vine-mock-dl.h create mode 100644 tests/unittest/mocks/vine-mock-dns-sd.cpp create mode 100644 tests/unittest/mocks/vine-mock-dns-sd.h create mode 100755 tests/unittest/mocks/vine-mock-memory.cpp create mode 100755 tests/unittest/mocks/vine-mock-memory.h create mode 100755 tests/unittest/mocks/vine-mock.cpp create mode 100755 tests/unittest/vine-unittest-capabilities.cpp create mode 100755 tests/unittest/vine-unittest-dp.cpp create mode 100755 tests/unittest/vine-unittest-init.cpp create mode 100755 tests/unittest/vine-unittest-log.cpp create mode 100755 tests/unittest/vine-unittest-main.cpp create mode 100755 tests/unittest/vine-unittest-security.cpp create mode 100755 tests/unittest/vine-unittest-service.cpp create mode 100755 tests/unittest/vine-unittest-session.cpp create mode 100755 tests/unittest/vine-unittest-utils.cpp create mode 100755 tests/unittest/vine-unittest-utils.h create mode 100755 tests/verifier/CMakeLists.txt create mode 100755 tests/verifier/certs/rootCA/ca.pem create mode 100755 tests/verifier/certs/server/test-server.key create mode 100755 tests/verifier/certs/server/test-server.pem create mode 100644 tests/verifier/vine-verifier.cpp create mode 100755 tests/vine-test/CMakeLists.txt create mode 100755 tests/vine-test/certs/create-test-certs.sh create mode 100644 tests/vine-test/certs/custom-cert.cnf create mode 100644 tests/vine-test/vine-multi-thread-test.cpp create mode 100644 tests/vine-test/vine-test.cpp create mode 100644 third-party/libwebsockets-4.0-stable.tar.gz create mode 100644 third-party/prebuilt/README.md create mode 100644 third-party/prebuilt/android/README.md create mode 100644 third-party/prebuilt/android/arm64-v8a/libwebsockets.a create mode 100644 third-party/prebuilt/android/arm64-v8a/lws_config.h create mode 100644 third-party/prebuilt/android/armeabi-v7a/libwebsockets.a create mode 100644 third-party/prebuilt/android/armeabi-v7a/lws_config.h create mode 100644 third-party/prebuilt/default/README.md create mode 100644 third-party/prebuilt/default/x86_64/libwebsockets.a create mode 100644 third-party/prebuilt/default/x86_64/lws_config.h create mode 100644 third-party/prebuilt/include/libwebsockets.h create mode 100644 third-party/prebuilt/include/libwebsockets/abstract/abstract.h create mode 100644 third-party/prebuilt/include/libwebsockets/abstract/protocols.h create mode 100644 third-party/prebuilt/include/libwebsockets/abstract/protocols/smtp.h create mode 100644 third-party/prebuilt/include/libwebsockets/abstract/transports.h create mode 100644 third-party/prebuilt/include/libwebsockets/abstract/transports/raw-skt.h create mode 100644 third-party/prebuilt/include/libwebsockets/abstract/transports/unit-test.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-adopt.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-async-dns.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-callbacks.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-cgi.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-client.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-context-vhost.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-dbus.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-detailed-latency.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-diskcache.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-dll2.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-dsh.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-esp32.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-freertos.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-fts.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-genaes.h create mode 100755 third-party/prebuilt/include/libwebsockets/lws-gencrypto.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-genec.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-genhash.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-genrsa.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-http.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-jose.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-jwe.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-jwk.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-jws.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-lejp.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-logs.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-lwsac.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-misc.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-mqtt.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-network-helper.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-optee.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-plugin-generic-sessions.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-protocols-plugins.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-purify.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-retry.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-ring.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-secure-streams-client.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-secure-streams-policy.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-secure-streams.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-sequencer.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-service.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-sha1-base64.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-spa.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-state.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-stats.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-struct.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-system.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-test-sequencer.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-threadpool.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-timeout-timer.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-tokenize.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-vfs.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-write.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-writeable.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-ws-close.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-ws-ext.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-ws-state.h create mode 100644 third-party/prebuilt/include/libwebsockets/lws-x509.h create mode 100644 third-party/prebuilt/include/lws_config.h create mode 100644 third-party/prebuilt/tizen/README.md create mode 100644 third-party/prebuilt/tizen/aarch64/libwebsockets.a create mode 100644 third-party/prebuilt/tizen/armv7l/libwebsockets.a create mode 100644 third-party/prebuilt/tizen/i686/libwebsockets.a create mode 100644 third-party/prebuilt/tizen/x86_64/libwebsockets.a create mode 100755 tool/CMakeLists.txt create mode 100644 tool/tool_config.cpp create mode 100644 tool/tool_config.h create mode 100644 tool/tool_help.cpp create mode 100644 tool/tool_help.h create mode 100644 tool/tool_main.cpp create mode 100644 tool/tool_parse.cpp create mode 100644 tool/tool_parse.h create mode 100644 tool/tool_run.cpp create mode 100644 tool/tool_run.h diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100755 index 0000000..25a04c9 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,122 @@ +# Copyright (c) 2021 Samsung Electronics Co., Ltd All Rights Reserved +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +CMAKE_MINIMUM_REQUIRED(VERSION 2.8.3...3.19.1) + +CMAKE_POLICY(SET CMP0048 NEW) + +SET(fw_name "vine") +PROJECT(${fw_name}) +SET(PACKAGE_DESCRIPTION "Library and header files for Vine Native API") + +SET(VINE_VERSION_MAJOR "1") +SET(VINE_VERSION_MINOR "0") +SET(VINE_VERSION_PATCH "0") +SET(VINE_VERSION ${VINE_VERSION_MAJOR}.${VINE_VERSION_MINOR}.${VINE_VERSION_PATCH}) + +OPTION(USE_LIBWEBSOCKETS "Use libwebsockets for data path" ON) +OPTION(USE_LIBWEBSOCKETS_STATIC "Use libwebsockets static library" ON) +OPTION(USE_LIBWEBSOCKETS_STATIC_PREBUILT "Use prebuilt static library(.a)" ON) +OPTION(WITH_UNITTEST "With unit tests" OFF) +OPTION(WITH_VINE_TEST "With vine command-line test tools" OFF) +OPTION(ENABLE_INSTRUMENTATION_MODE "Enable instrumentation mode" OFF) +OPTION(ENABLE_DATAPATH_PLUGIN_DEBUG "Enable debug mode for data path plugin" OFF) + +INCLUDE(FindPkgConfig) + +SET(BUILD_OS "default") +SET(DEPS "") + +FIND_PROGRAM(UNAME NAMES uname) +EXEC_PROGRAM("${UNAME}" ARGS "-m" OUTPUT_VARIABLE "BUILD_ARCH") + +IF(TIZEN_OS) + SET(BUILD_OS "tizen") + STRING(CONCAT DEPS ${DEPS} "dlog capi-base-common capi-system-info") +ENDIF(TIZEN_OS) + +pkg_check_modules(fw_name_deps REQUIRED ${DEPS}) + +IF(NOT ANDROID) + SET(VINE_DEPS_LIB pthread) +ENDIF(NOT ANDROID) + +FOREACH(flag ${fw_name_deps_CFLAGS}) + SET(EXTRA_CFLAGS "${EXTRA_CFLAGS} ${flag}") +ENDFOREACH(flag) + +IF(ANDROID) + SET(BUILD_OS "android") + SET(BUILD_ARCH ${ANDROID_ABI}) + SET(CMAKE_INSTALL_PREFIX ".") +ENDIF(ANDROID) + +SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${EXTRA_CFLAGS} -fPIC -Wall -g") +SET(CMAKE_C_FLAGS_DEBUG "-O0 -g") +SET(CMAKE_C_FLAGS_RELEASE "-O2 -g") + +# Don't export symbols by default +ADD_DEFINITIONS("-fvisibility=hidden") +IF(TIZEN_OS) + ADD_DEFINITIONS("-DTIZEN_OS -DUSE_DLOG") +ENDIF(TIZEN_OS) + +IF(ENABLE_INSTRUMENTATION_MODE) + SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -finstrument-functions -finstrument-functions-exclude-file-list=src/logger") + ADD_DEFINITIONS("-DENABLE_INSTRUMENTATION_MODE") +ENDIF(ENABLE_INSTRUMENTATION_MODE) + +SET(CMAKE_CXX_FLAGS "${CMAKE_C_FLAGS} -std=c++11") +SET(CMAKE_EXE_LINKER_FLAGS "-Wl,--as-needed -Wl,--rpath=${LIBDIR}") + +SET(TARGET_VINE "vine") +SET(VINE_LOGGER "vine-logger") +SET(VINE_PATH ${PROJECT_SOURCE_DIR}/src) +SET(VINE_LOGGER_PATH ${PROJECT_SOURCE_DIR}/src/logger) + +IF(USE_LIBWEBSOCKETS_STATIC) +IF(NOT USE_LIBWEBSOCKETS_STATIC_PREBUILT) + SET(LWS_WITH_STATIC ON CACHE BOOL "" FORCE) + SET(LWS_WITH_SHARED OFF CACHE BOOL "" FORCE) + SET(LWS_WITH_EXTERNAL_POLL ON CACHE BOOL "" FORCE) + SET(LWS_IPV6 ON CACHE BOOL "" FORCE) + SET(LWS_WITHOUT_TESTAPPS ON CACHE BOOL "" FORCE) + SET(LWS_WITH_VINE_EXT ON CACHE BOOL "" FORCE) + ADD_SUBDIRECTORY(third-party/libwebsockets) +ENDIF(NOT USE_LIBWEBSOCKETS_STATIC_PREBUILT) + SET(PREBUILT_THIRD_PARTY_INCLUDE_PATH "${PROJECT_SOURCE_DIR}/third-party/prebuilt/include") +ENDIF(USE_LIBWEBSOCKETS_STATIC) + +IF(USE_LIBWEBSOCKETS) + ADD_DEFINITIONS("-DUSE_LIBWEBSOCKETS") + ADD_SUBDIRECTORY(plugins/libwebsockets) +ENDIF(USE_LIBWEBSOCKETS) + +ADD_SUBDIRECTORY(plugins/dns-sd) + +ADD_SUBDIRECTORY(include) +ADD_SUBDIRECTORY(src/logger) +ADD_SUBDIRECTORY(src) +ADD_SUBDIRECTORY(pkgconfig) +ADD_SUBDIRECTORY(tool) + +IF(WITH_UNITTEST) +ADD_SUBDIRECTORY(tests/unittest) +ENDIF(WITH_UNITTEST) + +IF(WITH_VINE_TEST) +ADD_SUBDIRECTORY(tests/vine-test) +ADD_SUBDIRECTORY(tests/verifier) +ENDIF() diff --git a/LICENSE b/LICENSE new file mode 100755 index 0000000..b8f9c34 --- /dev/null +++ b/LICENSE @@ -0,0 +1,203 @@ +Copyright (c) 2021 Samsung Electronics Co., Ltd. All rights reserved. + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100755 index 0000000..91f36f9 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# vine + +### Preparing to Build (Linux, not Tizen) + +#### mDNSresponder +DNS-SD is used for network service discovery. +Download mDNresponder tarball in https://opensource.apple.com/tarballs/mDNSResponder/ and install it. +The recommended version for Vine is 878.70.2. + +#### libwebsockets +libwebsockets is used for providing client and server. + +Vine provides a prebuilt static library for libwebsockets by default. +Please refer to [third-party/prebuilt](./third-party/prebuilt) directory for details. + +Otherwise, you can use build libwebsockets manually. +Download libwebsockets tarball in https://github.com/warmcat/libwebsockets/releases and install it. +The recommended version for Vine is 3.2.0 or later. + +**NOTE**: Vine uses poll() to handle events. So, You have to set LWS_WITH_EXTERNAL_POLL option. + + cmake . -DLWS_WITH_EXTERNAL_POLL=ON + +#### googlemock (Optional) +You can build with unit tests. +Unit test codes of vine have a dependency on googlemock. +To build unit tests, you have to prepare the googlemock shared library. + +### Build +You have to tell the build system where libvine.so and vine.h is installed. +Use -DLIB_DIR for libvine.so and -DINCLUDE_DIR for vine.h + + cmake . -DLIB_DIR=${LIB_DIR} -DINCLUDE_DIR=${INCLUDE_DIR} + +Use WITH_VINE_TEST to build with vine test programs. +You have to tell the build system where the executables (vine-test) is installed. +Use -DBIN_DIR for the executables. + + cmake . -DLIB_DIR=${LIB_DIR} -DINCLUDE_DIR=${INCLUDE_DIR} -DBIN_DIR=${BIN_DIR} -DWITH_VINE_TEST + +Use WITH_UNITTEST to build with unit tests. + + cmake . -DLIB_DIR=${LIB_DIR} -DINCLUDE_DIR=${INCLUDE_DIR} -DWITH_UNITTEST=ON + diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..a7692e9 --- /dev/null +++ b/build.sh @@ -0,0 +1,138 @@ +#!/bin/bash +BUILD_DIR="build" + +function clean { + echo "Clean build directory" + rm -rf $BUILD_DIR +} + +function build { + echo "Build vine library" + cd $BUILD_DIR + cmake .. -DLIB_DIR=/usr/lib -DINCLUDE_DIR=/usr/include -DBIN_DIR=/usr/bin \ + -DWITH_UNITTEST=ON -DWITH_VINE_TEST=ON $1 $2 + make + sudo make install + cd .. +} + +function unittest { + echo "Test vine library" + ./$BUILD_DIR/tests/unittest/vine-unittest $1 +} + +function coding_rule { + git clone git@github.sec.samsung.net:RS-SA/coding-style-guides.git + chmod 777 ./coding-style-guides/c/*.sh ./coding-style-guides/c/*.pl + result_src+="$((`./coding-style-guides/c/checkpatchinit_tizen.sh src| tee /dev/tty | grep total | awk '{ sum+=$2+$4 }; END { print sum }'`))" + result_include+="$((`./coding-style-guides/c/checkpatchinit_tizen.sh include| tee /dev/tty | grep total | awk '{ sum+=$2+$4 }; END { print sum }'`))" + result_plugins+="$((`./coding-style-guides/c/checkpatchinit_tizen.sh plugins| tee /dev/tty | grep total | awk '{ sum+=$2+$4 }; END { print sum }'`))" + result=$(( $result_src + $result_include + $result_plugins )) + echo "result $result" + if [ "${result}" -gt "0" ]; then + exit 1 + fi +} + +function install_certs { + echo "Installs test certificates" + cd $BUILD_DIR + cp -rf ../tests/vine-test/certs ./tests/vine-test/certs + cd tests/vine-test/certs + ./create-test-certs.sh + cd ../ +} + +MINSDKVERSION=24 + +#NDK_ROOT and NDK_DEP_ROOT_DIR should be defined. +#NDK_ROOT=/home/moon/Works/Devel/Vine/android-ndk-r21b +#NDK_DEP_ROOT_DIR=/home/moon/Works/Devel/Vine/ndk-deps + +#Libraries that vine depends on should be located in a directory for each ABI. +#If you want to build for arm64-v8a ABI, libraries should be located in $NDK_DEP_ROOT_DIR/lib/arm64-v8a +#ABI: armeabi-v7a, arm64-v8a, x86, x86-64 + +OUTPUT_DIR=artifacts + +function build_android { + ABI=$1 + OUTPUT_LIB=$OUTPUT_DIR/lib/$ABI + OUTPUT_INC=$OUTPUT_DIR/include + OUTPUT_BIN=$OUTPUT_DIR/bin/$ABI + NDK_DEP_LIB=$NDK_DEP_ROOT_DIR/lib/$ABI + NDK_DEP_INC=$NDK_DEP_ROOT_DIR/include + + echo "Build vine library (ABI=$ABI)" + echo "NDK_PATH $NDK_ROOT" + cd $BUILD_DIR + mkdir -p $OUTPUT_LIB + mkdir -p $OUTPUT_INC + mkdir -p $OUTPUT_BIN + cmake .. \ + -DCMAKE_TOOLCHAIN_FILE=$NDK_ROOT/build/cmake/android.toolchain.cmake \ + -DANDROID_ABI=$ABI \ + -DANDROID_NATIVE_API_LEVEL=$MINSDKVERSION \ + -DANDROID_STL=c++_static \ + -DANDROID=ON -DANDROID_NDK=$NDK_ROOT \ + -DNDK_LIB_DIR=$NDK_DEP_LIB -DNDK_INCLUDE_DIR=$NDK_DEP_INC \ + -DLIB_DIR=$OUTPUT_LIB -DINCLUDE_DIR=$OUTPUT_INC -DBIN_DIR=$OUTPUT_BIN \ + -DWITH_UNITTEST=ON -DWITH_VINE_TEST=ON \ + -DLWS_OPENSSL_INCLUDE_DIRS=$NDK_INCLUDE_DIR \ + -DLWS_OPENSSL_LIBRARIES="$NDK_DEP_LIB/libcrypto.so;$NDK_DEP_LIB/libssl.so" + make + make install + cd .. +} + +if [ ! -d "$BUILD_DIR" ]; then + mkdir -p $BUILD_DIR +fi + +if [ $# -eq 0 ] +then + build +fi + +if [ $# -eq 1 ] +then +case $1 in + "clean") + clean + ;; + "build") + build + ;; + "test") + unittest + ;; + "test_log") + unittest -d + ;; + "check") + coding_rule + ;; + "debug") + build -DENABLE_DATAPATH_PLUGIN_DEBUG=ON -DENABLE_INSTRUMENTATION_MODE=ON + ;; + "doxygen") + doxygen doxygen.conf + ;; + "install_certs") + install_certs + ;; + "android") + build_android arm64-v8a + ;; +esac +fi + +if [ $# -eq 2 ] +then + case $1 in + "android") + build_android $2 + ;; + esac +fi + diff --git a/doxygen.conf b/doxygen.conf new file mode 100644 index 0000000..7c5f749 --- /dev/null +++ b/doxygen.conf @@ -0,0 +1,2494 @@ +# Doxyfile 1.8.13 + +# 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 = "Vine" + +# 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 = + +# 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 a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# 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 = build_doc + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = 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 += since_tizen="\par Tizen Version:\n" + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# 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 + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = 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 = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = 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 + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = include/vine.h + +# 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. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# 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. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see 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 +# generated with the -Duse-libclang=ON option for CMake. +# 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 = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# 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 YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_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 = org.doxygen.Project + +# 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 style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = 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 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_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 pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from 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 +# , /