1
=== modified file '.bzrignore'
2
--- .bzrignore	2016-07-14 03:26:20 +0000
3
+++ .bzrignore	2016-11-29 04:47:53 +0000
4
@@ -1,2 +1,4 @@
5
1
.idea
1
.idea
6
2
.project
7
2
include/server/mir/version.h
3
include/server/mir/version.h
8
4
build-*
9
3
5
10
=== removed file '3rd_party/android-input/android/frameworks/base/include/androidfw/GenericKeyMap.h'
11
--- 3rd_party/android-input/android/frameworks/base/include/androidfw/GenericKeyMap.h	2012-11-13 11:17:46 +0000
12
+++ 3rd_party/android-input/android/frameworks/base/include/androidfw/GenericKeyMap.h	1970-01-01 00:00:00 +0000
13
@@ -1,36 +0,0 @@
14
1
// Copyright (C) 2010 The Android Open Source Project
15
2
//
16
3
// Licensed under the Apache License, Version 2.0 (the "License");
17
4
// you may not use this file except in compliance with the License.
18
5
// You may obtain a copy of the License at
19
6
//
20
7
//      http://www.apache.org/licenses/LICENSE-2.0
21
8
//
22
9
// Unless required by applicable law or agreed to in writing, software
23
10
// distributed under the License is distributed on an "AS IS" BASIS,
24
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25
12
// See the License for the specific language governing permissions and
26
13
// limitations under the License.
27
14
//
28
15
29
16
// Generic key layout file for full alphabetic US English PC style
30
17
// external keyboards.  This file is intentionally very generic and is
31
18
// intended to support a broad rang of keyboards.  Do not edit the
32
19
// generic key layout to support a specific keyboard; instead, create
33
20
// a new key layout file with the required keyboard configuration.
34
21
// Taken from android source tree Generic.kl and Generic.kcm
35
22
36
23
#ifndef GENERIC_KEY_MAP_H_
37
24
#define GENERIC_KEY_MAP_H_
38
25
39
26
namespace android
40
27
{
41
28
struct GenericKeyMap
42
29
{
43
30
    static const char* key_layout_contents();
44
31
45
32
    static const char* keymap_contents();
46
33
};
47
34
}
48
35
49
36
#endif // GENERIC_KEY_MAP_H_
50
37
0
51
=== modified file 'CMakeLists.txt'
52
--- CMakeLists.txt	2016-09-26 07:56:51 +0000
53
+++ CMakeLists.txt	2016-11-29 04:47:53 +0000
54
@@ -28,8 +28,8 @@
55
28
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
28
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
56
29
29
57
30
set(MIR_VERSION_MAJOR 0)
30
set(MIR_VERSION_MAJOR 0)
60
31
set(MIR_VERSION_MINOR 24)
31
set(MIR_VERSION_MINOR 25)
61
32
set(MIR_VERSION_PATCH 1)
32
set(MIR_VERSION_PATCH 0)
62
33
33
63
34
add_definitions(-DMIR_VERSION_MAJOR=${MIR_VERSION_MAJOR})
34
add_definitions(-DMIR_VERSION_MAJOR=${MIR_VERSION_MAJOR})
64
35
add_definitions(-DMIR_VERSION_MINOR=${MIR_VERSION_MINOR})
35
add_definitions(-DMIR_VERSION_MINOR=${MIR_VERSION_MINOR})
65
@@ -66,19 +66,20 @@
66
66
set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -Wl,--as-needed")
66
set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -Wl,--as-needed")
67
67
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--as-needed")
67
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--as-needed")
68
68
68
69
69
include(CheckCXXCompilerFlag)
70
70
check_cxx_compiler_flag(-Wmismatched-tags HAS_W_MISMATCHED_TAGS)
71
71
72
72
if(HAS_W_MISMATCHED_TAGS)
73
73
  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-mismatched-tags")
74
74
endif()
75
75
76
69
option(MIR_USE_LD_GOLD "Enables the \"gold\" linker." OFF)
76
option(MIR_USE_LD_GOLD "Enables the \"gold\" linker." OFF)
77
70
if(MIR_USE_LD_GOLD)
77
if(MIR_USE_LD_GOLD)
78
71
  set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fuse-ld=gold")
79
72
  set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fuse-ld=gold")
80
73
  set (CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -fuse-ld=gold")
78
  set (CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -fuse-ld=gold")
81
74
  set (CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -fuse-ld=gold")
79
  set (CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -fuse-ld=gold")
82
75
  set (CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fuse-ld=gold")
80
  set (CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fuse-ld=gold")
83
76
endif()
81
endif()
84
77
82
85
78
if ("${CMAKE_CXX_COMPILER}" MATCHES "clang")
86
79
  set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-return-type-c-linkage -Wno-mismatched-tags")
87
80
endif()
88
81
89
82
# Link time optimization allows leaner, cleaner libraries
83
# Link time optimization allows leaner, cleaner libraries
90
83
message(STATUS "CMAKE_C_COMPILER: " ${CMAKE_C_COMPILER})
84
message(STATUS "CMAKE_C_COMPILER: " ${CMAKE_C_COMPILER})
91
84
85
92
@@ -141,6 +142,7 @@
93
141
142
94
142
enable_testing()
143
enable_testing()
95
143
144
96
145
include_directories(include/core)
97
144
include_directories(include/common)
146
include_directories(include/common)
98
145
include_directories(include/cookie)
147
include_directories(include/cookie)
99
146
148
100
@@ -195,6 +197,7 @@
101
195
find_package(GLESv2 REQUIRED)
197
find_package(GLESv2 REQUIRED)
102
196
find_package(GLM REQUIRED)
198
find_package(GLM REQUIRED)
103
197
find_package(Protobuf REQUIRED )
199
find_package(Protobuf REQUIRED )
104
200
find_package(CapnProto REQUIRED)
105
198
find_package(GLog REQUIRED)
201
find_package(GLog REQUIRED)
106
199
find_package(GFlags REQUIRED)
202
find_package(GFlags REQUIRED)
107
200
find_package(LTTngUST REQUIRED)
203
find_package(LTTngUST REQUIRED)
108
@@ -207,9 +210,11 @@
109
207
210
110
208
#
211
#
111
209
# Full OpenGL support is possibly complete but not yet perfect. So is
212
# Full OpenGL support is possibly complete but not yet perfect. So is
115
210
# presently disabled by default. See the TODOs in:
213
# presently disabled by default due to:
116
211
#   src/platform/graphics/egl_extensions.cpp: glEGLImageTargetTexture2DOES
214
#   1. Black windows bug: https://bugs.freedesktop.org/show_bug.cgi?id=92265
117
212
#   src/platforms/common/server/shm_buffer.cpp: glTexImage2D
215
#   2. Use of glEGLImageTargetTexture2DOES in:
118
216
#        src/platform/graphics/egl_extensions.cpp
119
217
#      possibly shouldn't work even though it does. Or should it?
120
213
#
218
#
121
214
#if (TARGET_ARCH STREQUAL "x86_64-linux-gnu" OR
219
#if (TARGET_ARCH STREQUAL "x86_64-linux-gnu" OR
122
215
#    TARGET_ARCH STREQUAL "i386-linux-gnu")
220
#    TARGET_ARCH STREQUAL "i386-linux-gnu")
123
@@ -290,7 +295,7 @@
124
290
295
125
291
  # There's no nice way to format this. Thanks CMake.
296
  # There's no nice way to format this. Thanks CMake.
126
292
  mir_add_test(NAME LGPL-required
297
  mir_add_test(NAME LGPL-required
128
293
    COMMAND /bin/sh -c "! grep -rl 'GNU General' ${PROJECT_SOURCE_DIR}/src/client ${PROJECT_SOURCE_DIR}/include/client ${PROJECT_SOURCE_DIR}/src/common ${PROJECT_SOURCE_DIR}/include/common ${PROJECT_SOURCE_DIR}/src/include/common ${PROJECT_SOURCE_DIR}/src/platform ${PROJECT_SOURCE_DIR}/include/platform ${PROJECT_SOURCE_DIR}/src/include/platform"
298
    COMMAND /bin/sh -c "! grep -rl 'GNU General' ${PROJECT_SOURCE_DIR}/src/client ${PROJECT_SOURCE_DIR}/include/client ${PROJECT_SOURCE_DIR}/src/common ${PROJECT_SOURCE_DIR}/include/common ${PROJECT_SOURCE_DIR}/src/include/common ${PROJECT_SOURCE_DIR}/src/platform ${PROJECT_SOURCE_DIR}/include/platform ${PROJECT_SOURCE_DIR}/src/include/platform ${PROJECT_SOURCE_DIR}/src/capnproto"
129
294
  )
299
  )
130
295
  mir_add_test(NAME GPL-required
300
  mir_add_test(NAME GPL-required
131
296
    COMMAND /bin/sh -c "! grep -rl 'GNU Lesser' ${PROJECT_SOURCE_DIR}/src/server ${PROJECT_SOURCE_DIR}/include/server ${PROJECT_SOURCE_DIR}/src/include/server ${PROJECT_SOURCE_DIR}/tests ${PROJECT_SOURCE_DIR}/examples"
301
    COMMAND /bin/sh -c "! grep -rl 'GNU Lesser' ${PROJECT_SOURCE_DIR}/src/server ${PROJECT_SOURCE_DIR}/include/server ${PROJECT_SOURCE_DIR}/src/include/server ${PROJECT_SOURCE_DIR}/tests ${PROJECT_SOURCE_DIR}/examples"
132
@@ -316,3 +321,9 @@
133
316
mir_check_no_unreleased_symbols(mirplatform release-checks)
321
mir_check_no_unreleased_symbols(mirplatform release-checks)
134
317
mir_check_no_unreleased_symbols(mirprotobuf release-checks)
322
mir_check_no_unreleased_symbols(mirprotobuf release-checks)
135
318
mir_check_no_unreleased_symbols(mirserver release-checks)
323
mir_check_no_unreleased_symbols(mirserver release-checks)
136
324
137
325
if (TARGET doc)
138
326
  add_custom_target(doc-show
139
327
          xdg-open ${CMAKE_BINARY_DIR}/doc/html/index.html
140
328
          DEPENDS doc)
141
329
endif()
142
319
330
143
=== modified file 'benchmarks/frame-uniformity/CMakeLists.txt'
144
--- benchmarks/frame-uniformity/CMakeLists.txt	2016-05-03 06:55:25 +0000
145
+++ benchmarks/frame-uniformity/CMakeLists.txt	2016-11-29 04:47:53 +0000
146
@@ -4,6 +4,8 @@
147
4
  ${PROJECT_SOURCE_DIR}/include/server
4
  ${PROJECT_SOURCE_DIR}/include/server
148
5
  ${PROJECT_SOURCE_DIR}/include/client
5
  ${PROJECT_SOURCE_DIR}/include/client
149
6
  ${PROJECT_SOURCE_DIR}/include/test
6
  ${PROJECT_SOURCE_DIR}/include/test
150
7
  ${PROJECT_SOURCE_DIR}/include/renderers/gl
151
8
  ${PROJECT_SOURCE_DIR}/include/renderers/sw
152
7
9
153
8
  ${PROJECT_SOURCE_DIR}/src/include/server
10
  ${PROJECT_SOURCE_DIR}/src/include/server
154
9
  ${PROJECT_SOURCE_DIR}/src/include/common
11
  ${PROJECT_SOURCE_DIR}/src/include/common
155
10
12
156
=== modified file 'cmake/FindGtestGmock.cmake'
157
--- cmake/FindGtestGmock.cmake	2016-05-03 06:55:25 +0000
158
+++ cmake/FindGtestGmock.cmake	2016-11-29 04:47:53 +0000
159
@@ -1,24 +1,38 @@
160
1
include(ExternalProject)
1
include(ExternalProject)
161
2
include(FindPackageHandleStandardArgs)
2
include(FindPackageHandleStandardArgs)
162
3
3
163
4
if (EXISTS /usr/src/googletest)
164
5
  set (USING_GOOGLETEST_1_8 TRUE)
165
6
  set (GTEST_INSTALL_DIR /usr/src/googletest/googletest/include)
166
7
else()
167
8
  set (GTEST_INSTALL_DIR /usr/src/gmock/gtest/include)
168
9
endif()
169
10
170
4
#gtest
11
#gtest
174
5
set(GTEST_INSTALL_DIR /usr/src/gmock/gtest/include)
12
find_path(
175
6
find_path(GTEST_INCLUDE_DIR gtest/gtest.h
13
  GTEST_INCLUDE_DIR gtest/gtest.h
176
7
            HINTS ${GTEST_INSTALL_DIR})
14
  HINTS ${GTEST_INSTALL_DIR}
177
15
)
178
8
16
179
9
#gmock
17
#gmock
182
10
find_path(GMOCK_INSTALL_DIR gmock/CMakeLists.txt
18
find_path(
183
11
          HINTS /usr/src)
19
  GMOCK_INSTALL_DIR CMakeLists.txt
184
20
  HINTS /usr/src/googletest /usr/src/gmock)
185
12
if(${GMOCK_INSTALL_DIR} STREQUAL "GMOCK_INSTALL_DIR-NOTFOUND")
21
if(${GMOCK_INSTALL_DIR} STREQUAL "GMOCK_INSTALL_DIR-NOTFOUND")
186
13
    message(FATAL_ERROR "google-mock package not found")
22
    message(FATAL_ERROR "google-mock package not found")
187
14
endif()
23
endif()
188
15
24
189
16
set(GMOCK_INSTALL_DIR ${GMOCK_INSTALL_DIR}/gmock)
190
17
find_path(GMOCK_INCLUDE_DIR gmock/gmock.h)
25
find_path(GMOCK_INCLUDE_DIR gmock/gmock.h)
191
18
26
195
19
set(GMOCK_PREFIX gmock)
27
if (USING_GOOGLETEST_1_8)
196
20
set(GMOCK_BINARY_DIR ${CMAKE_BINARY_DIR}/${GMOCK_PREFIX}/libs)
28
  set(GMOCK_BASE_BINARY_DIR ${CMAKE_BINARY_DIR}/gmock/libs)
197
21
set(GTEST_BINARY_DIR ${GMOCK_BINARY_DIR}/gtest)
29
  set(GMOCK_BINARY_DIR ${GMOCK_BASE_BINARY_DIR}/googlemock)
198
30
  set(GTEST_BINARY_DIR ${GMOCK_BINARY_DIR}/gtest)
199
31
else()
200
32
  set(GMOCK_BASE_BINARY_DIR ${CMAKE_BINARY_DIR}/gmock/libs)
201
33
  set(GMOCK_BINARY_DIR ${GMOCK_BASE_BINARY_DIR})
202
34
  set(GTEST_BINARY_DIR ${GMOCK_BINARY_DIR}/gtest)
203
35
endif()
204
22
36
205
23
set(GTEST_CXX_FLAGS "-fPIC -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64")
37
set(GTEST_CXX_FLAGS "-fPIC -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64")
206
24
if (cmake_build_type_lower MATCHES "threadsanitizer")
38
if (cmake_build_type_lower MATCHES "threadsanitizer")
207
@@ -30,6 +44,11 @@
208
30
set(GTEST_CMAKE_ARGS "-DCMAKE_CXX_FLAGS=${GTEST_CXX_FLAGS}")
44
set(GTEST_CMAKE_ARGS "-DCMAKE_CXX_FLAGS=${GTEST_CXX_FLAGS}")
209
31
list(APPEND GTEST_CMAKE_ARGS -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER})
45
list(APPEND GTEST_CMAKE_ARGS -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER})
210
32
list(APPEND GTEST_CMAKE_ARGS -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER})
46
list(APPEND GTEST_CMAKE_ARGS -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER})
211
47
212
48
if (USING_GOOGLETEST_1_8)
213
49
  list(APPEND GTEST_CMAKE_ARGS -DBUILD_GTEST=ON)
214
50
endif()
215
51
216
33
if (cmake_build_type_lower MATCHES "threadsanitizer")
52
if (cmake_build_type_lower MATCHES "threadsanitizer")
217
34
  #Skip compiler check, since if GCC is the compiler, we need to link against -ltsan
53
  #Skip compiler check, since if GCC is the compiler, we need to link against -ltsan
218
35
  #explicitly; specifying additional linker flags doesn't seem possible for external projects
54
  #explicitly; specifying additional linker flags doesn't seem possible for external projects
219
@@ -52,7 +71,7 @@
220
52
    SOURCE_DIR ${GMOCK_INSTALL_DIR}
71
    SOURCE_DIR ${GMOCK_INSTALL_DIR}
221
53
    #forward the compilers to the subproject so cross-arch builds work
72
    #forward the compilers to the subproject so cross-arch builds work
222
54
    CMAKE_ARGS ${GTEST_CMAKE_ARGS}
73
    CMAKE_ARGS ${GTEST_CMAKE_ARGS}
224
55
    BINARY_DIR ${GMOCK_BINARY_DIR}
74
    BINARY_DIR ${GMOCK_BASE_BINARY_DIR}
225
56
75
226
57
    #we don't need to install, so skip
76
    #we don't need to install, so skip
227
58
    INSTALL_COMMAND ""
77
    INSTALL_COMMAND ""
228
59
78
229
=== modified file 'cmake/MirCommon.cmake'
230
--- cmake/MirCommon.cmake	2016-08-09 16:22:39 +0000
231
+++ cmake/MirCommon.cmake	2016-11-29 04:47:53 +0000
232
@@ -301,21 +301,3 @@
233
301
  )
301
  )
234
302
  add_dependencies(${DEPENDENT_TARGET} ${TARGET_NAME})
302
  add_dependencies(${DEPENDENT_TARGET} ${TARGET_NAME})
235
303
endfunction()
303
endfunction()
236
304
237
305
function (mir_add_library_with_symbols TARGET TYPE SYMBOLS_FILE)
238
306
  # Bask in the majesty of CMake!
239
307
  #
240
308
  # You can't just depend on an arbitary file. Oh, no!
241
309
  #
242
310
  # Instead, we add a custom command to generate an empty C++ source
243
311
  # file, depending on the symbols file, and then add that empty C++
244
312
  # source to the library.
245
313
  set(HACK_OUTPUT ${TARGET}_abysmal_hack.cpp)
246
314
247
315
  add_custom_command(OUTPUT ${HACK_OUTPUT}
248
316
    COMMAND touch ${HACK_OUTPUT}
249
317
    DEPENDS ${SYMBOLS_FILE}
250
318
  )
251
319
252
320
  add_library(${TARGET} ${TYPE} ${HACK_OUTPUT} ${ARGN})
253
321
endfunction()
254
322
304
255
=== modified file 'cross-compile-chroot.sh'
256
--- cross-compile-chroot.sh	2016-06-02 05:33:50 +0000
257
+++ cross-compile-chroot.sh	2016-11-29 04:47:53 +0000
258
@@ -104,6 +104,10 @@
259
104
gcc_variant=
104
gcc_variant=
260
105
if [ "${dist}" = "vivid" ]; then
105
if [ "${dist}" = "vivid" ]; then
261
106
    gcc_variant=-4.9
106
    gcc_variant=-4.9
262
107
elif [ "${dist}" = "wily" -o "${dist}" = "xenial"  ]; then
263
108
    gcc_variant=-5
264
109
elif [ "${dist}" = "yakkety" ]; then
265
110
    gcc_variant=-6
266
107
fi
111
fi
267
108
112
268
109
case ${target_arch} in
113
case ${target_arch} in
269
@@ -166,6 +170,7 @@
270
166
    echo "Using PKG_CONFIG_EXECUTABLE: $PKG_CONFIG_EXECUTABLE"
170
    echo "Using PKG_CONFIG_EXECUTABLE: $PKG_CONFIG_EXECUTABLE"
271
167
    cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/LinuxCrossCompile.cmake \
171
    cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/LinuxCrossCompile.cmake \
272
168
      -DMIR_PLATFORM=${mir_platform} -DMIR_ENABLE_TESTS=${enable_tests}\
172
      -DMIR_PLATFORM=${mir_platform} -DMIR_ENABLE_TESTS=${enable_tests}\
273
173
      -DMIR_USE_PRECOMPILED_HEADERS=OFF \
274
169
      .. 
174
      .. 
275
170
175
276
171
    make -j${NUM_JOBS} $@
176
    make -j${NUM_JOBS} $@
277
172
177
278
=== modified file 'debian/changelog'
279
--- debian/changelog	2016-09-28 12:09:49 +0000
280
+++ debian/changelog	2016-11-29 04:47:53 +0000
281
@@ -1,3 +1,106 @@
282
1
mir (0.25.0-0ubuntu1) UNRELEASED; urgency=medium
283
2
284
3
  * New upstream release 0.25.0 (https://launchpad.net/mir/+milestone/0.25.0)
285
4
    - ABI summary:
286
5
      . mirclient ABI unchanged at 9
287
6
      . mirserver ABI bumped to 42
288
7
      . mircommon ABI bumped to 7
289
8
      . mirplatform ABI bumped to 14
290
9
      . mirprotobuf ABI unchanged at 3
291
10
      . mirplatformgraphics ABI bumped to 11
292
11
      . mirclientplatform ABI unchanged at 5
293
12
      . mirinputplatform ABI bumped to 6
294
13
      . mircore ABI added, at version 1
295
14
    - Enhancements:
296
15
      . Added pointer confinement support
297
16
      . Identify Raspberry Pi output types correctly
298
17
      . Added dead key and compose key support
299
18
      . Added gamma support for KMS hardware
300
19
      . Added yakkety and zesty gcc-6 support
301
20
      . Added surface passthrough support for fullscreen clients of nested
302
21
        servers
303
22
      . Introduced a new library `libmircore'
304
23
      . Began migrating from Protobuf to Cap'n Proto starting with events
305
24
      . Began support for VirtualBox (servers now start instead of crashing
306
25
        but full support for GL clients is still missing)
307
26
      . Began support for high precision frame timing, implemented for the
308
27
        KMS, Android and X11 backends so far
309
28
      . Added --display-report support for the X11 backend
310
29
      . Improved reliability of `mirvanity' latency test tool
311
30
      . Moved to using the CSS cursor naming scheme internally, although
312
31
        the old symbolic indentifiers remain unchanged and still work
313
32
      . Added refresh rate to MirSurfaceOutputEvent
314
33
      . Many improvements to automated test quality and coverage
315
34
      . Smoother desktop zoom using mir_proving_server (Super + two fingers)
316
35
    - Bugs fixed:
317
36
      . FTBFS On Zesty: invalid use of
318
37
        'struct native_handle' (LP: #1638774)
319
38
      . libmirclient-debug-extension-dev install debug/surface.h
320
39
        twice (LP: #1639153)
321
40
      . Mir crashes on virtual box drmModeCrtcSetGamma
322
41
        Function not implemented (LP: #1638220)
323
42
      . Flickering in mir_demo_client_multistream (LP: #1635273)
324
43
      . Camera apps (camera & vanity) never exit (LP: #1635010)
325
44
      . Clients cannot connect when MIR_SOCKET="" (LP: #1634508)
326
45
      . mirtest-dev packaging fails to sepcify boost depends (LP: #1633537)
327
46
      . cursor.h is unclear about mir_diagonal_resize_* (LP: #1626924)
328
47
      . Inconsistent underscores in cursor names (LP: #1632617)
329
48
      . [regression] Accidental libmircommon.so.6 break (LP: #1617865)
330
49
      . [regression] mir demo server fails to start with mx4 (LP: #1615703)
331
50
      . [regression] Trust prompt now shown when starting camera (LP: #1612256)
332
51
      . [regression] make abi-check fails to build (LP: #1626866)
333
52
      . Nested servers prevent overlays or fullscreen bypass (LP: #1262116)
334
53
      . Failed to get PRIME fd from gbm bo (LP: #1607812)
335
54
      . Mir-on-X is difficult to use on 1366x768 laptop (LP: #1590959)
336
55
      . Remove useless message 'Surface 0 DPI' in demos (LP: #1559831)
337
56
      . Mir fails to cross-build with newer sbuild (LP: #1628507)
338
57
      . Infinite loop in AbstractShell::focus_next_session (LP: #1625401)
339
58
      . Destroying a presentation chain doesn't trigger ownership
340
59
        notification to client (LP: #1626503)
341
60
      . Keyboard layout not applied on the shell (LP: #1626435)
342
61
      . Warning, No syntax specified for the proto file (LP: #1624971)
343
62
      . display-report=log reports vsync on non-existent output number
344
63
        (LP: #1621352)
345
64
      . libmirserver-dev missing uuid-dev depends (LP: #1617435)
346
65
      . debian/control missing epoxy (LP: #1617256)
347
66
      . Downstreams need to disable clang diagnostic "-Wreturn-type-clinkage"
348
67
        to build against public headers (LP: #1615587)
349
68
      . mirtest-dev: mock_display_configuration.h uses mg namespace without
350
69
        using it (LP: #1614983)
351
70
      . FTBFS using clang (LP: #1609612)
352
71
      . mesa-kms doesn't fall back to using software cursor if hardware
353
72
        cursor is unavailable (LP: #1610054)
354
73
      . StubGraphicsPlatform::create_display() leaves a dubious state
355
74
        (LP: #1611337)
356
75
      . Mir build/tests fail with gcc-6 and LTO (LP: #1610215)
357
76
      . Cross compiling on xenial fails (LP: #1609329)
358
77
      . Building with -DMIR_PLATFORM=anroid fails (LP: #1609916)
359
78
      . unity-system-compositor crashes on start-up with "Mir fatal error:
360
79
        Failed to schedule page flip" (LP: #1584894)
361
80
      . mir_connection_create_spec_for_tooltip doesn't meet requirements
362
81
        (LP: #1603922)
363
82
      . Updating surface size/location needs to update the pointer confinement
364
83
        (LP: #1604673)
365
84
      . ServerConfigurationOption is not ptest safe (LP: #1607351)
366
85
      . HWC's vsync_signal_on is never called when using HWC 1.0 (LP: #1613373)
367
86
      . mir_connection_create_spec_for_tooltip does not set aux_rect
368
87
        (LP: #1632335)
369
88
      . VMware virtual connector recognized by Mir as "unknown" (LP: #1248072)
370
89
      . Fix code to match the documentation of CoordinateTranslator - vis "It is
371
90
        acceptable ...[to] throw a std::runtime_error" (LP: #1641166)
372
91
      . Test timeout MesaDisplayConfigurationTests.* (LP: #1613352)
373
92
      . Tests fail when built against lp:mir (LP: #1621917)
374
93
      . CI failure MultiThreadedCompositor (LP: #1595940)
375
94
      . CI failure in DisplayConfiguration (LP: #1563210)
376
95
      . CI failure  NestedServer.given_client_set_display_configuration*
377
96
        (LP: #1617036)
378
97
      . CI failure on krillin in NestedServer.* testes (LP: #1628828)
379
98
      . CI failure: PosixRWMutex hangs (LP: #1633920)
380
99
      . googletest 1.8.0-2 (on zesty) breaks existing builds [add_library
381
100
        cannot create target "gmock" ...] (LP: #1644062)
382
101
383
102
 -- Brandon Schaefer <brandon.schaefer@canonical.com>  Mon, 07 Nov 2016 13:32:11 -0800
384
103
385
1
mir (0.24.1+16.10.20160928-0ubuntu1) yakkety; urgency=medium
104
mir (0.24.1+16.10.20160928-0ubuntu1) yakkety; urgency=medium
386
2
105
387
3
  * New upstream release 0.24.1 (https://launchpad.net/mir/+milestone/0.24.1)
106
  * New upstream release 0.24.1 (https://launchpad.net/mir/+milestone/0.24.1)
388
4
107
389
=== modified file 'debian/control'
390
--- debian/control	2016-07-21 11:19:35 +0000
391
+++ debian/control	2016-11-29 04:47:53 +0000
392
@@ -4,7 +4,6 @@
393
4
Maintainer: Ubuntu Developers <ubuntu-devel-discuss@lists.ubuntu.com>
4
Maintainer: Ubuntu Developers <ubuntu-devel-discuss@lists.ubuntu.com>
394
5
XSBC-Original-Maintainer: Thomas Voß <thomas.voss@canonical.com>
5
XSBC-Original-Maintainer: Thomas Voß <thomas.voss@canonical.com>
395
6
Build-Depends: cmake,
6
Build-Depends: cmake,
396
7
               cmake-data,
397
8
               pkg-config,
7
               pkg-config,
398
9
               debhelper (>= 9),
8
               debhelper (>= 9),
399
10
               doxygen,
9
               doxygen,
400
@@ -29,7 +28,7 @@
401
29
               libandroid-properties-dev [i386 amd64 armhf arm64],
28
               libandroid-properties-dev [i386 amd64 armhf arm64],
402
30
               libgoogle-glog-dev,
29
               libgoogle-glog-dev,
403
31
               liblttng-ust-dev,
30
               liblttng-ust-dev,
405
32
               libxkbcommon-dev,
31
               libxkbcommon-dev (>= 0.5),
406
33
               libumockdev-dev (>= 0.6),
32
               libumockdev-dev (>= 0.6),
407
34
               umockdev (>= 0.8.7),
33
               umockdev (>= 0.8.7),
408
35
               libudev-dev,
34
               libudev-dev,
409
@@ -46,6 +45,9 @@
410
46
               python3:any,
45
               python3:any,
411
47
               dh-python,
46
               dh-python,
412
48
               nettle-dev,
47
               nettle-dev,
413
48
               libcapnp-dev,
414
49
               capnproto,
415
50
               libepoxy-dev,
416
49
Standards-Version: 3.9.4
51
Standards-Version: 3.9.4
417
50
Homepage: https://launchpad.net/mir
52
Homepage: https://launchpad.net/mir
418
51
# If you aren't a member of ~mir-team but need to upload packaging changes,
53
# If you aren't a member of ~mir-team but need to upload packaging changes,
419
@@ -68,7 +70,7 @@
420
68
70
421
69
#TODO: Packaging infrastructure for better dependency generation,
71
#TODO: Packaging infrastructure for better dependency generation,
422
70
#      ala pkg-xorg's xviddriver:Provides and ABI detection.
72
#      ala pkg-xorg's xviddriver:Provides and ABI detection.
424
71
Package: libmirserver41
73
Package: libmirserver42
425
72
Section: libs
74
Section: libs
426
73
Architecture: linux-any
75
Architecture: linux-any
427
74
Multi-Arch: same
76
Multi-Arch: same
428
@@ -81,7 +83,7 @@
429
81
 .
83
 .
430
82
 Contains the shared library needed by server applications for Mir.
84
 Contains the shared library needed by server applications for Mir.
431
83
85
433
84
Package: libmirplatform13
86
Package: libmirplatform14
434
85
Section: libs
87
Section: libs
435
86
Architecture: linux-any
88
Architecture: linux-any
436
87
Multi-Arch: same
89
Multi-Arch: same
437
@@ -95,12 +97,25 @@
438
95
 Contains the shared libraries required for the Mir server to interact with
97
 Contains the shared libraries required for the Mir server to interact with
439
96
 the underlying hardware platform.
98
 the underlying hardware platform.
440
97
99
441
100
Package: libmircore-dev
442
101
Section: libdevel
443
102
Architecture: linux-any
444
103
Multi-Arch: same
445
104
Pre-Depends: ${misc:Pre-Depends}
446
105
Depends: ${misc:Depends},
447
106
Description: Display server for Ubuntu - development headers
448
107
 Mir is a display server running on linux systems, with a focus on efficiency,
449
108
 robust operation and a well-defined driver model.
450
109
 .
451
110
 Contains header files required for server and/or client development.
452
111
453
98
Package: libmircommon-dev
112
Package: libmircommon-dev
454
99
Section: libdevel
113
Section: libdevel
455
100
Architecture: linux-any
114
Architecture: linux-any
456
101
Multi-Arch: same
115
Multi-Arch: same
457
102
Pre-Depends: ${misc:Pre-Depends}
116
Pre-Depends: ${misc:Pre-Depends}
459
103
Depends: libmircommon6 (= ${binary:Version}), 
117
Depends: libmircommon7 (= ${binary:Version}),
460
118
         libmircore-dev,
461
104
         libprotobuf-dev (>= 2.4.1),
119
         libprotobuf-dev (>= 2.4.1),
462
105
         libxkbcommon-dev,
120
         libxkbcommon-dev,
463
106
         ${misc:Depends},
121
         ${misc:Depends},
464
@@ -117,7 +132,7 @@
465
117
Architecture: linux-any
132
Architecture: linux-any
466
118
Multi-Arch: same
133
Multi-Arch: same
467
119
Pre-Depends: ${misc:Pre-Depends}
134
Pre-Depends: ${misc:Pre-Depends}
469
120
Depends: libmirplatform13 (= ${binary:Version}),
135
Depends: libmirplatform14 (= ${binary:Version}),
470
121
         libmircommon-dev,
136
         libmircommon-dev,
471
122
         libboost-program-options-dev,
137
         libboost-program-options-dev,
472
123
         ${misc:Depends},
138
         ${misc:Depends},
473
@@ -134,10 +149,11 @@
474
134
Architecture: linux-any
149
Architecture: linux-any
475
135
Multi-Arch: same
150
Multi-Arch: same
476
136
Pre-Depends: ${misc:Pre-Depends}
151
Pre-Depends: ${misc:Pre-Depends}
478
137
Depends: libmirserver41 (= ${binary:Version}),
152
Depends: libmirserver42 (= ${binary:Version}),
479
138
         libmirplatform-dev (= ${binary:Version}),
153
         libmirplatform-dev (= ${binary:Version}),
480
139
         libmircommon-dev (= ${binary:Version}),
154
         libmircommon-dev (= ${binary:Version}),
481
140
         libglm-dev,
155
         libglm-dev,
482
156
         uuid-dev,
483
141
         ${misc:Depends},
157
         ${misc:Depends},
484
142
Description: Display server for Ubuntu - development headers
158
Description: Display server for Ubuntu - development headers
485
143
 Mir is a display server running on linux systems, with a focus on efficiency,
159
 Mir is a display server running on linux systems, with a focus on efficiency,
486
@@ -154,6 +170,8 @@
487
154
         libmirplatform-dev (= ${binary:Version}),
170
         libmirplatform-dev (= ${binary:Version}),
488
155
         libmirserver-dev (= ${binary:Version}),
171
         libmirserver-dev (= ${binary:Version}),
489
156
         ${misc:Depends},
172
         ${misc:Depends},
490
173
         libboost-filesystem1.61.0 | libboost-filesystem1.58.0 | libboost-filesystem1.55.0,
491
174
         libboost-system1.61.0 | libboost-system1.58.0 | libboost-system1.55.0,
492
157
Description: Display server for Ubuntu - test development headers and library
175
Description: Display server for Ubuntu - test development headers and library
493
158
 Mir is a display server running on linux systems, with a focus on efficiency,
176
 Mir is a display server running on linux systems, with a focus on efficiency,
494
159
 robust operation and a well-defined driver model.
177
 robust operation and a well-defined driver model.
495
@@ -288,7 +306,20 @@
496
288
 .
306
 .
497
289
 Contains a tool for checking the graphics components of android devices.
307
 Contains a tool for checking the graphics components of android devices.
498
290
308
500
291
Package: libmircommon6
309
Package: libmircore1
501
310
Section: libs
502
311
Architecture: linux-any
503
312
Multi-Arch: same
504
313
Pre-Depends: ${misc:Pre-Depends}
505
314
Depends: ${misc:Depends},
506
315
         ${shlibs:Depends},
507
316
Description: Display server for Ubuntu - shared library
508
317
 Mir is a display server running on linux systems, with a focus on efficiency,
509
318
 robust operation and a well-defined driver model.
510
319
 .
511
320
 Contains the shared libraries required for the Mir server and client.
512
321
513
322
Package: libmircommon7
514
292
Section: libs
323
Section: libs
515
293
Architecture: linux-any
324
Architecture: linux-any
516
294
Multi-Arch: same
325
Multi-Arch: same
517
@@ -302,7 +333,7 @@
518
302
 Contains the shared libraries required for the Mir server and client.
333
 Contains the shared libraries required for the Mir server and client.
519
303
334
520
304
# Longer-term these drivers should move out-of-tree
335
# Longer-term these drivers should move out-of-tree
522
305
Package: mir-platform-graphics-mesa-x10
336
Package: mir-platform-graphics-mesa-x11
523
306
Section: libs
337
Section: libs
524
307
Architecture: linux-any
338
Architecture: linux-any
525
308
Multi-Arch: same
339
Multi-Arch: same
526
@@ -316,7 +347,7 @@
527
316
 Contains the shared libraries required for the Mir server to interact with
347
 Contains the shared libraries required for the Mir server to interact with
528
317
 the X11 platform using the Mesa drivers.
348
 the X11 platform using the Mesa drivers.
529
318
349
531
319
Package: mir-platform-graphics-mesa-kms10
350
Package: mir-platform-graphics-mesa-kms11
532
320
Section: libs
351
Section: libs
533
321
Architecture: linux-any
352
Architecture: linux-any
534
322
Multi-Arch: same
353
Multi-Arch: same
535
@@ -330,7 +361,7 @@
536
330
 Contains the shared libraries required for the Mir server to interact with
361
 Contains the shared libraries required for the Mir server to interact with
537
331
 the hardware platform using the Mesa drivers.
362
 the hardware platform using the Mesa drivers.
538
332
363
540
333
Package: mir-platform-graphics-android10
364
Package: mir-platform-graphics-android11
541
334
Section: libs
365
Section: libs
542
335
Architecture: i386 amd64 armhf arm64
366
Architecture: i386 amd64 armhf arm64
543
336
Multi-Arch: same
367
Multi-Arch: same
544
@@ -344,7 +375,7 @@
545
344
 Contains the shared libraries required for the Mir server to interact with
375
 Contains the shared libraries required for the Mir server to interact with
546
345
 the hardware platform using the Android drivers.
376
 the hardware platform using the Android drivers.
547
346
377
549
347
Package: mir-platform-input-evdev5
378
Package: mir-platform-input-evdev6
550
348
Section: libs
379
Section: libs
551
349
Architecture: linux-any
380
Architecture: linux-any
552
350
Multi-Arch: same
381
Multi-Arch: same
553
@@ -406,10 +437,10 @@
554
406
Multi-Arch: same
437
Multi-Arch: same
555
407
Pre-Depends: ${misc:Pre-Depends}
438
Pre-Depends: ${misc:Pre-Depends}
556
408
Depends: ${misc:Depends},
439
Depends: ${misc:Depends},
559
409
         mir-platform-graphics-mesa-kms10,
440
         mir-platform-graphics-mesa-kms11,
560
410
         mir-platform-graphics-mesa-x10,
441
         mir-platform-graphics-mesa-x11,
561
411
         mir-client-platform-mesa5,
442
         mir-client-platform-mesa5,
563
412
         mir-platform-input-evdev5,
443
         mir-platform-input-evdev6,
564
413
Description: Display server for Ubuntu - desktop driver metapackage
444
Description: Display server for Ubuntu - desktop driver metapackage
565
414
 Mir is a display server running on linux systems, with a focus on efficiency,
445
 Mir is a display server running on linux systems, with a focus on efficiency,
566
415
 robust operation and a well-defined driver model.
446
 robust operation and a well-defined driver model.
567
@@ -423,9 +454,9 @@
568
423
Multi-Arch: same
454
Multi-Arch: same
569
424
Pre-Depends: ${misc:Pre-Depends}
455
Pre-Depends: ${misc:Pre-Depends}
570
425
Depends: ${misc:Depends},
456
Depends: ${misc:Depends},
572
426
         mir-platform-graphics-android10,
457
         mir-platform-graphics-android11,
573
427
         mir-client-platform-android5,
458
         mir-client-platform-android5,
575
428
         mir-platform-input-evdev5,
459
         mir-platform-input-evdev6,
576
429
Description: Display server for Ubuntu - android driver metapackage
460
Description: Display server for Ubuntu - android driver metapackage
577
430
 Mir is a display server running on linux systems, with a focus on efficiency,
461
 Mir is a display server running on linux systems, with a focus on efficiency,
578
431
 robust operation and a well-defined driver model.
462
 robust operation and a well-defined driver model.
579
@@ -478,6 +509,20 @@
580
478
 tests for Mir. It also contains a few interesting performance tests written
509
 tests for Mir. It also contains a few interesting performance tests written
581
479
 using the framework.
510
 using the framework.
582
480
511
583
512
Package: libmirrenderer-dev
584
513
Section: libdevel
585
514
Architecture: linux-any
586
515
Multi-Arch: same
587
516
Pre-Depends: ${misc:Pre-Depends}
588
517
Depends: ${misc:Depends},
589
518
         libmircommon-dev,
590
519
         libmirplatform-dev
591
520
Description: Display server for Ubuntu - Renderer development files
592
521
 Mir is a display server running on linux systems, with a focus on efficiency,
593
522
 robust operation and a well-defined driver model.
594
523
 .
595
524
 Contains header files required for renderer development.
596
525
597
481
Package: mir-renderer-gl-dev
526
Package: mir-renderer-gl-dev
598
482
Section: libdevel
527
Section: libdevel
599
483
Architecture: linux-any
528
Architecture: linux-any
600
484
529
601
=== modified file 'debian/copyright'
602
--- debian/copyright	2016-01-25 17:28:12 +0000
603
+++ debian/copyright	2016-11-29 04:47:53 +0000
604
@@ -1,4 +1,4 @@
606
1
Format: http://dep.debian.net/deps/dep5/
1
Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
607
2
Upstream-Name: Mir
2
Upstream-Name: Mir
608
3
Upstream-Contact: Thomas Voß <thomas.voss@canonical.com>
3
Upstream-Contact: Thomas Voß <thomas.voss@canonical.com>
609
4
Source: http://launchpad.net/mir
4
Source: http://launchpad.net/mir
610
5
5
611
=== renamed file 'debian/libmircommon6.install' => 'debian/libmircommon7.install'
612
--- debian/libmircommon6.install	2016-07-20 11:16:01 +0000
613
+++ debian/libmircommon7.install	2016-11-29 04:47:53 +0000
614
@@ -1,1 +1,1 @@
616
1
usr/lib/*/libmircommon.so.6
1
usr/lib/*/libmircommon.so.7
617
2
2
618
=== added file 'debian/libmircore-dev.install'
619
--- debian/libmircore-dev.install	1970-01-01 00:00:00 +0000
620
+++ debian/libmircore-dev.install	2016-11-29 04:47:53 +0000
621
@@ -0,0 +1,3 @@
622
1
usr/include/mircore
623
2
usr/lib/*/libmircore.so
624
3
usr/lib/*/pkgconfig/mircore.pc
625
0
4
626
=== added file 'debian/libmircore1.install'
627
--- debian/libmircore1.install	1970-01-01 00:00:00 +0000
628
+++ debian/libmircore1.install	2016-11-29 04:47:53 +0000
629
@@ -0,0 +1,1 @@
630
1
usr/lib/*/libmircore.so.1
631
0
2
632
=== renamed file 'debian/libmirplatform13.install' => 'debian/libmirplatform14.install'
633
--- debian/libmirplatform13.install	2016-07-07 11:14:26 +0000
634
+++ debian/libmirplatform14.install	2016-11-29 04:47:53 +0000
635
@@ -1,1 +1,1 @@
637
1
usr/lib/*/libmirplatform.so.13
1
usr/lib/*/libmirplatform.so.14
638
2
2
639
=== added file 'debian/libmirrenderer-dev.install'
640
--- debian/libmirrenderer-dev.install	1970-01-01 00:00:00 +0000
641
+++ debian/libmirrenderer-dev.install	2016-11-29 04:47:53 +0000
642
@@ -0,0 +1,2 @@
643
1
usr/include/mirrenderer/mir/renderer/*.h
644
2
usr/lib/*/pkgconfig/mirrenderer.pc
645
0
3
646
=== renamed file 'debian/libmirserver41.install' => 'debian/libmirserver42.install'
647
--- debian/libmirserver41.install	2016-07-20 11:16:01 +0000
648
+++ debian/libmirserver42.install	2016-11-29 04:47:53 +0000
649
@@ -1,1 +1,1 @@
651
1
usr/lib/*/libmirserver.so.41
1
usr/lib/*/libmirserver.so.42
652
2
2
653
=== renamed file 'debian/mir-platform-graphics-android10.install' => 'debian/mir-platform-graphics-android11.install'
654
--- debian/mir-platform-graphics-android10.install	2016-07-20 04:54:07 +0000
655
+++ debian/mir-platform-graphics-android11.install	2016-11-29 04:47:53 +0000
656
@@ -1,1 +1,1 @@
658
1
usr/lib/*/mir/server-platform/graphics-android.so.10
1
usr/lib/*/mir/server-platform/graphics-android.so.11
659
2
2
660
=== renamed file 'debian/mir-platform-graphics-mesa-kms10.install' => 'debian/mir-platform-graphics-mesa-kms11.install'
661
--- debian/mir-platform-graphics-mesa-kms10.install	2016-07-20 04:54:07 +0000
662
+++ debian/mir-platform-graphics-mesa-kms11.install	2016-11-29 04:47:53 +0000
663
@@ -1,1 +1,1 @@
665
1
usr/lib/*/mir/server-platform/graphics-mesa-kms.so.10
1
usr/lib/*/mir/server-platform/graphics-mesa-kms.so.11
666
2
2
667
=== renamed file 'debian/mir-platform-graphics-mesa-x10.install' => 'debian/mir-platform-graphics-mesa-x11.install'
668
--- debian/mir-platform-graphics-mesa-x10.install	2016-07-20 04:54:07 +0000
669
+++ debian/mir-platform-graphics-mesa-x11.install	2016-11-29 04:47:53 +0000
670
@@ -1,1 +1,1 @@
672
1
usr/lib/*/mir/server-platform/server-mesa-x11.so.10
1
usr/lib/*/mir/server-platform/server-mesa-x11.so.11
673
2
2
674
=== renamed file 'debian/mir-platform-input-evdev5.install' => 'debian/mir-platform-input-evdev6.install'
675
--- debian/mir-platform-input-evdev5.install	2016-01-29 08:18:22 +0000
676
+++ debian/mir-platform-input-evdev6.install	2016-11-29 04:47:53 +0000
677
@@ -1,1 +1,1 @@
679
1
usr/lib/*/mir/server-platform/input-evdev.so.5
1
usr/lib/*/mir/server-platform/input-evdev.so.6
680
2
2
681
=== modified file 'debian/rules'
682
--- debian/rules	2016-07-21 11:19:35 +0000
683
+++ debian/rules	2016-11-29 04:47:53 +0000
684
@@ -28,6 +28,11 @@
685
28
	COMMON_CONFIGURE_OPTIONS += -DMIR_LINK_TIME_OPTIMIZATION=ON
28
	COMMON_CONFIGURE_OPTIONS += -DMIR_LINK_TIME_OPTIMIZATION=ON
686
29
endif
29
endif
687
30
30
688
31
# Disable LTO on s390x, due to failing to build
689
32
ifeq ($(DEB_HOST_ARCH),s390x)
690
33
	COMMON_CONFIGURE_OPTIONS += -DMIR_LINK_TIME_OPTIMIZATION=OFF
691
34
endif
692
35
693
31
override_dh_auto_configure:
36
override_dh_auto_configure:
694
32
ifneq ($(filter armhf arm64,$(DEB_HOST_ARCH)),)
37
ifneq ($(filter armhf arm64,$(DEB_HOST_ARCH)),)
695
33
	dh_auto_configure -- \
38
	dh_auto_configure -- \
696
34
39
697
=== modified file 'doc/Doxyfile.in'
698
--- doc/Doxyfile.in	2015-02-22 07:46:25 +0000
699
+++ doc/Doxyfile.in	2016-11-29 04:47:53 +0000
700
@@ -1,106 +1,122 @@
702
1
# Doxyfile 1.8.4
1
# Doxyfile 1.8.11
703
2
2
704
3
# This file describes the settings to be used by the documentation system
3
# This file describes the settings to be used by the documentation system
705
4
# doxygen (www.doxygen.org) for a project.
4
# doxygen (www.doxygen.org) for a project.
706
5
#
5
#
710
6
# All text after a double hash (##) is considered a comment and is placed
6
# All text after a double hash (##) is considered a comment and is placed in
711
7
# in front of the TAG it is preceding .
7
# front of the TAG it is preceding.
712
8
# All text after a hash (#) is considered a comment and will be ignored.
8
#
713
9
# All text after a single hash (#) is considered a comment and will be ignored.
714
9
# The format is:
10
# The format is:
719
10
#       TAG = value [value, ...]
11
# TAG = value [value, ...]
720
11
# For lists items can also be appended using:
12
# For lists, items can also be appended using:
721
12
#       TAG += value [value, ...]
13
# TAG += value [value, ...]
722
13
# Values that contain spaces should be placed between quotes (" ").
14
# Values that contain spaces should be placed between quotes (\" \").
723
14
15
724
15
#---------------------------------------------------------------------------
16
#---------------------------------------------------------------------------
725
16
# Project related configuration options
17
# Project related configuration options
726
17
#---------------------------------------------------------------------------
18
#---------------------------------------------------------------------------
727
18
19
728
19
# This tag specifies the encoding used for all characters in the config file
20
# This tag specifies the encoding used for all characters in the config file
733
20
# that follow. The default is UTF-8 which is also the encoding used for all
21
# that follow. The default is UTF-8 which is also the encoding used for all text
734
21
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
22
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
735
22
# iconv built into libc) for the transcoding. See
23
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
736
23
# http://www.gnu.org/software/libiconv for the list of possible encodings.
24
# for the list of possible encodings.
737
25
# The default value is: UTF-8.
738
24
26
739
25
DOXYFILE_ENCODING      = UTF-8
27
DOXYFILE_ENCODING      = UTF-8
740
26
28
744
27
# The PROJECT_NAME tag is a single word (or sequence of words) that should
29
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
745
28
# identify the project. Note that if you do not use Doxywizard you need
30
# double-quotes, unless you are using Doxywizard) that should identify the
746
29
# to put quotes around the project name if it contains spaces.
31
# project for which the documentation is generated. This name is used in the
747
32
# title of most generated pages and in a few other places.
748
33
# The default value is: My Project.
749
30
34
750
31
PROJECT_NAME           = Mir
35
PROJECT_NAME           = Mir
751
32
36
755
33
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
37
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
756
34
# This could be handy for archiving the generated documentation or
38
# could be handy for archiving the generated documentation or if some version
757
35
# if some version control system is used.
39
# control system is used.
758
36
40
759
37
PROJECT_NUMBER         =
41
PROJECT_NUMBER         =
760
38
42
761
39
# Using the PROJECT_BRIEF tag one can provide an optional one line description
43
# Using the PROJECT_BRIEF tag one can provide an optional one line description
764
40
# for a project that appears at the top of each page and should give viewer
44
# for a project that appears at the top of each page and should give viewer a
765
41
# a quick idea about the purpose of the project. Keep the description short.
45
# quick idea about the purpose of the project. Keep the description short.
766
42
46
767
43
PROJECT_BRIEF          =
47
PROJECT_BRIEF          =
768
44
48
773
45
# With the PROJECT_LOGO tag one can specify an logo or icon that is
49
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
774
46
# included in the documentation. The maximum height of the logo should not
50
# in the documentation. The maximum height of the logo should not exceed 55
775
47
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
51
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
776
48
# Doxygen will copy the logo to the output directory.
52
# the logo to the output directory.
777
49
53
778
50
PROJECT_LOGO           =
54
PROJECT_LOGO           =
779
51
55
784
52
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
56
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
785
53
# base path where the generated documentation will be put.
57
# into which the generated documentation will be written. If a relative path is
786
54
# If a relative path is entered, it will be relative to the location
58
# entered, it will be relative to the location where doxygen was started. If
787
55
# where doxygen was started. If left blank the current directory will be used.
59
# left blank the current directory will be used.
788
56
60
789
57
OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@/doc
61
OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@/doc
790
58
62
797
59
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
63
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
798
60
# 4096 sub-directories (in 2 levels) under the output directory of each output
64
# directories (in 2 levels) under the output directory of each output format and
799
61
# format and will distribute the generated files over these directories.
65
# will distribute the generated files over these directories. Enabling this
800
62
# Enabling this option can be useful when feeding doxygen a huge amount of
66
# option can be useful when feeding doxygen a huge amount of source files, where
801
63
# source files, where putting all generated files in the same directory would
67
# putting all generated files in the same directory would otherwise causes
802
64
# otherwise cause performance problems for the file system.
68
# performance problems for the file system.
803
69
# The default value is: NO.
804
65
70
805
66
CREATE_SUBDIRS         = NO
71
CREATE_SUBDIRS         = NO
806
67
72
807
73
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
808
74
# characters to appear in the names of generated files. If set to NO, non-ASCII
809
75
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
810
76
# U+3044.
811
77
# The default value is: NO.
812
78
813
79
ALLOW_UNICODE_NAMES    = NO
814
80
815
68
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
81
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
816
69
# documentation generated by doxygen is written. Doxygen will use this
82
# documentation generated by doxygen is written. Doxygen will use this
817
70
# information to generate all constant output in the proper language.
83
# information to generate all constant output in the proper language.
825
71
# The default language is English, other supported languages are:
84
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
826
72
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
85
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
827
73
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
86
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
828
74
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
87
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
829
75
# messages), Korean, Korean-en, Latvian, Lithuanian, Norwegian, Macedonian,
88
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
830
76
# Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic,
89
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
831
77
# Slovak, Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
90
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
832
91
# Ukrainian and Vietnamese.
833
92
# The default value is: English.
834
78
93
835
79
OUTPUT_LANGUAGE        = English
94
OUTPUT_LANGUAGE        = English
836
80
95
841
81
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
96
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
842
82
# include brief member descriptions after the members that are listed in
97
# descriptions after the members that are listed in the file and class
843
83
# the file and class documentation (similar to JavaDoc).
98
# documentation (similar to Javadoc). Set to NO to disable this.
844
84
# Set to NO to disable this.
99
# The default value is: YES.
845
85
100
846
86
BRIEF_MEMBER_DESC      = YES
101
BRIEF_MEMBER_DESC      = YES
847
87
102
851
88
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
103
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
852
89
# the brief description of a member or function before the detailed description.
104
# description of a member or function before the detailed description
853
90
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
105
#
854
106
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
855
91
# brief descriptions will be completely suppressed.
107
# brief descriptions will be completely suppressed.
856
108
# The default value is: YES.
857
92
109
858
93
REPEAT_BRIEF           = YES
110
REPEAT_BRIEF           = YES
859
94
111
869
95
# This tag implements a quasi-intelligent brief description abbreviator
112
# This tag implements a quasi-intelligent brief description abbreviator that is
870
96
# that is used to form the text in various listings. Each string
113
# used to form the text in various listings. Each string in this list, if found
871
97
# in this list, if found as the leading text of the brief description, will be
114
# as the leading text of the brief description, will be stripped from the text
872
98
# stripped from the text and the result after processing the whole list, is
115
# and the result, after processing the whole list, is used as the annotated
873
99
# used as the annotated text. Otherwise, the brief description is used as-is.
116
# text. Otherwise, the brief description is used as-is. If left blank, the
874
100
# If left blank, the following values are used ("$name" is automatically
117
# following values are used ($name is automatically replaced with the name of
875
101
# replaced with the name of the entity): "The $name class" "The $name widget"
118
# the entity):The $name class, The $name widget, The $name file, is, provides,
876
102
# "The $name file" "is" "provides" "specifies" "contains"
119
# specifies, contains, represents, a, an and the.
868
103
# "represents" "a" "an" "the"
877
104
120
878
105
ABBREVIATE_BRIEF       = "The $name class" \
121
ABBREVIATE_BRIEF       = "The $name class" \
879
106
                         "The $name widget" \
122
                         "The $name widget" \
880
@@ -115,8 +131,9 @@
881
115
                         the
131
                         the
882
116
132
883
117
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
133
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
885
118
# Doxygen will generate a detailed section even if there is only a brief
134
# doxygen will generate a detailed section even if there is only a brief
886
119
# description.
135
# description.
887
136
# The default value is: NO.
888
120
137
889
121
ALWAYS_DETAILED_SEC    = NO
138
ALWAYS_DETAILED_SEC    = NO
890
122
139
891
@@ -124,231 +141,276 @@
892
124
# inherited members of a class in the documentation of that class as if those
141
# inherited members of a class in the documentation of that class as if those
893
125
# members were ordinary class members. Constructors, destructors and assignment
142
# members were ordinary class members. Constructors, destructors and assignment
894
126
# operators of the base classes will not be shown.
143
# operators of the base classes will not be shown.
895
144
# The default value is: NO.
896
127
145
897
128
INLINE_INHERITED_MEMB  = NO
146
INLINE_INHERITED_MEMB  = NO
898
129
147
902
130
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
148
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
903
131
# path before files name in the file list and in the header files. If set
149
# before files name in the file list and in the header files. If set to NO the
904
132
# to NO the shortest path that makes the file name unique will be used.
150
# shortest path that makes the file name unique will be used
905
151
# The default value is: YES.
906
133
152
907
134
FULL_PATH_NAMES        = YES
153
FULL_PATH_NAMES        = YES
908
135
154
917
136
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
155
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
918
137
# can be used to strip a user-defined part of the path. Stripping is
156
# Stripping is only done if one of the specified strings matches the left-hand
919
138
# only done if one of the specified strings matches the left-hand part of
157
# part of the path. The tag can be used to show relative paths in the file list.
920
139
# the path. The tag can be used to show relative paths in the file list.
158
# If left blank the directory from which doxygen is run is used as the path to
921
140
# If left blank the directory from which doxygen is run is used as the
159
# strip.
922
141
# path to strip. Note that you specify absolute paths here, but also
160
#
923
142
# relative paths, which will be relative from the directory where doxygen is
161
# Note that you can specify absolute paths here, but also relative paths, which
924
143
# started.
162
# will be relative from the directory where doxygen is started.
925
163
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
926
144
164
927
145
STRIP_FROM_PATH        = @CMAKE_CURRENT_SOURCE_DIR@
165
STRIP_FROM_PATH        = @CMAKE_CURRENT_SOURCE_DIR@
928
146
166
935
147
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
167
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
936
148
# the path mentioned in the documentation of a class, which tells
168
# path mentioned in the documentation of a class, which tells the reader which
937
149
# the reader which header file to include in order to use a class.
169
# header file to include in order to use a class. If left blank only the name of
938
150
# If left blank only the name of the header file containing the class
170
# the header file containing the class definition is used. Otherwise one should
939
151
# definition is used. Otherwise one should specify the include paths that
171
# specify the list of include paths that are normally passed to the compiler
940
152
# are normally passed to the compiler using the -I flag.
172
# using the -I flag.
941
153
173
942
154
STRIP_FROM_INC_PATH    =
174
STRIP_FROM_INC_PATH    =
943
155
175
947
156
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
176
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
948
157
# (but less readable) file names. This can be useful if your file system
177
# less readable) file names. This can be useful is your file systems doesn't
949
158
# doesn't support long names like on DOS, Mac, or CD-ROM.
178
# support long names like on DOS, Mac, or CD-ROM.
950
179
# The default value is: NO.
951
159
180
952
160
SHORT_NAMES            = NO
181
SHORT_NAMES            = NO
953
161
182
959
162
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
183
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
960
163
# will interpret the first line (until the first dot) of a JavaDoc-style
184
# first line (until the first dot) of a Javadoc-style comment as the brief
961
164
# comment as the brief description. If set to NO, the JavaDoc
185
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
962
165
# comments will behave just like regular Qt-style comments
186
# style comments (thus requiring an explicit @brief command for a brief
963
166
# (thus requiring an explicit @brief command for a brief description.)
187
# description.)
964
188
# The default value is: NO.
965
167
189
966
168
JAVADOC_AUTOBRIEF      = YES
190
JAVADOC_AUTOBRIEF      = YES
967
169
191
973
170
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
192
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
974
171
# interpret the first line (until the first dot) of a Qt-style
193
# line (until the first dot) of a Qt-style comment as the brief description. If
975
172
# comment as the brief description. If set to NO, the comments
194
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
976
173
# will behave just like regular Qt-style comments (thus requiring
195
# requiring an explicit \brief command for a brief description.)
977
174
# an explicit \brief command for a brief description.)
196
# The default value is: NO.
978
175
197
979
176
QT_AUTOBRIEF           = NO
198
QT_AUTOBRIEF           = NO
980
177
199
986
178
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
200
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
987
179
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
201
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
988
180
# comments) as a brief description. This used to be the default behaviour.
202
# a brief description. This used to be the default behavior. The new default is
989
181
# The new default is to treat a multi-line C++ comment block as a detailed
203
# to treat a multi-line C++ comment block as a detailed description. Set this
990
182
# description. Set this tag to YES if you prefer the old behaviour instead.
204
# tag to YES if you prefer the old behavior instead.
991
205
#
992
206
# Note that setting this tag to YES also means that rational rose comments are
993
207
# not recognized any more.
994
208
# The default value is: NO.
995
183
209
996
184
MULTILINE_CPP_IS_BRIEF = YES
210
MULTILINE_CPP_IS_BRIEF = YES
997
185
211
1001
186
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
212
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
1002
187
# member inherits the documentation from any documented member that it
213
# documentation from any documented member that it re-implements.
1003
188
# re-implements.
214
# The default value is: YES.
1004
189
215
1005
190
INHERIT_DOCS           = YES
216
INHERIT_DOCS           = YES
1006
191
217
1010
192
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
218
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
1011
193
# a new page for each member. If set to NO, the documentation of a member will
219
# page for each member. If set to NO, the documentation of a member will be part
1012
194
# be part of the file/class/namespace that contains it.
220
# of the file/class/namespace that contains it.
1013
221
# The default value is: NO.
1014
195
222
1015
196
SEPARATE_MEMBER_PAGES  = NO
223
SEPARATE_MEMBER_PAGES  = NO
1016
197
224
1019
198
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
225
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
1020
199
# Doxygen uses this value to replace tabs by spaces in code fragments.
226
# uses this value to replace tabs by spaces in code fragments.
1021
227
# Minimum value: 1, maximum value: 16, default value: 4.
1022
200
228
1023
201
TAB_SIZE               = 4
229
TAB_SIZE               = 4
1024
202
230
1031
203
# This tag can be used to specify a number of aliases that acts
231
# This tag can be used to specify a number of aliases that act as commands in
1032
204
# as commands in the documentation. An alias has the form "name=value".
232
# the documentation. An alias has the form:
1033
205
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
233
# name=value
1034
206
# put the command \sideeffect (or @sideeffect) in the documentation, which
234
# For example adding
1035
207
# will result in a user-defined paragraph with heading "Side Effects:".
235
# "sideeffect=@par Side Effects:\n"
1036
208
# You can put \n's in the value part of an alias to insert newlines.
236
# will allow you to put the command \sideeffect (or @sideeffect) in the
1037
237
# documentation, which will result in a user-defined paragraph with heading
1038
238
# "Side Effects:". You can put \n's in the value part of an alias to insert
1039
239
# newlines.
1040
209
240
1041
210
ALIASES                =
241
ALIASES                =
1042
211
242
1043
212
# This tag can be used to specify a number of word-keyword mappings (TCL only).
243
# This tag can be used to specify a number of word-keyword mappings (TCL only).
1047
213
# A mapping has the form "name=value". For example adding
244
# A mapping has the form "name=value". For example adding "class=itcl::class"
1048
214
# "class=itcl::class" will allow you to use the command class in the
245
# will allow you to use the command class in the itcl::class meaning.
1046
215
# itcl::class meaning.
1049
216
246
1050
217
TCL_SUBST              =
247
TCL_SUBST              =
1051
218
248
1056
219
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
249
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
1057
220
# sources only. Doxygen will then generate output that is more tailored for C.
250
# only. Doxygen will then generate output that is more tailored for C. For
1058
221
# For instance, some of the names that are used will be different. The list
251
# instance, some of the names that are used will be different. The list of all
1059
222
# of all members will be omitted, etc.
252
# members will be omitted, etc.
1060
253
# The default value is: NO.
1061
223
254
1062
224
OPTIMIZE_OUTPUT_FOR_C  = NO
255
OPTIMIZE_OUTPUT_FOR_C  = NO
1063
225
256
1068
226
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
257
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
1069
227
# sources only. Doxygen will then generate output that is more tailored for
258
# Python sources only. Doxygen will then generate output that is more tailored
1070
228
# Java. For instance, namespaces will be presented as packages, qualified
259
# for that language. For instance, namespaces will be presented as packages,
1071
229
# scopes will look different, etc.
260
# qualified scopes will look different, etc.
1072
261
# The default value is: NO.
1073
230
262
1074
231
OPTIMIZE_OUTPUT_JAVA   = NO
263
OPTIMIZE_OUTPUT_JAVA   = NO
1075
232
264
1076
233
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
265
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
1079
234
# sources only. Doxygen will then generate output that is more tailored for
266
# sources. Doxygen will then generate output that is tailored for Fortran.
1080
235
# Fortran.
267
# The default value is: NO.
1081
236
268
1082
237
OPTIMIZE_FOR_FORTRAN   = NO
269
OPTIMIZE_FOR_FORTRAN   = NO
1083
238
270
1084
239
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
271
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
1087
240
# sources. Doxygen will then generate output that is tailored for
272
# sources. Doxygen will then generate output that is tailored for VHDL.
1088
241
# VHDL.
273
# The default value is: NO.
1089
242
274
1090
243
OPTIMIZE_OUTPUT_VHDL   = NO
275
OPTIMIZE_OUTPUT_VHDL   = NO
1091
244
276
1092
245
# Doxygen selects the parser to use depending on the extension of the files it
277
# Doxygen selects the parser to use depending on the extension of the files it
1093
246
# parses. With this tag you can assign which parser to use for a given
278
# parses. With this tag you can assign which parser to use for a given
1094
247
# extension. Doxygen has a built-in mapping, but you can override or extend it
279
# extension. Doxygen has a built-in mapping, but you can override or extend it
1102
248
# using this tag. The format is ext=language, where ext is a file extension,
280
# using this tag. The format is ext=language, where ext is a file extension, and
1103
249
# and language is one of the parsers supported by doxygen: IDL, Java,
281
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
1104
250
# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
282
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
1105
251
# C++. For instance to make doxygen treat .inc files as Fortran files (default
283
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
1106
252
# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
284
# Fortran. In the later case the parser tries to guess whether the code is fixed
1107
253
# that for custom extensions you also need to set FILE_PATTERNS otherwise the
285
# or free formatted code, this is the default for Fortran type files), VHDL. For
1108
254
# files are not read by doxygen.
286
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
1109
287
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
1110
288
#
1111
289
# Note: For files without extension you can use no_extension as a placeholder.
1112
290
#
1113
291
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
1114
292
# the files are not read by doxygen.
1115
255
293
1116
256
EXTENSION_MAPPING      =
294
EXTENSION_MAPPING      =
1117
257
295
1120
258
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
296
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
1121
259
# comments according to the Markdown format, which allows for more readable
297
# according to the Markdown format, which allows for more readable
1122
260
# documentation. See http://daringfireball.net/projects/markdown/ for details.
298
# documentation. See http://daringfireball.net/projects/markdown/ for details.
1126
261
# The output of markdown processing is further processed by doxygen, so you
299
# The output of markdown processing is further processed by doxygen, so you can
1127
262
# can mix doxygen, HTML, and XML commands with Markdown formatting.
300
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
1128
263
# Disable only in case of backward compatibilities issues.
301
# case of backward compatibilities issues.
1129
302
# The default value is: YES.
1130
264
303
1131
265
MARKDOWN_SUPPORT       = YES
304
MARKDOWN_SUPPORT       = YES
1132
266
305
1133
267
# When enabled doxygen tries to link words that correspond to documented
306
# When enabled doxygen tries to link words that correspond to documented
1134
268
# classes, or namespaces to their corresponding documentation. Such a link can
307
# classes, or namespaces to their corresponding documentation. Such a link can
1137
269
# be prevented in individual cases by by putting a % sign in front of the word
308
# be prevented in individual cases by putting a % sign in front of the word or
1138
270
# or globally by setting AUTOLINK_SUPPORT to NO.
309
# globally by setting AUTOLINK_SUPPORT to NO.
1139
310
# The default value is: YES.
1140
271
311
1141
272
AUTOLINK_SUPPORT       = YES
312
AUTOLINK_SUPPORT       = YES
1142
273
313
1143
274
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
314
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
1148
275
# to include (a tag file for) the STL sources as input, then you should
315
# to include (a tag file for) the STL sources as input, then you should set this
1149
276
# set this tag to YES in order to let doxygen match functions declarations and
316
# tag to YES in order to let doxygen match functions declarations and
1150
277
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
317
# definitions whose arguments contain STL classes (e.g. func(std::string);
1151
278
# func(std::string) {}). This also makes the inheritance and collaboration
318
# versus func(std::string) {}). This also make the inheritance and collaboration
1152
279
# diagrams that involve STL classes more complete and accurate.
319
# diagrams that involve STL classes more complete and accurate.
1153
320
# The default value is: NO.
1154
280
321
1155
281
BUILTIN_STL_SUPPORT    = YES
322
BUILTIN_STL_SUPPORT    = YES
1156
282
323
1157
283
# If you use Microsoft's C++/CLI language, you should set this option to YES to
324
# If you use Microsoft's C++/CLI language, you should set this option to YES to
1158
284
# enable parsing support.
325
# enable parsing support.
1159
326
# The default value is: NO.
1160
285
327
1161
286
CPP_CLI_SUPPORT        = NO
328
CPP_CLI_SUPPORT        = NO
1162
287
329
1166
288
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
330
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
1167
289
# Doxygen will parse them like normal C++ but will assume all classes use public
331
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
1168
290
# instead of private inheritance when no explicit protection keyword is present.
332
# will parse them like normal C++ but will assume all classes use public instead
1169
333
# of private inheritance when no explicit protection keyword is present.
1170
334
# The default value is: NO.
1171
291
335
1172
292
SIP_SUPPORT            = NO
336
SIP_SUPPORT            = NO
1173
293
337
1174
294
# For Microsoft's IDL there are propget and propput attributes to indicate
338
# For Microsoft's IDL there are propget and propput attributes to indicate
1180
295
# getter and setter methods for a property. Setting this option to YES (the
339
# getter and setter methods for a property. Setting this option to YES will make
1181
296
# default) will make doxygen replace the get and set methods by a property in
340
# doxygen to replace the get and set methods by a property in the documentation.
1182
297
# the documentation. This will only work if the methods are indeed getting or
341
# This will only work if the methods are indeed getting or setting a simple
1183
298
# setting a simple type. If this is not the case, or you want to show the
342
# type. If this is not the case, or you want to show the methods anyway, you
1184
299
# methods anyway, you should set this option to NO.
343
# should set this option to NO.
1185
344
# The default value is: YES.
1186
300
345
1187
301
IDL_PROPERTY_SUPPORT   = YES
346
IDL_PROPERTY_SUPPORT   = YES
1188
302
347
1189
303
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
348
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
1191
304
# tag is set to YES, then doxygen will reuse the documentation of the first
349
# tag is set to YES then doxygen will reuse the documentation of the first
1192
305
# member in the group (if any) for the other members of the group. By default
350
# member in the group (if any) for the other members of the group. By default
1193
306
# all members of a group must be documented explicitly.
351
# all members of a group must be documented explicitly.
1194
352
# The default value is: NO.
1195
307
353
1196
308
DISTRIBUTE_GROUP_DOC   = NO
354
DISTRIBUTE_GROUP_DOC   = NO
1197
309
355
1203
310
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
356
# If one adds a struct or class to a group and this option is enabled, then also
1204
311
# the same type (for instance a group of public functions) to be put as a
357
# any nested class or struct is added to the same group. By default this option
1205
312
# subgroup of that type (e.g. under the Public Functions section). Set it to
358
# is disabled and one has to add nested compounds explicitly via \ingroup.
1206
313
# NO to prevent subgrouping. Alternatively, this can be done per class using
359
# The default value is: NO.
1207
314
# the \nosubgrouping command.
360
1208
361
GROUP_NESTED_COMPOUNDS = NO
1209
362
1210
363
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
1211
364
# (for instance a group of public functions) to be put as a subgroup of that
1212
365
# type (e.g. under the Public Functions section). Set it to NO to prevent
1213
366
# subgrouping. Alternatively, this can be done per class using the
1214
367
# \nosubgrouping command.
1215
368
# The default value is: YES.
1216
315
369
1217
316
SUBGROUPING            = YES
370
SUBGROUPING            = YES
1218
317
371
1223
318
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
372
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
1224
319
# unions are shown inside the group in which they are included (e.g. using
373
# are shown inside the group in which they are included (e.g. using \ingroup)
1225
320
# @ingroup) instead of on a separate page (for HTML and Man pages) or
374
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
1226
321
# section (for LaTeX and RTF).
375
# and RTF).
1227
376
#
1228
377
# Note that this feature does not work in combination with
1229
378
# SEPARATE_MEMBER_PAGES.
1230
379
# The default value is: NO.
1231
322
380
1232
323
INLINE_GROUPED_CLASSES = NO
381
INLINE_GROUPED_CLASSES = NO
1233
324
382
1237
325
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
383
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
1238
326
# unions with only public data fields or simple typedef fields will be shown
384
# with only public data fields or simple typedef fields will be shown inline in
1239
327
# inline in the documentation of the scope in which they are defined (i.e. file,
385
# the documentation of the scope in which they are defined (i.e. file,
1240
328
# namespace, or group documentation), provided this scope is documented. If set
386
# namespace, or group documentation), provided this scope is documented. If set
1243
329
# to NO (the default), structs, classes, and unions are shown on a separate
387
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
1244
330
# page (for HTML and Man pages) or section (for LaTeX and RTF).
388
# Man pages) or section (for LaTeX and RTF).
1245
389
# The default value is: NO.
1246
331
390
1247
332
INLINE_SIMPLE_STRUCTS  = NO
391
INLINE_SIMPLE_STRUCTS  = NO
1248
333
392
1251
334
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
393
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
1252
335
# is documented as struct, union, or enum with the name of the typedef. So
394
# enum is documented as struct, union, or enum with the name of the typedef. So
1253
336
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
395
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
1254
337
# with name TypeT. When disabled the typedef will appear as a member of a file,
396
# with name TypeT. When disabled the typedef will appear as a member of a file,
1257
338
# namespace, or class. And the struct will be named TypeS. This can typically
397
# namespace, or class. And the struct will be named TypeS. This can typically be
1258
339
# be useful for C code in case the coding convention dictates that all compound
398
# useful for C code in case the coding convention dictates that all compound
1259
340
# types are typedef'ed and only the typedef is referenced, never the tag name.
399
# types are typedef'ed and only the typedef is referenced, never the tag name.
1260
400
# The default value is: NO.
1261
341
401
1262
342
TYPEDEF_HIDES_STRUCT   = NO
402
TYPEDEF_HIDES_STRUCT   = NO
1263
343
403
1264
344
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
404
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
1272
345
# cache is used to resolve symbols given their name and scope. Since this can
405
# cache is used to resolve symbols given their name and scope. Since this can be
1273
346
# be an expensive process and often the same symbol appear multiple times in
406
# an expensive process and often the same symbol appears multiple times in the
1274
347
# the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too
407
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
1275
348
# small doxygen will become slower. If the cache is too large, memory is wasted.
408
# doxygen will become slower. If the cache is too large, memory is wasted. The
1276
349
# The cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid
409
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
1277
350
# range is 0..9, the default is 0, corresponding to a cache size of 2^16 = 65536
410
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
1278
351
# symbols.
411
# symbols. At the end of a run doxygen will report the cache usage and suggest
1279
412
# the optimal cache size from a speed point of view.
1280
413
# Minimum value: 0, maximum value: 9, default value: 0.
1281
352
414
1282
353
LOOKUP_CACHE_SIZE      = 0
415
LOOKUP_CACHE_SIZE      = 0
1283
354
416
1284
@@ -356,337 +418,398 @@
1285
356
# Build related configuration options
418
# Build related configuration options
1286
357
#---------------------------------------------------------------------------
419
#---------------------------------------------------------------------------
1287
358
420
1292
359
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
421
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
1293
360
# documentation are documented, even if no documentation was available.
422
# documentation are documented, even if no documentation was available. Private
1294
361
# Private class members and static file members will be hidden unless
423
# class members and static file members will be hidden unless the
1295
362
# the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES
424
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
1296
425
# Note: This will also disable the warnings about undocumented members that are
1297
426
# normally produced when WARNINGS is set to YES.
1298
427
# The default value is: NO.
1299
363
428
1300
364
EXTRACT_ALL            = YES
429
EXTRACT_ALL            = YES
1301
365
430
1304
366
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
431
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
1305
367
# will be included in the documentation.
432
# be included in the documentation.
1306
433
# The default value is: NO.
1307
368
434
1308
369
EXTRACT_PRIVATE        = NO
435
EXTRACT_PRIVATE        = NO
1309
370
436
1311
371
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
437
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
1312
372
# scope will be included in the documentation.
438
# scope will be included in the documentation.
1313
439
# The default value is: NO.
1314
373
440
1315
374
EXTRACT_PACKAGE        = NO
441
EXTRACT_PACKAGE        = NO
1316
375
442
1319
376
# If the EXTRACT_STATIC tag is set to YES all static members of a file
443
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
1320
377
# will be included in the documentation.
444
# included in the documentation.
1321
445
# The default value is: NO.
1322
378
446
1323
379
EXTRACT_STATIC         = NO
447
EXTRACT_STATIC         = NO
1324
380
448
1328
381
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
449
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
1329
382
# defined locally in source files will be included in the documentation.
450
# locally in source files will be included in the documentation. If set to NO,
1330
383
# If set to NO only classes defined in header files are included.
451
# only classes defined in header files are included. Does not have any effect
1331
452
# for Java sources.
1332
453
# The default value is: YES.
1333
384
454
1334
385
EXTRACT_LOCAL_CLASSES  = NO
455
EXTRACT_LOCAL_CLASSES  = NO
1335
386
456
1340
387
# This flag is only useful for Objective-C code. When set to YES local
457
# This flag is only useful for Objective-C code. If set to YES, local methods,
1341
388
# methods, which are defined in the implementation section but not in
458
# which are defined in the implementation section but not in the interface are
1342
389
# the interface are included in the documentation.
459
# included in the documentation. If set to NO, only methods in the interface are
1343
390
# If set to NO (the default) only methods in the interface are included.
460
# included.
1344
461
# The default value is: NO.
1345
391
462
1346
392
EXTRACT_LOCAL_METHODS  = NO
463
EXTRACT_LOCAL_METHODS  = NO
1347
393
464
1348
394
# If this flag is set to YES, the members of anonymous namespaces will be
465
# If this flag is set to YES, the members of anonymous namespaces will be
1349
395
# extracted and appear in the documentation as a namespace called
466
# extracted and appear in the documentation as a namespace called
1353
396
# 'anonymous_namespace{file}', where file will be replaced with the base
467
# 'anonymous_namespace{file}', where file will be replaced with the base name of
1354
397
# name of the file that contains the anonymous namespace. By default
468
# the file that contains the anonymous namespace. By default anonymous namespace
1355
398
# anonymous namespaces are hidden.
469
# are hidden.
1356
470
# The default value is: NO.
1357
399
471
1358
400
EXTRACT_ANON_NSPACES   = NO
472
EXTRACT_ANON_NSPACES   = NO
1359
401
473
1365
402
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
474
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
1366
403
# undocumented members of documented classes, files or namespaces.
475
# undocumented members inside documented classes or files. If set to NO these
1367
404
# If set to NO (the default) these members will be included in the
476
# members will be included in the various overviews, but no documentation
1368
405
# various overviews, but no documentation section is generated.
477
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
1369
406
# This option has no effect if EXTRACT_ALL is enabled.
478
# The default value is: NO.
1370
407
479
1371
408
HIDE_UNDOC_MEMBERS     = NO
480
HIDE_UNDOC_MEMBERS     = NO
1372
409
481
1377
410
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
482
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
1378
411
# undocumented classes that are normally visible in the class hierarchy.
483
# undocumented classes that are normally visible in the class hierarchy. If set
1379
412
# If set to NO (the default) these classes will be included in the various
484
# to NO, these classes will be included in the various overviews. This option
1380
413
# overviews. This option has no effect if EXTRACT_ALL is enabled.
485
# has no effect if EXTRACT_ALL is enabled.
1381
486
# The default value is: NO.
1382
414
487
1383
415
HIDE_UNDOC_CLASSES     = NO
488
HIDE_UNDOC_CLASSES     = NO
1384
416
489
1389
417
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
490
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
1390
418
# friend (class|struct|union) declarations.
491
# (class|struct|union) declarations. If set to NO, these declarations will be
1391
419
# If set to NO (the default) these declarations will be included in the
492
# included in the documentation.
1392
420
# documentation.
493
# The default value is: NO.
1393
421
494
1394
422
HIDE_FRIEND_COMPOUNDS  = NO
495
HIDE_FRIEND_COMPOUNDS  = NO
1395
423
496
1400
424
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
497
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
1401
425
# documentation blocks found inside the body of a function.
498
# documentation blocks found inside the body of a function. If set to NO, these
1402
426
# If set to NO (the default) these blocks will be appended to the
499
# blocks will be appended to the function's detailed documentation block.
1403
427
# function's detailed documentation block.
500
# The default value is: NO.
1404
428
501
1405
429
HIDE_IN_BODY_DOCS      = NO
502
HIDE_IN_BODY_DOCS      = NO
1406
430
503
1411
431
# The INTERNAL_DOCS tag determines if documentation
504
# The INTERNAL_DOCS tag determines if documentation that is typed after a
1412
432
# that is typed after a \internal command is included. If the tag is set
505
# \internal command is included. If the tag is set to NO then the documentation
1413
433
# to NO (the default) then the documentation will be excluded.
506
# will be excluded. Set it to YES to include the internal documentation.
1414
434
# Set it to YES to include the internal documentation.
507
# The default value is: NO.
1415
435
508
1416
436
INTERNAL_DOCS          = NO
509
INTERNAL_DOCS          = NO
1417
437
510
1420
438
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
511
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
1421
439
# file names in lower-case letters. If set to YES upper-case letters are also
512
# names in lower-case letters. If set to YES, upper-case letters are also
1422
440
# allowed. This is useful if you have classes or files whose names only differ
513
# allowed. This is useful if you have classes or files whose names only differ
1423
441
# in case and if your file system supports case sensitive file names. Windows
514
# in case and if your file system supports case sensitive file names. Windows
1424
442
# and Mac users are advised to set this option to NO.
515
# and Mac users are advised to set this option to NO.
1425
516
# The default value is: system dependent.
1426
443
517
1427
444
CASE_SENSE_NAMES       = NO
518
CASE_SENSE_NAMES       = NO
1428
445
519
1432
446
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
520
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
1433
447
# will show members with their full class and namespace scopes in the
521
# their full class and namespace scopes in the documentation. If set to YES, the
1434
448
# documentation. If set to YES the scope will be hidden.
522
# scope will be hidden.
1435
523
# The default value is: NO.
1436
449
524
1437
450
HIDE_SCOPE_NAMES       = NO
525
HIDE_SCOPE_NAMES       = NO
1438
451
526
1442
452
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
527
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
1443
453
# will put a list of the files that are included by a file in the documentation
528
# append additional text to a page's title, such as Class Reference. If set to
1444
454
# of that file.
529
# YES the compound reference will be hidden.
1445
530
# The default value is: NO.
1446
531
1447
532
HIDE_COMPOUND_REFERENCE= NO
1448
533
1449
534
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
1450
535
# the files that are included by a file in the documentation of that file.
1451
536
# The default value is: YES.
1452
455
537
1453
456
SHOW_INCLUDE_FILES     = YES
538
SHOW_INCLUDE_FILES     = YES
1454
457
539
1458
458
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
540
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
1459
459
# will list include files with double quotes in the documentation
541
# grouped member an include statement to the documentation, telling the reader
1460
460
# rather than with sharp brackets.
542
# which file to include in order to use the member.
1461
543
# The default value is: NO.
1462
544
1463
545
SHOW_GROUPED_MEMB_INC  = NO
1464
546
1465
547
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
1466
548
# files with double quotes in the documentation rather than with sharp brackets.
1467
549
# The default value is: NO.
1468
461
550
1469
462
FORCE_LOCAL_INCLUDES   = NO
551
FORCE_LOCAL_INCLUDES   = NO
1470
463
552
1473
464
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
553
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
1474
465
# is inserted in the documentation for inline members.
554
# documentation for inline members.
1475
555
# The default value is: YES.
1476
466
556
1477
467
INLINE_INFO            = YES
557
INLINE_INFO            = YES
1478
468
558
1483
469
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
559
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
1484
470
# will sort the (detailed) documentation of file and class members
560
# (detailed) documentation of file and class members alphabetically by member
1485
471
# alphabetically by member name. If set to NO the members will appear in
561
# name. If set to NO, the members will appear in declaration order.
1486
472
# declaration order.
562
# The default value is: YES.
1487
473
563
1488
474
SORT_MEMBER_DOCS       = YES
564
SORT_MEMBER_DOCS       = YES
1489
475
565
1494
476
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
566
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
1495
477
# brief documentation of file, namespace and class members alphabetically
567
# descriptions of file, namespace and class members alphabetically by member
1496
478
# by member name. If set to NO (the default) the members will appear in
568
# name. If set to NO, the members will appear in declaration order. Note that
1497
479
# declaration order.
569
# this will also influence the order of the classes in the class list.
1498
570
# The default value is: NO.
1499
480
571
1500
481
SORT_BRIEF_DOCS        = NO
572
SORT_BRIEF_DOCS        = NO
1501
482
573
1509
483
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
574
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
1510
484
# will sort the (brief and detailed) documentation of class members so that
575
# (brief and detailed) documentation of class members so that constructors and
1511
485
# constructors and destructors are listed first. If set to NO (the default)
576
# destructors are listed first. If set to NO the constructors will appear in the
1512
486
# the constructors will appear in the respective orders defined by
577
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
1513
487
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
578
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
1514
488
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
579
# member documentation.
1515
489
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
580
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
1516
581
# detailed member documentation.
1517
582
# The default value is: NO.
1518
490
583
1519
491
SORT_MEMBERS_CTORS_1ST = NO
584
SORT_MEMBERS_CTORS_1ST = NO
1520
492
585
1524
493
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
586
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
1525
494
# hierarchy of group names into alphabetical order. If set to NO (the default)
587
# of group names into alphabetical order. If set to NO the group names will
1526
495
# the group names will appear in their defined order.
588
# appear in their defined order.
1527
589
# The default value is: NO.
1528
496
590
1529
497
SORT_GROUP_NAMES       = NO
591
SORT_GROUP_NAMES       = NO
1530
498
592
1535
499
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
593
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
1536
500
# sorted by fully-qualified names, including namespaces. If set to
594
# fully-qualified names, including namespaces. If set to NO, the class list will
1537
501
# NO (the default), the class list will be sorted only by class name,
595
# be sorted only by class name, not including the namespace part.
1534
502
# not including the namespace part.
1538
503
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
596
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
1541
504
# Note: This option applies only to the class list, not to the
597
# Note: This option applies only to the class list, not to the alphabetical
1542
505
# alphabetical list.
598
# list.
1543
599
# The default value is: NO.
1544
506
600
1545
507
SORT_BY_SCOPE_NAME     = NO
601
SORT_BY_SCOPE_NAME     = NO
1546
508
602
1553
509
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
603
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
1554
510
# do proper type resolution of all parameters of a function it will reject a
604
# type resolution of all parameters of a function it will reject a match between
1555
511
# match between the prototype and the implementation of a member function even
605
# the prototype and the implementation of a member function even if there is
1556
512
# if there is only one candidate or it is obvious which candidate to choose
606
# only one candidate or it is obvious which candidate to choose by doing a
1557
513
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
607
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
1558
514
# will still accept a match between prototype and implementation in such cases.
608
# accept a match between prototype and implementation in such cases.
1559
609
# The default value is: NO.
1560
515
610
1561
516
STRICT_PROTO_MATCHING  = NO
611
STRICT_PROTO_MATCHING  = NO
1562
517
612
1566
518
# The GENERATE_TODOLIST tag can be used to enable (YES) or
613
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
1567
519
# disable (NO) the todo list. This list is created by putting \todo
614
# list. This list is created by putting \todo commands in the documentation.
1568
520
# commands in the documentation.
615
# The default value is: YES.
1569
521
616
1570
522
GENERATE_TODOLIST      = YES
617
GENERATE_TODOLIST      = YES
1571
523
618
1575
524
# The GENERATE_TESTLIST tag can be used to enable (YES) or
619
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
1576
525
# disable (NO) the test list. This list is created by putting \test
620
# list. This list is created by putting \test commands in the documentation.
1577
526
# commands in the documentation.
621
# The default value is: YES.
1578
527
622
1579
528
GENERATE_TESTLIST      = YES
623
GENERATE_TESTLIST      = YES
1580
529
624
1584
530
# The GENERATE_BUGLIST tag can be used to enable (YES) or
625
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
1585
531
# disable (NO) the bug list. This list is created by putting \bug
626
# list. This list is created by putting \bug commands in the documentation.
1586
532
# commands in the documentation.
627
# The default value is: YES.
1587
533
628
1588
534
GENERATE_BUGLIST       = YES
629
GENERATE_BUGLIST       = YES
1589
535
630
1593
536
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
631
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
1594
537
# disable (NO) the deprecated list. This list is created by putting
632
# the deprecated list. This list is created by putting \deprecated commands in
1595
538
# \deprecated commands in the documentation.
633
# the documentation.
1596
634
# The default value is: YES.
1597
539
635
1598
540
GENERATE_DEPRECATEDLIST= YES
636
GENERATE_DEPRECATEDLIST= YES
1599
541
637
1603
542
# The ENABLED_SECTIONS tag can be used to enable conditional
638
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
1604
543
# documentation sections, marked by \if section-label ... \endif
639
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
1605
544
# and \cond section-label ... \endcond blocks.
640
# ... \endcond blocks.
1606
545
641
1607
546
ENABLED_SECTIONS       =
642
ENABLED_SECTIONS       =
1608
547
643
1616
548
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
644
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
1617
549
# the initial value of a variable or macro consists of for it to appear in
645
# initial value of a variable or macro / define can have for it to appear in the
1618
550
# the documentation. If the initializer consists of more lines than specified
646
# documentation. If the initializer consists of more lines than specified here
1619
551
# here it will be hidden. Use a value of 0 to hide initializers completely.
647
# it will be hidden. Use a value of 0 to hide initializers completely. The
1620
552
# The appearance of the initializer of individual variables and macros in the
648
# appearance of the value of individual variables and macros / defines can be
1621
553
# documentation can be controlled using \showinitializer or \hideinitializer
649
# controlled using \showinitializer or \hideinitializer command in the
1622
554
# command in the documentation regardless of this setting.
650
# documentation regardless of this setting.
1623
651
# Minimum value: 0, maximum value: 10000, default value: 30.
1624
555
652
1625
556
MAX_INITIALIZER_LINES  = 30
653
MAX_INITIALIZER_LINES  = 30
1626
557
654
1629
558
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
655
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
1630
559
# at the bottom of the documentation of classes and structs. If set to YES the
656
# the bottom of the documentation of classes and structs. If set to YES, the
1631
560
# list will mention the files that were used to generate the documentation.
657
# list will mention the files that were used to generate the documentation.
1632
658
# The default value is: YES.
1633
561
659
1634
562
SHOW_USED_FILES        = YES
660
SHOW_USED_FILES        = YES
1635
563
661
1639
564
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
662
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
1640
565
# This will remove the Files entry from the Quick Index and from the
663
# will remove the Files entry from the Quick Index and from the Folder Tree View
1641
566
# Folder Tree View (if specified). The default is YES.
664
# (if specified).
1642
665
# The default value is: YES.
1643
567
666
1644
568
SHOW_FILES             = YES
667
SHOW_FILES             = YES
1645
569
668
1650
570
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
669
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
1651
571
# Namespaces page.
670
# page. This will remove the Namespaces entry from the Quick Index and from the
1652
572
# This will remove the Namespaces entry from the Quick Index
671
# Folder Tree View (if specified).
1653
573
# and from the Folder Tree View (if specified). The default is YES.
672
# The default value is: YES.
1654
574
673
1655
575
SHOW_NAMESPACES        = YES
674
SHOW_NAMESPACES        = YES
1656
576
675
1657
577
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
676
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
1658
578
# doxygen should invoke to get the current version for each file (typically from
677
# doxygen should invoke to get the current version for each file (typically from
1659
579
# the version control system). Doxygen will invoke the program by executing (via
678
# the version control system). Doxygen will invoke the program by executing (via
1664
580
# popen()) the command <command> <input-file>, where <command> is the value of
679
# popen()) the command command input-file, where command is the value of the
1665
581
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
680
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
1666
582
# provided by doxygen. Whatever the program writes to standard output
681
# by doxygen. Whatever the program writes to standard output is used as the file
1667
583
# is used as the file version. See the manual for examples.
682
# version. For an example see the documentation.
1668
584
683
1669
585
FILE_VERSION_FILTER    =
684
FILE_VERSION_FILTER    =
1670
586
685
1671
587
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
686
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
1672
588
# by doxygen. The layout file controls the global structure of the generated
687
# by doxygen. The layout file controls the global structure of the generated
1673
589
# output files in an output format independent way. To create the layout file
688
# output files in an output format independent way. To create the layout file
1677
590
# that represents doxygen's defaults, run doxygen with the -l option.
689
# that represents doxygen's defaults, run doxygen with the -l option. You can
1678
591
# You can optionally specify a file name after the option, if omitted
690
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
1679
592
# DoxygenLayout.xml will be used as the name of the layout file.
691
# will be used as the name of the layout file.
1680
692
#
1681
693
# Note that if you run doxygen from a directory containing a file called
1682
694
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
1683
695
# tag is left empty.
1684
593
696
1685
594
LAYOUT_FILE            =
697
LAYOUT_FILE            =
1686
595
698
1695
596
# The CITE_BIB_FILES tag can be used to specify one or more bib files
699
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
1696
597
# containing the references data. This must be a list of .bib files. The
700
# the reference definitions. This must be a list of .bib files. The .bib
1697
598
# .bib extension is automatically appended if omitted. Using this command
701
# extension is automatically appended if omitted. This requires the bibtex tool
1698
599
# requires the bibtex tool to be installed. See also
702
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
1699
600
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
703
# For LaTeX the style of the bibliography can be controlled using
1700
601
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
704
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
1701
602
# feature you need bibtex and perl available in the search path. Do not use
705
# search path. See also \cite for info how to create references.
1694
603
# file names with spaces, bibtex cannot handle them.
1702
604
706
1703
605
CITE_BIB_FILES         =
707
CITE_BIB_FILES         =
1704
606
708
1705
607
#---------------------------------------------------------------------------
709
#---------------------------------------------------------------------------
1707
608
# configuration options related to warning and progress messages
710
# Configuration options related to warning and progress messages
1708
609
#---------------------------------------------------------------------------
711
#---------------------------------------------------------------------------
1709
610
712
1712
611
# The QUIET tag can be used to turn on/off the messages that are generated
713
# The QUIET tag can be used to turn on/off the messages that are generated to
1713
612
# by doxygen. Possible values are YES and NO. If left blank NO is used.
714
# standard output by doxygen. If QUIET is set to YES this implies that the
1714
715
# messages are off.
1715
716
# The default value is: NO.
1716
613
717
1717
614
QUIET                  = NO
718
QUIET                  = NO
1718
615
719
1719
616
# The WARNINGS tag can be used to turn on/off the warning messages that are
720
# The WARNINGS tag can be used to turn on/off the warning messages that are
1722
617
# generated by doxygen. Possible values are YES and NO. If left blank
721
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
1723
618
# NO is used.
722
# this implies that the warnings are on.
1724
723
#
1725
724
# Tip: Turn warnings on while writing the documentation.
1726
725
# The default value is: YES.
1727
619
726
1728
620
WARNINGS               = YES
727
WARNINGS               = YES
1729
621
728
1733
622
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
729
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
1734
623
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
730
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
1735
624
# automatically be disabled.
731
# will automatically be disabled.
1736
732
# The default value is: YES.
1737
625
733
1738
626
WARN_IF_UNDOCUMENTED   = YES
734
WARN_IF_UNDOCUMENTED   = YES
1739
627
735
1744
628
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
736
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
1745
629
# potential errors in the documentation, such as not documenting some
737
# potential errors in the documentation, such as not documenting some parameters
1746
630
# parameters in a documented function, or documenting parameters that
738
# in a documented function, or documenting parameters that don't exist or using
1747
631
# don't exist or using markup commands wrongly.
739
# markup commands wrongly.
1748
740
# The default value is: YES.
1749
632
741
1750
633
WARN_IF_DOC_ERROR      = YES
742
WARN_IF_DOC_ERROR      = YES
1751
634
743
1757
635
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
744
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
1758
636
# functions that are documented, but have no documentation for their parameters
745
# are documented, but have no documentation for their parameters or return
1759
637
# or return value. If set to NO (the default) doxygen will only warn about
746
# value. If set to NO, doxygen will only warn about wrong or incomplete
1760
638
# wrong or incomplete parameter documentation, but not about the absence of
747
# parameter documentation, but not about the absence of documentation.
1761
639
# documentation.
748
# The default value is: NO.
1762
640
749
1763
641
WARN_NO_PARAMDOC       = NO
750
WARN_NO_PARAMDOC       = NO
1764
642
751
1771
643
# The WARN_FORMAT tag determines the format of the warning messages that
752
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
1772
644
# doxygen can produce. The string should contain the $file, $line, and $text
753
# a warning is encountered.
1773
645
# tags, which will be replaced by the file and line number from which the
754
# The default value is: NO.
1774
646
# warning originated and the warning text. Optionally the format may contain
755
1775
647
# $version, which will be replaced by the version of the file (if it could
756
WARN_AS_ERROR          = NO
1776
648
# be obtained via FILE_VERSION_FILTER)
757
1777
758
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
1778
759
# can produce. The string should contain the $file, $line, and $text tags, which
1779
760
# will be replaced by the file and line number from which the warning originated
1780
761
# and the warning text. Optionally the format may contain $version, which will
1781
762
# be replaced by the version of the file (if it could be obtained via
1782
763
# FILE_VERSION_FILTER)
1783
764
# The default value is: $file:$line: $text.
1784
649
765
1785
650
WARN_FORMAT            = "$file:$line: $text"
766
WARN_FORMAT            = "$file:$line: $text"
1786
651
767
1790
652
# The WARN_LOGFILE tag can be used to specify a file to which warning
768
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
1791
653
# and error messages should be written. If left blank the output is written
769
# messages should be written. If left blank the output is written to standard
1792
654
# to stderr.
770
# error (stderr).
1793
655
771
1794
656
WARN_LOGFILE           =
772
WARN_LOGFILE           =
1795
657
773
1796
658
#---------------------------------------------------------------------------
774
#---------------------------------------------------------------------------
1798
659
# configuration options related to the input files
775
# Configuration options related to the input files
1799
660
#---------------------------------------------------------------------------
776
#---------------------------------------------------------------------------
1800
661
777
1805
662
# The INPUT tag can be used to specify the files and/or directories that contain
778
# The INPUT tag is used to specify the files and/or directories that contain
1806
663
# documented source files. You may enter file names like "myfile.cpp" or
779
# documented source files. You may enter file names like myfile.cpp or
1807
664
# directories like "/usr/src/myproject". Separate the files or directories
780
# directories like /usr/src/myproject. Separate the files or directories with
1808
665
# with spaces.
781
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
1809
782
# Note: If this tag is empty the current directory is searched.
1810
666
783
1811
667
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/README.md \
784
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/README.md \
1812
668
                         @CMAKE_CURRENT_SOURCE_DIR@/HACKING.md \
785
                         @CMAKE_CURRENT_SOURCE_DIR@/HACKING.md \
1813
669
                         @CMAKE_CURRENT_SOURCE_DIR@/doc \
786
                         @CMAKE_CURRENT_SOURCE_DIR@/doc \
1814
670
                         @CMAKE_CURRENT_SOURCE_DIR@/src \
1815
671
                         @CMAKE_CURRENT_SOURCE_DIR@/examples \
787
                         @CMAKE_CURRENT_SOURCE_DIR@/examples \
1816
672
                         @CMAKE_CURRENT_SOURCE_DIR@/include \
788
                         @CMAKE_CURRENT_SOURCE_DIR@/include \
1817
673
                         @MIR_GENERATED_INCLUDE_DIRECTORIES@
789
                         @MIR_GENERATED_INCLUDE_DIRECTORIES@
1818
674
790
1819
675
# This tag can be used to specify the character encoding of the source files
791
# This tag can be used to specify the character encoding of the source files
1824
676
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
792
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
1825
677
# also the default input encoding. Doxygen uses libiconv (or the iconv built
793
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
1826
678
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
794
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
1827
679
# the list of possible encodings.
795
# possible encodings.
1828
796
# The default value is: UTF-8.
1829
680
797
1830
681
INPUT_ENCODING         = UTF-8
798
INPUT_ENCODING         = UTF-8
1831
682
799
1832
683
# If the value of the INPUT tag contains directories, you can use the
800
# If the value of the INPUT tag contains directories, you can use the
1839
684
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
801
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
1840
685
# and *.h) to filter out the source-files in the directories. If left
802
# *.h) to filter out the source-files in the directories.
1841
686
# blank the following patterns are tested:
803
#
1842
687
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
804
# Note that for custom extensions or not directly supported extensions you also
1843
688
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
805
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1844
689
# *.f90 *.f *.for *.vhd *.vhdl
806
# read by doxygen.
1845
807
#
1846
808
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
1847
809
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
1848
810
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
1849
811
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
1850
812
# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
1851
690
813
1852
691
FILE_PATTERNS          = *.c \
814
FILE_PATTERNS          = *.c \
1853
692
                         *.cc \
815
                         *.cc \
1854
@@ -723,15 +846,16 @@
1855
723
                         *.vhd \
846
                         *.vhd \
1856
724
                         *.vhdl
847
                         *.vhdl
1857
725
848
1861
726
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
849
# The RECURSIVE tag can be used to specify whether or not subdirectories should
1862
727
# should be searched for input files as well. Possible values are YES and NO.
850
# be searched for input files as well.
1863
728
# If left blank NO is used.
851
# The default value is: NO.
1864
729
852
1865
730
RECURSIVE              = YES
853
RECURSIVE              = YES
1866
731
854
1867
732
# The EXCLUDE tag can be used to specify files and/or directories that should be
855
# The EXCLUDE tag can be used to specify files and/or directories that should be
1868
733
# excluded from the INPUT source files. This way you can easily exclude a
856
# excluded from the INPUT source files. This way you can easily exclude a
1869
734
# subdirectory from a directory tree whose root is specified with the INPUT tag.
857
# subdirectory from a directory tree whose root is specified with the INPUT tag.
1870
858
#
1871
735
# Note that relative paths are relative to the directory from which doxygen is
859
# Note that relative paths are relative to the directory from which doxygen is
1872
736
# run.
860
# run.
1873
737
861
1874
@@ -740,234 +864,323 @@
1875
740
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
864
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1876
741
# directories that are symbolic links (a Unix file system feature) are excluded
865
# directories that are symbolic links (a Unix file system feature) are excluded
1877
742
# from the input.
866
# from the input.
1878
867
# The default value is: NO.
1879
743
868
1880
744
EXCLUDE_SYMLINKS       = NO
869
EXCLUDE_SYMLINKS       = NO
1881
745
870
1882
746
# If the value of the INPUT tag contains directories, you can use the
871
# If the value of the INPUT tag contains directories, you can use the
1883
747
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
872
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1887
748
# certain files from those directories. Note that the wildcards are matched
873
# certain files from those directories.
1888
749
# against the file with absolute path, so to exclude all test directories
874
#
1889
750
# for example use the pattern */test/*
875
# Note that the wildcards are matched against the file with absolute path, so to
1890
876
# exclude all test directories for example use the pattern */test/*
1891
751
877
1893
752
EXCLUDE_PATTERNS       = */include/test/* */3rd_party/*
878
EXCLUDE_PATTERNS       = */include/test/* \
1894
879
                         */3rd_party/*
1895
753
880
1896
754
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
881
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1897
755
# (namespaces, classes, functions, etc.) that should be excluded from the
882
# (namespaces, classes, functions, etc.) that should be excluded from the
1898
756
# output. The symbol name can be a fully qualified name, a word, or if the
883
# output. The symbol name can be a fully qualified name, a word, or if the
1899
757
# wildcard * is used, a substring. Examples: ANamespace, AClass,
884
# wildcard * is used, a substring. Examples: ANamespace, AClass,
1900
758
# AClass::ANamespace, ANamespace::*Test
885
# AClass::ANamespace, ANamespace::*Test
1901
886
#
1902
887
# Note that the wildcards are matched against the file with absolute path, so to
1903
888
# exclude all test directories use the pattern */test/*
1904
759
889
1905
760
EXCLUDE_SYMBOLS        = google \
890
EXCLUDE_SYMBOLS        = google \
1906
761
                         mfd \
891
                         mfd \
1907
762
                         mgg \
892
                         mgg \
1908
763
                         mp
893
                         mp
1909
764
894
1913
765
# The EXAMPLE_PATH tag can be used to specify one or more files or
895
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
1914
766
# directories that contain example code fragments that are included (see
896
# that contain example code fragments that are included (see the \include
1915
767
# the \include command).
897
# command).
1916
768
898
1917
769
EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/examples
899
EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/examples
1918
770
900
1919
771
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
901
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1923
772
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
902
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1924
773
# and *.h) to filter out the source-files in the directories. If left
903
# *.h) to filter out the source-files in the directories. If left blank all
1925
774
# blank all files are included.
904
# files are included.
1926
775
905
1927
776
EXAMPLE_PATTERNS       = *
906
EXAMPLE_PATTERNS       = *
1928
777
907
1929
778
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
908
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1933
779
# searched for input files to be used with the \include or \dontinclude
909
# searched for input files to be used with the \include or \dontinclude commands
1934
780
# commands irrespective of the value of the RECURSIVE tag.
910
# irrespective of the value of the RECURSIVE tag.
1935
781
# Possible values are YES and NO. If left blank NO is used.
911
# The default value is: NO.
1936
782
912
1937
783
EXAMPLE_RECURSIVE      = NO
913
EXAMPLE_RECURSIVE      = NO
1938
784
914
1942
785
# The IMAGE_PATH tag can be used to specify one or more files or
915
# The IMAGE_PATH tag can be used to specify one or more files or directories
1943
786
# directories that contain image that are included in the documentation (see
916
# that contain images that are to be included in the documentation (see the
1944
787
# the \image command).
917
# \image command).
1945
788
918
1946
789
IMAGE_PATH             =
919
IMAGE_PATH             =
1947
790
920
1948
791
# The INPUT_FILTER tag can be used to specify a program that doxygen should
921
# The INPUT_FILTER tag can be used to specify a program that doxygen should
1949
792
# invoke to filter for each input file. Doxygen will invoke the filter program
922
# invoke to filter for each input file. Doxygen will invoke the filter program
1955
793
# by executing (via popen()) the command <filter> <input-file>, where <filter>
923
# by executing (via popen()) the command:
1956
794
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
924
#
1957
795
# input file. Doxygen will then use the output that the filter program writes
925
# <filter> <input-file>
1958
796
# to standard output.
926
#
1959
797
# If FILTER_PATTERNS is specified, this tag will be ignored.
927
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1960
928
# name of an input file. Doxygen will then use the output that the filter
1961
929
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1962
930
# will be ignored.
1963
931
#
1964
798
# Note that the filter must not add or remove lines; it is applied before the
932
# Note that the filter must not add or remove lines; it is applied before the
1965
799
# code is scanned, but not when the output code is generated. If lines are added
933
# code is scanned, but not when the output code is generated. If lines are added
1966
800
# or removed, the anchors will not be placed correctly.
934
# or removed, the anchors will not be placed correctly.
1967
935
#
1968
936
# Note that for custom extensions or not directly supported extensions you also
1969
937
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1970
938
# properly processed by doxygen.
1971
801
939
1972
802
INPUT_FILTER           =
940
INPUT_FILTER           =
1973
803
941
1974
804
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
942
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1982
805
# basis.
943
# basis. Doxygen will compare the file name with each pattern and apply the
1983
806
# Doxygen will compare the file name with each pattern and apply the
944
# filter if there is a match. The filters are a list of the form: pattern=filter
1984
807
# filter if there is a match.
945
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1985
808
# The filters are a list of the form:
946
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1986
809
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
947
# patterns match the file name, INPUT_FILTER is applied.
1987
810
# info on how filters are used. If FILTER_PATTERNS is empty or if
948
#
1988
811
# non of the patterns match the file name, INPUT_FILTER is applied.
949
# Note that for custom extensions or not directly supported extensions you also
1989
950
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1990
951
# properly processed by doxygen.
1991
812
952
1992
813
FILTER_PATTERNS        =
953
FILTER_PATTERNS        =
1993
814
954
1994
815
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
955
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1997
816
# INPUT_FILTER) will be used to filter the input files when producing source
956
# INPUT_FILTER) will also be used to filter the input files that are used for
1998
817
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
957
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1999
958
# The default value is: NO.
2000
818
959
2001
819
FILTER_SOURCE_FILES    = NO
960
FILTER_SOURCE_FILES    = NO
2002
820
961
2003
821
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
962
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
2008
822
# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
963
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
2009
823
# and it is also possible to disable source filtering for a specific pattern
964
# it is also possible to disable source filtering for a specific pattern using
2010
824
# using *.ext= (so without naming a filter). This option only has effect when
965
# *.ext= (so without naming a filter).
2011
825
# FILTER_SOURCE_FILES is enabled.
966
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
2012
826
967
2013
827
FILTER_SOURCE_PATTERNS =
968
FILTER_SOURCE_PATTERNS =
2014
828
969
2016
829
# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
970
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
2017
830
# is part of the input, its contents will be placed on the main page
971
# is part of the input, its contents will be placed on the main page
2018
831
# (index.html). This can be useful if you have a project on for instance GitHub
972
# (index.html). This can be useful if you have a project on for instance GitHub
2020
832
# and want reuse the introduction page also for the doxygen output.
973
# and want to reuse the introduction page also for the doxygen output.
2021
833
974
2022
834
USE_MDFILE_AS_MAINPAGE =
975
USE_MDFILE_AS_MAINPAGE =
2023
835
976
2024
836
#---------------------------------------------------------------------------
977
#---------------------------------------------------------------------------
2026
837
# configuration options related to source browsing
978
# Configuration options related to source browsing
2027
838
#---------------------------------------------------------------------------
979
#---------------------------------------------------------------------------
2028
839
980
2033
840
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
981
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
2034
841
# be generated. Documented entities will be cross-referenced with these sources.
982
# generated. Documented entities will be cross-referenced with these sources.
2035
842
# Note: To get rid of all source code in the generated output, make sure also
983
#
2036
843
# VERBATIM_HEADERS is set to NO.
984
# Note: To get rid of all source code in the generated output, make sure that
2037
985
# also VERBATIM_HEADERS is set to NO.
2038
986
# The default value is: NO.
2039
844
987
2040
845
SOURCE_BROWSER         = NO
988
SOURCE_BROWSER         = NO
2041
846
989
2044
847
# Setting the INLINE_SOURCES tag to YES will include the body
990
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
2045
848
# of functions and classes directly in the documentation.
991
# classes and enums directly into the documentation.
2046
992
# The default value is: NO.
2047
849
993
2048
850
INLINE_SOURCES         = NO
994
INLINE_SOURCES         = NO
2049
851
995
2053
852
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
996
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
2054
853
# doxygen to hide any special comment blocks from generated source code
997
# special comment blocks from generated source code fragments. Normal C, C++ and
2055
854
# fragments. Normal C, C++ and Fortran comments will always remain visible.
998
# Fortran comments will always remain visible.
2056
999
# The default value is: YES.
2057
855
1000
2058
856
STRIP_CODE_COMMENTS    = YES
1001
STRIP_CODE_COMMENTS    = YES
2059
857
1002
2063
858
# If the REFERENCED_BY_RELATION tag is set to YES
1003
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
2064
859
# then for each documented function all documented
1004
# function all documented functions referencing it will be listed.
2065
860
# functions referencing it will be listed.
1005
# The default value is: NO.
2066
861
1006
2067
862
REFERENCED_BY_RELATION = NO
1007
REFERENCED_BY_RELATION = NO
2068
863
1008
2072
864
# If the REFERENCES_RELATION tag is set to YES
1009
# If the REFERENCES_RELATION tag is set to YES then for each documented function
2073
865
# then for each documented function all documented entities
1010
# all documented entities called/used by that function will be listed.
2074
866
# called/used by that function will be listed.
1011
# The default value is: NO.
2075
867
1012
2076
868
REFERENCES_RELATION    = NO
1013
REFERENCES_RELATION    = NO
2077
869
1014
2083
870
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
1015
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
2084
871
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
1016
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
2085
872
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
1017
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
2086
873
# link to the source code.
1018
# link to the documentation.
2087
874
# Otherwise they will link to the documentation.
1019
# The default value is: YES.
2088
875
1020
2089
876
REFERENCES_LINK_SOURCE = YES
1021
REFERENCES_LINK_SOURCE = YES
2090
877
1022
2096
878
# If the USE_HTAGS tag is set to YES then the references to source code
1023
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
2097
879
# will point to the HTML generated by the htags(1) tool instead of doxygen
1024
# source code will show a tooltip with additional information such as prototype,
2098
880
# built-in source browser. The htags tool is part of GNU's global source
1025
# brief description and links to the definition and documentation. Since this
2099
881
# tagging system (see http://www.gnu.org/software/global/global.html). You
1026
# will make the HTML file larger and loading of large files a bit slower, you
2100
882
# will need version 4.8.6 or higher.
1027
# can opt to disable this feature.
2101
1028
# The default value is: YES.
2102
1029
# This tag requires that the tag SOURCE_BROWSER is set to YES.
2103
1030
2104
1031
SOURCE_TOOLTIPS        = YES
2105
1032
2106
1033
# If the USE_HTAGS tag is set to YES then the references to source code will
2107
1034
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
2108
1035
# source browser. The htags tool is part of GNU's global source tagging system
2109
1036
# (see http://www.gnu.org/software/global/global.html). You will need version
2110
1037
# 4.8.6 or higher.
2111
1038
#
2112
1039
# To use it do the following:
2113
1040
# - Install the latest version of global
2114
1041
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
2115
1042
# - Make sure the INPUT points to the root of the source tree
2116
1043
# - Run doxygen as normal
2117
1044
#
2118
1045
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
2119
1046
# tools must be available from the command line (i.e. in the search path).
2120
1047
#
2121
1048
# The result: instead of the source browser generated by doxygen, the links to
2122
1049
# source code will now point to the output of htags.
2123
1050
# The default value is: NO.
2124
1051
# This tag requires that the tag SOURCE_BROWSER is set to YES.
2125
883
1052
2126
884
USE_HTAGS              = NO
1053
USE_HTAGS              = NO
2127
885
1054
2131
886
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
1055
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
2132
887
# will generate a verbatim copy of the header file for each class for
1056
# verbatim copy of the header file for each class for which an include is
2133
888
# which an include is specified. Set to NO to disable this.
1057
# specified. Set to NO to disable this.
2134
1058
# See also: Section \class.
2135
1059
# The default value is: YES.
2136
889
1060
2137
890
VERBATIM_HEADERS       = YES
1061
VERBATIM_HEADERS       = YES
2138
891
1062
2146
892
#---------------------------------------------------------------------------
1063
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
2147
893
# configuration options related to the alphabetical class index
1064
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
2148
894
#---------------------------------------------------------------------------
1065
# cost of reduced performance. This can be particularly helpful with template
2149
895
1066
# rich C++ code for which doxygen's built-in parser lacks the necessary type
2150
896
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
1067
# information.
2151
897
# of all compounds will be generated. Enable this if the project
1068
# Note: The availability of this option depends on whether or not doxygen was
2152
898
# contains a lot of classes, structs, unions or interfaces.
1069
# generated with the -Duse-libclang=ON option for CMake.
2153
1070
# The default value is: NO.
2154
1071
2155
1072
CLANG_ASSISTED_PARSING = NO
2156
1073
2157
1074
# If clang assisted parsing is enabled you can provide the compiler with command
2158
1075
# line options that you would normally use when invoking the compiler. Note that
2159
1076
# the include paths will already be set by doxygen for the files and directories
2160
1077
# specified with INPUT and INCLUDE_PATH.
2161
1078
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
2162
1079
2163
1080
CLANG_OPTIONS          =
2164
1081
2165
1082
#---------------------------------------------------------------------------
2166
1083
# Configuration options related to the alphabetical class index
2167
1084
#---------------------------------------------------------------------------
2168
1085
2169
1086
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
2170
1087
# compounds will be generated. Enable this if the project contains a lot of
2171
1088
# classes, structs, unions or interfaces.
2172
1089
# The default value is: YES.
2173
899
1090
2174
900
ALPHABETICAL_INDEX     = YES
1091
ALPHABETICAL_INDEX     = YES
2175
901
1092
2179
902
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
1093
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
2180
903
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
1094
# which the alphabetical index list will be split.
2181
904
# in which this list will be split (can be a number in the range [1..20])
1095
# Minimum value: 1, maximum value: 20, default value: 5.
2182
1096
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
2183
905
1097
2184
906
COLS_IN_ALPHA_INDEX    = 5
1098
COLS_IN_ALPHA_INDEX    = 5
2185
907
1099
2190
908
# In case all classes in a project start with a common prefix, all
1100
# In case all classes in a project start with a common prefix, all classes will
2191
909
# classes will be put under the same header in the alphabetical index.
1101
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
2192
910
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
1102
# can be used to specify a prefix (or a list of prefixes) that should be ignored
2193
911
# should be ignored while generating the index headers.
1103
# while generating the index headers.
2194
1104
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
2195
912
1105
2196
913
IGNORE_PREFIX          =
1106
IGNORE_PREFIX          =
2197
914
1107
2198
915
#---------------------------------------------------------------------------
1108
#---------------------------------------------------------------------------
2200
916
# configuration options related to the HTML output
1109
# Configuration options related to the HTML output
2201
917
#---------------------------------------------------------------------------
1110
#---------------------------------------------------------------------------
2202
918
1111
2205
919
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
1112
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
2206
920
# generate HTML output.
1113
# The default value is: YES.
2207
921
1114
2208
922
GENERATE_HTML          = YES
1115
GENERATE_HTML          = YES
2209
923
1116
2213
924
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1117
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
2214
925
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1118
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2215
926
# put in front of it. If left blank `html' will be used as the default path.
1119
# it.
2216
1120
# The default directory is: html.
2217
1121
# This tag requires that the tag GENERATE_HTML is set to YES.
2218
927
1122
2219
928
HTML_OUTPUT            = html
1123
HTML_OUTPUT            = html
2220
929
1124
2224
930
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
1125
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
2225
931
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
1126
# generated HTML page (for example: .htm, .php, .asp).
2226
932
# doxygen will generate files with .html extension.
1127
# The default value is: .html.
2227
1128
# This tag requires that the tag GENERATE_HTML is set to YES.
2228
933
1129
2229
934
HTML_FILE_EXTENSION    = .html
1130
HTML_FILE_EXTENSION    = .html
2230
935
1131
2241
936
# The HTML_HEADER tag can be used to specify a personal HTML header for
1132
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
2242
937
# each generated HTML page. If it is left blank doxygen will generate a
1133
# each generated HTML page. If the tag is left blank doxygen will generate a
2243
938
# standard header. Note that when using a custom header you are responsible
1134
# standard header.
2244
939
#  for the proper inclusion of any scripts and style sheets that doxygen
1135
#
2245
940
# needs, which is dependent on the configuration options used.
1136
# To get valid HTML the header file that includes any scripts and style sheets
2246
941
# It is advised to generate a default header using "doxygen -w html
1137
# that doxygen needs, which is dependent on the configuration options used (e.g.
2247
942
# header.html footer.html stylesheet.css YourConfigFile" and then modify
1138
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
2248
943
# that header. Note that the header is subject to change so you typically
1139
# default header using
2249
944
# have to redo this when upgrading to a newer version of doxygen or when
1140
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
2250
945
# changing the value of configuration settings such as GENERATE_TREEVIEW!
1141
# YourConfigFile
2251
1142
# and then modify the file new_header.html. See also section "Doxygen usage"
2252
1143
# for information on how to generate the default header that doxygen normally
2253
1144
# uses.
2254
1145
# Note: The header is subject to change so you typically have to regenerate the
2255
1146
# default header when upgrading to a newer version of doxygen. For a description
2256
1147
# of the possible markers and block names see the documentation.
2257
1148
# This tag requires that the tag GENERATE_HTML is set to YES.
2258
946
1149
2259
947
HTML_HEADER            =
1150
HTML_HEADER            =
2260
948
1151
2264
949
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
1152
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
2265
950
# each generated HTML page. If it is left blank doxygen will generate a
1153
# generated HTML page. If the tag is left blank doxygen will generate a standard
2266
951
# standard footer.
1154
# footer. See HTML_HEADER for more information on how to generate a default
2267
1155
# footer and what special commands can be used inside the footer. See also
2268
1156
# section "Doxygen usage" for information on how to generate the default footer
2269
1157
# that doxygen normally uses.
2270
1158
# This tag requires that the tag GENERATE_HTML is set to YES.
2271
952
1159
2272
953
HTML_FOOTER            = @CMAKE_BINARY_DIR@/doc/footer.html
1160
HTML_FOOTER            = @CMAKE_BINARY_DIR@/doc/footer.html
2273
954
1161
2280
955
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
1162
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
2281
956
# style sheet that is used by each HTML page. It can be used to
1163
# sheet that is used by each HTML page. It can be used to fine-tune the look of
2282
957
# fine-tune the look of the HTML output. If left blank doxygen will
1164
# the HTML output. If left blank doxygen will generate a default style sheet.
2283
958
# generate a default style sheet. Note that it is recommended to use
1165
# See also section "Doxygen usage" for information on how to generate the style
2284
959
# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
1166
# sheet that doxygen normally uses.
2285
960
# tag will in the future become obsolete.
1167
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
2286
1168
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
2287
1169
# obsolete.
2288
1170
# This tag requires that the tag GENERATE_HTML is set to YES.
2289
961
1171
2290
962
HTML_STYLESHEET        =
1172
HTML_STYLESHEET        =
2291
963
1173
2299
964
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
1174
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2300
965
# user-defined cascading style sheet that is included after the standard
1175
# cascading style sheets that are included after the standard style sheets
2301
966
# style sheets created by doxygen. Using this option one can overrule
1176
# created by doxygen. Using this option one can overrule certain style aspects.
2302
967
# certain style aspects. This is preferred over using HTML_STYLESHEET
1177
# This is preferred over using HTML_STYLESHEET since it does not replace the
2303
968
# since it does not replace the standard style sheet and is therefor more
1178
# standard style sheet and is therefore more robust against future updates.
2304
969
# robust against future updates. Doxygen will copy the style sheet file to
1179
# Doxygen will copy the style sheet files to the output directory.
2305
970
# the output directory.
1180
# Note: The order of the extra style sheet files is of importance (e.g. the last
2306
1181
# style sheet in the list overrules the setting of the previous ones in the
2307
1182
# list). For an example see the documentation.
2308
1183
# This tag requires that the tag GENERATE_HTML is set to YES.
2309
971
1184
2310
972
HTML_EXTRA_STYLESHEET  = @CMAKE_BINARY_DIR@/doc/extra.css
1185
HTML_EXTRA_STYLESHEET  = @CMAKE_BINARY_DIR@/doc/extra.css
2311
973
1186
2312
@@ -975,632 +1188,847 @@
2313
975
# other source files which should be copied to the HTML output directory. Note
1188
# other source files which should be copied to the HTML output directory. Note
2314
976
# that these files will be copied to the base HTML output directory. Use the
1189
# that these files will be copied to the base HTML output directory. Use the
2315
977
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1190
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
2318
978
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
1191
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
2319
979
# the files will be copied as-is; there are no commands or markers available.
1192
# files will be copied as-is; there are no commands or markers available.
2320
1193
# This tag requires that the tag GENERATE_HTML is set to YES.
2321
980
1194
2322
981
HTML_EXTRA_FILES       =
1195
HTML_EXTRA_FILES       =
2323
982
1196
2331
983
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
1197
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
2332
984
# Doxygen will adjust the colors in the style sheet and background images
1198
# will adjust the colors in the style sheet and background images according to
2333
985
# according to this color. Hue is specified as an angle on a colorwheel,
1199
# this color. Hue is specified as an angle on a colorwheel, see
2334
986
# see http://en.wikipedia.org/wiki/Hue for more information.
1200
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
2335
987
# For instance the value 0 represents red, 60 is yellow, 120 is green,
1201
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
2336
988
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
1202
# purple, and 360 is red again.
2337
989
# The allowed range is 0 to 359.
1203
# Minimum value: 0, maximum value: 359, default value: 220.
2338
1204
# This tag requires that the tag GENERATE_HTML is set to YES.
2339
990
1205
2340
991
HTML_COLORSTYLE_HUE    = 16
1206
HTML_COLORSTYLE_HUE    = 16
2341
992
1207
2345
993
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
1208
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
2346
994
# the colors in the HTML output. For a value of 0 the output will use
1209
# in the HTML output. For a value of 0 the output will use grayscales only. A
2347
995
# grayscales only. A value of 255 will produce the most vivid colors.
1210
# value of 255 will produce the most vivid colors.
2348
1211
# Minimum value: 0, maximum value: 255, default value: 100.
2349
1212
# This tag requires that the tag GENERATE_HTML is set to YES.
2350
996
1213
2351
997
HTML_COLORSTYLE_SAT    = 240
1214
HTML_COLORSTYLE_SAT    = 240
2352
998
1215
2359
999
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
1216
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
2360
1000
# the luminance component of the colors in the HTML output. Values below
1217
# luminance component of the colors in the HTML output. Values below 100
2361
1001
# 100 gradually make the output lighter, whereas values above 100 make
1218
# gradually make the output lighter, whereas values above 100 make the output
2362
1002
# the output darker. The value divided by 100 is the actual gamma applied,
1219
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
2363
1003
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1220
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
2364
1004
# and 100 does not change the gamma.
1221
# change the gamma.
2365
1222
# Minimum value: 40, maximum value: 240, default value: 80.
2366
1223
# This tag requires that the tag GENERATE_HTML is set to YES.
2367
1005
1224
2368
1006
HTML_COLORSTYLE_GAMMA  = 80
1225
HTML_COLORSTYLE_GAMMA  = 80
2369
1007
1226
2370
1008
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1227
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
2373
1009
# page will contain the date and time when the page was generated. Setting
1228
# page will contain the date and time when the page was generated. Setting this
2374
1010
# this to NO can help when comparing the output of multiple runs.
1229
# to YES can help to show when doxygen was last run and thus if the
2375
1230
# documentation is up to date.
2376
1231
# The default value is: NO.
2377
1232
# This tag requires that the tag GENERATE_HTML is set to YES.
2378
1011
1233
2379
1012
HTML_TIMESTAMP         = YES
1234
HTML_TIMESTAMP         = YES
2380
1013
1235
2381
1014
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1236
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
2382
1015
# documentation will contain sections that can be hidden and shown after the
1237
# documentation will contain sections that can be hidden and shown after the
2383
1016
# page has loaded.
1238
# page has loaded.
2384
1239
# The default value is: NO.
2385
1240
# This tag requires that the tag GENERATE_HTML is set to YES.
2386
1017
1241
2387
1018
HTML_DYNAMIC_SECTIONS  = NO
1242
HTML_DYNAMIC_SECTIONS  = NO
2388
1019
1243
2397
1020
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
1244
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
2398
1021
# entries shown in the various tree structured indices initially; the user
1245
# shown in the various tree structured indices initially; the user can expand
2399
1022
# can expand and collapse entries dynamically later on. Doxygen will expand
1246
# and collapse entries dynamically later on. Doxygen will expand the tree to
2400
1023
# the tree to such a level that at most the specified number of entries are
1247
# such a level that at most the specified number of entries are visible (unless
2401
1024
# visible (unless a fully collapsed tree already exceeds this amount).
1248
# a fully collapsed tree already exceeds this amount). So setting the number of
2402
1025
# So setting the number of entries 1 will produce a full collapsed tree by
1249
# entries 1 will produce a full collapsed tree by default. 0 is a special value
2403
1026
# default. 0 is a special value representing an infinite number of entries
1250
# representing an infinite number of entries and will result in a full expanded
2404
1027
# and will result in a full expanded tree by default.
1251
# tree by default.
2405
1252
# Minimum value: 0, maximum value: 9999, default value: 100.
2406
1253
# This tag requires that the tag GENERATE_HTML is set to YES.
2407
1028
1254
2408
1029
HTML_INDEX_NUM_ENTRIES = 100
1255
HTML_INDEX_NUM_ENTRIES = 100
2409
1030
1256
2419
1031
# If the GENERATE_DOCSET tag is set to YES, additional index files
1257
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
2420
1032
# will be generated that can be used as input for Apple's Xcode 3
1258
# generated that can be used as input for Apple's Xcode 3 integrated development
2421
1033
# integrated development environment, introduced with OSX 10.5 (Leopard).
1259
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
2422
1034
# To create a documentation set, doxygen will generate a Makefile in the
1260
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
2423
1035
# HTML output directory. Running make will produce the docset in that
1261
# Makefile in the HTML output directory. Running make will produce the docset in
2424
1036
# directory and running "make install" will install the docset in
1262
# that directory and running make install will install the docset in
2425
1037
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1263
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
2426
1038
# it at startup.
1264
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
2418
1039
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
2427
1040
# for more information.
1265
# for more information.
2428
1266
# The default value is: NO.
2429
1267
# This tag requires that the tag GENERATE_HTML is set to YES.
2430
1041
1268
2431
1042
GENERATE_DOCSET        = NO
1269
GENERATE_DOCSET        = NO
2432
1043
1270
2437
1044
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1271
# This tag determines the name of the docset feed. A documentation feed provides
2438
1045
# feed. A documentation feed provides an umbrella under which multiple
1272
# an umbrella under which multiple documentation sets from a single provider
2439
1046
# documentation sets from a single provider (such as a company or product suite)
1273
# (such as a company or product suite) can be grouped.
2440
1047
# can be grouped.
1274
# The default value is: Doxygen generated docs.
2441
1275
# This tag requires that the tag GENERATE_DOCSET is set to YES.
2442
1048
1276
2443
1049
DOCSET_FEEDNAME        = "Doxygen generated docs"
1277
DOCSET_FEEDNAME        = "Doxygen generated docs"
2444
1050
1278
2449
1051
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1279
# This tag specifies a string that should uniquely identify the documentation
2450
1052
# should uniquely identify the documentation set bundle. This should be a
1280
# set bundle. This should be a reverse domain-name style string, e.g.
2451
1053
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1281
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
2452
1054
# will append .docset to the name.
1282
# The default value is: org.doxygen.Project.
2453
1283
# This tag requires that the tag GENERATE_DOCSET is set to YES.
2454
1055
1284
2455
1056
DOCSET_BUNDLE_ID       = org.doxygen.Project
1285
DOCSET_BUNDLE_ID       = org.doxygen.Project
2456
1057
1286
2460
1058
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
1287
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
2461
1059
# identify the documentation publisher. This should be a reverse domain-name
1288
# the documentation publisher. This should be a reverse domain-name style
2462
1060
# style string, e.g. com.mycompany.MyDocSet.documentation.
1289
# string, e.g. com.mycompany.MyDocSet.documentation.
2463
1290
# The default value is: org.doxygen.Publisher.
2464
1291
# This tag requires that the tag GENERATE_DOCSET is set to YES.
2465
1061
1292
2466
1062
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1293
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
2467
1063
1294
2469
1064
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1295
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
2470
1296
# The default value is: Publisher.
2471
1297
# This tag requires that the tag GENERATE_DOCSET is set to YES.
2472
1065
1298
2473
1066
DOCSET_PUBLISHER_NAME  = Publisher
1299
DOCSET_PUBLISHER_NAME  = Publisher
2474
1067
1300
2479
1068
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1301
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
2480
1069
# will be generated that can be used as input for tools like the
1302
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
2481
1070
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1303
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
2482
1071
# of the generated HTML documentation.
1304
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
2483
1305
# Windows.
2484
1306
#
2485
1307
# The HTML Help Workshop contains a compiler that can convert all HTML output
2486
1308
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
2487
1309
# files are now used as the Windows 98 help format, and will replace the old
2488
1310
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
2489
1311
# HTML files also contain an index, a table of contents, and you can search for
2490
1312
# words in the documentation. The HTML workshop also contains a viewer for
2491
1313
# compressed HTML files.
2492
1314
# The default value is: NO.
2493
1315
# This tag requires that the tag GENERATE_HTML is set to YES.
2494
1072
1316
2495
1073
GENERATE_HTMLHELP      = NO
1317
GENERATE_HTMLHELP      = NO
2496
1074
1318
2500
1075
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1319
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
2501
1076
# be used to specify the file name of the resulting .chm file. You
1320
# file. You can add a path in front of the file if the result should not be
2499
1077
# can add a path in front of the file if the result should not be
2502
1078
# written to the html output directory.
1321
# written to the html output directory.
2503
1322
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
2504
1079
1323
2505
1080
CHM_FILE               =
1324
CHM_FILE               =
2506
1081
1325
2511
1082
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1326
# The HHC_LOCATION tag can be used to specify the location (absolute path
2512
1083
# be used to specify the location (absolute path including file name) of
1327
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
2513
1084
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1328
# doxygen will try to run the HTML help compiler on the generated index.hhp.
2514
1085
# the HTML help compiler on the generated index.hhp.
1329
# The file has to be specified with full path.
2515
1330
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
2516
1086
1331
2517
1087
HHC_LOCATION           =
1332
HHC_LOCATION           =
2518
1088
1333
2522
1089
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1334
# The GENERATE_CHI flag controls if a separate .chi index file is generated
2523
1090
# controls if a separate .chi index file is generated (YES) or that
1335
# (YES) or that it should be included in the master .chm file (NO).
2524
1091
# it should be included in the master .chm file (NO).
1336
# The default value is: NO.
2525
1337
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
2526
1092
1338
2527
1093
GENERATE_CHI           = NO
1339
GENERATE_CHI           = NO
2528
1094
1340
2532
1095
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1341
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
2533
1096
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1342
# and project file content.
2534
1097
# content.
1343
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
2535
1098
1344
2536
1099
CHM_INDEX_ENCODING     =
1345
CHM_INDEX_ENCODING     =
2537
1100
1346
2541
1101
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1347
# The BINARY_TOC flag controls whether a binary table of contents is generated
2542
1102
# controls whether a binary table of contents is generated (YES) or a
1348
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
2543
1103
# normal table of contents (NO) in the .chm file.
1349
# enables the Previous and Next buttons.
2544
1350
# The default value is: NO.
2545
1351
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
2546
1104
1352
2547
1105
BINARY_TOC             = NO
1353
BINARY_TOC             = NO
2548
1106
1354
2551
1107
# The TOC_EXPAND flag can be set to YES to add extra items for group members
1355
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
2552
1108
# to the contents of the HTML help documentation and to the tree view.
1356
# the table of contents of the HTML help documentation and to the tree view.
2553
1357
# The default value is: NO.
2554
1358
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
2555
1109
1359
2556
1110
TOC_EXPAND             = NO
1360
TOC_EXPAND             = NO
2557
1111
1361
2558
1112
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1362
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
2562
1113
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1363
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
2563
1114
# that can be used as input for Qt's qhelpgenerator to generate a
1364
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
2564
1115
# Qt Compressed Help (.qch) of the generated HTML documentation.
1365
# (.qch) of the generated HTML documentation.
2565
1366
# The default value is: NO.
2566
1367
# This tag requires that the tag GENERATE_HTML is set to YES.
2567
1116
1368
2568
1117
GENERATE_QHP           = NO
1369
GENERATE_QHP           = NO
2569
1118
1370
2573
1119
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1371
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
2574
1120
# be used to specify the file name of the resulting .qch file.
1372
# the file name of the resulting .qch file. The path specified is relative to
2575
1121
# The path specified is relative to the HTML output folder.
1373
# the HTML output folder.
2576
1374
# This tag requires that the tag GENERATE_QHP is set to YES.
2577
1122
1375
2578
1123
QCH_FILE               =
1376
QCH_FILE               =
2579
1124
1377
2583
1125
# The QHP_NAMESPACE tag specifies the namespace to use when generating
1378
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
2584
1126
# Qt Help Project output. For more information please see
1379
# Project output. For more information please see Qt Help Project / Namespace
2585
1127
# http://doc.trolltech.com/qthelpproject.html#namespace
1380
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
2586
1381
# The default value is: org.doxygen.Project.
2587
1382
# This tag requires that the tag GENERATE_QHP is set to YES.
2588
1128
1383
2589
1129
QHP_NAMESPACE          = org.doxygen.Project
1384
QHP_NAMESPACE          = org.doxygen.Project
2590
1130
1385
2594
1131
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1386
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
2595
1132
# Qt Help Project output. For more information please see
1387
# Help Project output. For more information please see Qt Help Project / Virtual
2596
1133
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1388
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
2597
1389
# folders).
2598
1390
# The default value is: doc.
2599
1391
# This tag requires that the tag GENERATE_QHP is set to YES.
2600
1134
1392
2601
1135
QHP_VIRTUAL_FOLDER     = doc
1393
QHP_VIRTUAL_FOLDER     = doc
2602
1136
1394
2606
1137
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1395
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
2607
1138
# add. For more information please see
1396
# filter to add. For more information please see Qt Help Project / Custom
2608
1139
# http://doc.trolltech.com/qthelpproject.html#custom-filters
1397
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
2609
1398
# filters).
2610
1399
# This tag requires that the tag GENERATE_QHP is set to YES.
2611
1140
1400
2612
1141
QHP_CUST_FILTER_NAME   =
1401
QHP_CUST_FILTER_NAME   =
2613
1142
1402
2618
1143
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1403
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
2619
1144
# custom filter to add. For more information please see
1404
# custom filter to add. For more information please see Qt Help Project / Custom
2620
1145
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1405
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
2621
1146
# Qt Help Project / Custom Filters</a>.
1406
# filters).
2622
1407
# This tag requires that the tag GENERATE_QHP is set to YES.
2623
1147
1408
2624
1148
QHP_CUST_FILTER_ATTRS  =
1409
QHP_CUST_FILTER_ATTRS  =
2625
1149
1410
2626
1150
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1411
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
2631
1151
# project's
1412
# project's filter section matches. Qt Help Project / Filter Attributes (see:
2632
1152
# filter section matches.
1413
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
2633
1153
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1414
# This tag requires that the tag GENERATE_QHP is set to YES.
2630
1154
# Qt Help Project / Filter Attributes</a>.
2634
1155
1415
2635
1156
QHP_SECT_FILTER_ATTRS  =
1416
QHP_SECT_FILTER_ATTRS  =
2636
1157
1417
2641
1158
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1418
# The QHG_LOCATION tag can be used to specify the location of Qt's
2642
1159
# be used to specify the location of Qt's qhelpgenerator.
1419
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
2643
1160
# If non-empty doxygen will try to run qhelpgenerator on the generated
1420
# generated .qhp file.
2644
1161
# .qhp file.
1421
# This tag requires that the tag GENERATE_QHP is set to YES.
2645
1162
1422
2646
1163
QHG_LOCATION           =
1423
QHG_LOCATION           =
2647
1164
1424
2656
1165
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1425
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
2657
1166
#  will be generated, which together with the HTML files, form an Eclipse help
1426
# generated, together with the HTML files, they form an Eclipse help plugin. To
2658
1167
# plugin. To install this plugin and make it available under the help contents
1427
# install this plugin and make it available under the help contents menu in
2659
1168
# menu in Eclipse, the contents of the directory containing the HTML and XML
1428
# Eclipse, the contents of the directory containing the HTML and XML files needs
2660
1169
# files needs to be copied into the plugins directory of eclipse. The name of
1429
# to be copied into the plugins directory of eclipse. The name of the directory
2661
1170
# the directory within the plugins directory should be the same as
1430
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
2662
1171
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1431
# After copying Eclipse needs to be restarted before the help appears.
2663
1172
# the help appears.
1432
# The default value is: NO.
2664
1433
# This tag requires that the tag GENERATE_HTML is set to YES.
2665
1173
1434
2666
1174
GENERATE_ECLIPSEHELP   = NO
1435
GENERATE_ECLIPSEHELP   = NO
2667
1175
1436
2671
1176
# A unique identifier for the eclipse help plugin. When installing the plugin
1437
# A unique identifier for the Eclipse help plugin. When installing the plugin
2672
1177
# the directory name containing the HTML and XML files should also have
1438
# the directory name containing the HTML and XML files should also have this
2673
1178
# this name.
1439
# name. Each documentation set should have its own identifier.
2674
1440
# The default value is: org.doxygen.Project.
2675
1441
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
2676
1179
1442
2677
1180
ECLIPSE_DOC_ID         = org.doxygen.Project
1443
ECLIPSE_DOC_ID         = org.doxygen.Project
2678
1181
1444
2684
1182
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1445
# If you want full control over the layout of the generated HTML pages it might
2685
1183
# at top of each HTML page. The value NO (the default) enables the index and
1446
# be necessary to disable the index and replace it with your own. The
2686
1184
# the value YES disables it. Since the tabs have the same information as the
1447
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
2687
1185
# navigation tree you can set this option to NO if you already set
1448
# of each HTML page. A value of NO enables the index and the value YES disables
2688
1186
# GENERATE_TREEVIEW to YES.
1449
# it. Since the tabs in the index contain the same information as the navigation
2689
1450
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
2690
1451
# The default value is: NO.
2691
1452
# This tag requires that the tag GENERATE_HTML is set to YES.
2692
1187
1453
2693
1188
DISABLE_INDEX          = NO
1454
DISABLE_INDEX          = NO
2694
1189
1455
2695
1190
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1456
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
2704
1191
# structure should be generated to display hierarchical information.
1457
# structure should be generated to display hierarchical information. If the tag
2705
1192
# If the tag value is set to YES, a side panel will be generated
1458
# value is set to YES, a side panel will be generated containing a tree-like
2706
1193
# containing a tree-like index structure (just like the one that
1459
# index structure (just like the one that is generated for HTML Help). For this
2707
1194
# is generated for HTML Help). For this to work a browser that supports
1460
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
2708
1195
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1461
# (i.e. any modern browser). Windows users are probably better off using the
2709
1196
# Windows users are probably better off using the HTML help feature.
1462
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
2710
1197
# Since the tree basically has the same information as the tab index you
1463
# further fine-tune the look of the index. As an example, the default style
2711
1198
# could consider to set DISABLE_INDEX to NO when enabling this option.
1464
# sheet generated by doxygen has an example that shows how to put an image at
2712
1465
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
2713
1466
# the same information as the tab index, you could consider setting
2714
1467
# DISABLE_INDEX to YES when enabling this option.
2715
1468
# The default value is: NO.
2716
1469
# This tag requires that the tag GENERATE_HTML is set to YES.
2717
1199
1470
2718
1200
GENERATE_TREEVIEW      = NO
1471
GENERATE_TREEVIEW      = NO
2719
1201
1472
2724
1202
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1473
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
2725
1203
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1474
# doxygen will group on one line in the generated HTML documentation.
2726
1204
# documentation. Note that a value of 0 will completely suppress the enum
1475
#
2727
1205
# values from appearing in the overview section.
1476
# Note that a value of 0 will completely suppress the enum values from appearing
2728
1477
# in the overview section.
2729
1478
# Minimum value: 0, maximum value: 20, default value: 4.
2730
1479
# This tag requires that the tag GENERATE_HTML is set to YES.
2731
1206
1480
2732
1207
ENUM_VALUES_PER_LINE   = 4
1481
ENUM_VALUES_PER_LINE   = 4
2733
1208
1482
2737
1209
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1483
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
2738
1210
# used to set the initial width (in pixels) of the frame in which the tree
1484
# to set the initial width (in pixels) of the frame in which the tree is shown.
2739
1211
# is shown.
1485
# Minimum value: 0, maximum value: 1500, default value: 250.
2740
1486
# This tag requires that the tag GENERATE_HTML is set to YES.
2741
1212
1487
2742
1213
TREEVIEW_WIDTH         = 250
1488
TREEVIEW_WIDTH         = 250
2743
1214
1489
2746
1215
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1490
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
2747
1216
# links to external symbols imported via tag files in a separate window.
1491
# external symbols imported via tag files in a separate window.
2748
1492
# The default value is: NO.
2749
1493
# This tag requires that the tag GENERATE_HTML is set to YES.
2750
1217
1494
2751
1218
EXT_LINKS_IN_WINDOW    = NO
1495
EXT_LINKS_IN_WINDOW    = NO
2752
1219
1496
2758
1220
# Use this tag to change the font size of Latex formulas included
1497
# Use this tag to change the font size of LaTeX formulas included as images in
2759
1221
# as images in the HTML documentation. The default is 10. Note that
1498
# the HTML documentation. When you change the font size after a successful
2760
1222
# when you change the font size after a successful doxygen run you need
1499
# doxygen run you need to manually remove any form_*.png images from the HTML
2761
1223
# to manually remove any form_*.png images from the HTML output directory
1500
# output directory to force them to be regenerated.
2762
1224
# to force them to be regenerated.
1501
# Minimum value: 8, maximum value: 50, default value: 10.
2763
1502
# This tag requires that the tag GENERATE_HTML is set to YES.
2764
1225
1503
2765
1226
FORMULA_FONTSIZE       = 10
1504
FORMULA_FONTSIZE       = 10
2766
1227
1505
2767
1228
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1506
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
2772
1229
# generated for formulas are transparent PNGs. Transparent PNGs are
1507
# generated for formulas are transparent PNGs. Transparent PNGs are not
2773
1230
# not supported properly for IE 6.0, but are supported on all modern browsers.
1508
# supported properly for IE 6.0, but are supported on all modern browsers.
2774
1231
# Note that when changing this option you need to delete any form_*.png files
1509
#
2775
1232
# in the HTML output before the changes have effect.
1510
# Note that when changing this option you need to delete any form_*.png files in
2776
1511
# the HTML output directory before the changes have effect.
2777
1512
# The default value is: YES.
2778
1513
# This tag requires that the tag GENERATE_HTML is set to YES.
2779
1233
1514
2780
1234
FORMULA_TRANSPARENT    = YES
1515
FORMULA_TRANSPARENT    = YES
2781
1235
1516
2788
1236
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1517
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
2789
1237
# (see http://www.mathjax.org) which uses client side Javascript for the
1518
# http://www.mathjax.org) which uses client side Javascript for the rendering
2790
1238
# rendering instead of using prerendered bitmaps. Use this if you do not
1519
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
2791
1239
# have LaTeX installed or if you want to formulas look prettier in the HTML
1520
# installed or if you want to formulas look prettier in the HTML output. When
2792
1240
# output. When enabled you may also need to install MathJax separately and
1521
# enabled you may also need to install MathJax separately and configure the path
2793
1241
# configure the path to it using the MATHJAX_RELPATH option.
1522
# to it using the MATHJAX_RELPATH option.
2794
1523
# The default value is: NO.
2795
1524
# This tag requires that the tag GENERATE_HTML is set to YES.
2796
1242
1525
2797
1243
USE_MATHJAX            = NO
1526
USE_MATHJAX            = NO
2798
1244
1527
2799
1245
# When MathJax is enabled you can set the default output format to be used for
1528
# When MathJax is enabled you can set the default output format to be used for
2803
1246
# the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
1529
# the MathJax output. See the MathJax site (see:
2804
1247
# SVG. The default value is HTML-CSS, which is slower, but has the best
1530
# http://docs.mathjax.org/en/latest/output.html) for more details.
2805
1248
# compatibility.
1531
# Possible values are: HTML-CSS (which is slower, but has the best
2806
1532
# compatibility), NativeMML (i.e. MathML) and SVG.
2807
1533
# The default value is: HTML-CSS.
2808
1534
# This tag requires that the tag USE_MATHJAX is set to YES.
2809
1249
1535
2810
1250
MATHJAX_FORMAT         = HTML-CSS
1536
MATHJAX_FORMAT         = HTML-CSS
2811
1251
1537
2821
1252
# When MathJax is enabled you need to specify the location relative to the
1538
# When MathJax is enabled you need to specify the location relative to the HTML
2822
1253
# HTML output directory using the MATHJAX_RELPATH option. The destination
1539
# output directory using the MATHJAX_RELPATH option. The destination directory
2823
1254
# directory should contain the MathJax.js script. For instance, if the mathjax
1540
# should contain the MathJax.js script. For instance, if the mathjax directory
2824
1255
# directory is located at the same level as the HTML output directory, then
1541
# is located at the same level as the HTML output directory, then
2825
1256
# MATHJAX_RELPATH should be ../mathjax. The default value points to
1542
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
2826
1257
# the MathJax Content Delivery Network so you can quickly see the result without
1543
# Content Delivery Network so you can quickly see the result without installing
2827
1258
# installing MathJax.
1544
# MathJax. However, it is strongly recommended to install a local copy of
2828
1259
# However, it is strongly recommended to install a local
1545
# MathJax from http://www.mathjax.org before deployment.
2829
1260
# copy of MathJax from http://www.mathjax.org before deployment.
1546
# The default value is: http://cdn.mathjax.org/mathjax/latest.
2830
1547
# This tag requires that the tag USE_MATHJAX is set to YES.
2831
1261
1548
2832
1262
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1549
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
2833
1263
1550
2836
1264
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1551
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
2837
1265
# names that should be enabled during MathJax rendering.
1552
# extension names that should be enabled during MathJax rendering. For example
2838
1553
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
2839
1554
# This tag requires that the tag USE_MATHJAX is set to YES.
2840
1266
1555
2841
1267
MATHJAX_EXTENSIONS     =
1556
MATHJAX_EXTENSIONS     =
2842
1268
1557
2845
1269
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript
1558
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
2846
1270
# pieces of code that will be used on startup of the MathJax code.
1559
# of code that will be used on startup of the MathJax code. See the MathJax site
2847
1560
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
2848
1561
# example see the documentation.
2849
1562
# This tag requires that the tag USE_MATHJAX is set to YES.
2850
1271
1563
2851
1272
MATHJAX_CODEFILE       =
1564
MATHJAX_CODEFILE       =
2852
1273
1565
2860
1274
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1566
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
2861
1275
# for the HTML output. The underlying search engine uses javascript
1567
# the HTML output. The underlying search engine uses javascript and DHTML and
2862
1276
# and DHTML and should work on any modern browser. Note that when using
1568
# should work on any modern browser. Note that when using HTML help
2863
1277
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1569
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
2864
1278
# (GENERATE_DOCSET) there is already a search function so this one should
1570
# there is already a search function so this one should typically be disabled.
2865
1279
# typically be disabled. For large projects the javascript based search engine
1571
# For large projects the javascript based search engine can be slow, then
2866
1280
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1572
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
2867
1573
# search using the keyboard; to jump to the search box use <access key> + S
2868
1574
# (what the <access key> is depends on the OS and browser, but it is typically
2869
1575
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
2870
1576
# key> to jump into the search results window, the results can be navigated
2871
1577
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
2872
1578
# the search. The filter options can be selected when the cursor is inside the
2873
1579
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
2874
1580
# to select a filter and <Enter> or <escape> to activate or cancel the filter
2875
1581
# option.
2876
1582
# The default value is: YES.
2877
1583
# This tag requires that the tag GENERATE_HTML is set to YES.
2878
1281
1584
2879
1282
SEARCHENGINE           = YES
1585
SEARCHENGINE           = YES
2880
1283
1586
2881
1284
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1587
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
2888
1285
# implemented using a web server instead of a web client using Javascript.
1588
# implemented using a web server instead of a web client using Javascript. There
2889
1286
# There are two flavours of web server based search depending on the
1589
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
2890
1287
# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1590
# setting. When disabled, doxygen will generate a PHP script for searching and
2891
1288
# searching and an index file used by the script. When EXTERNAL_SEARCH is
1591
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
2892
1289
# enabled the indexing and searching needs to be provided by external tools.
1592
# and searching needs to be provided by external tools. See the section
2893
1290
# See the manual for details.
1593
# "External Indexing and Searching" for details.
2894
1594
# The default value is: NO.
2895
1595
# This tag requires that the tag SEARCHENGINE is set to YES.
2896
1291
1596
2897
1292
SERVER_BASED_SEARCH    = NO
1597
SERVER_BASED_SEARCH    = NO
2898
1293
1598
2900
1294
# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
1599
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
2901
1295
# script for searching. Instead the search results are written to an XML file
1600
# script for searching. Instead the search results are written to an XML file
2902
1296
# which needs to be processed by an external indexer. Doxygen will invoke an
1601
# which needs to be processed by an external indexer. Doxygen will invoke an
2907
1297
# external search engine pointed to by the SEARCHENGINE_URL option to obtain
1602
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
2908
1298
# the search results. Doxygen ships with an example indexer (doxyindexer) and
1603
# search results.
2909
1299
# search engine (doxysearch.cgi) which are based on the open source search
1604
#
2910
1300
# engine library Xapian. See the manual for configuration details.
1605
# Doxygen ships with an example indexer (doxyindexer) and search engine
2911
1606
# (doxysearch.cgi) which are based on the open source search engine library
2912
1607
# Xapian (see: http://xapian.org/).
2913
1608
#
2914
1609
# See the section "External Indexing and Searching" for details.
2915
1610
# The default value is: NO.
2916
1611
# This tag requires that the tag SEARCHENGINE is set to YES.
2917
1301
1612
2918
1302
EXTERNAL_SEARCH        = NO
1613
EXTERNAL_SEARCH        = NO
2919
1303
1614
2920
1304
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1615
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
2925
1305
# which will returned the search results when EXTERNAL_SEARCH is enabled.
1616
# which will return the search results when EXTERNAL_SEARCH is enabled.
2926
1306
# Doxygen ships with an example search engine (doxysearch) which is based on
1617
#
2927
1307
# the open source search engine library Xapian. See the manual for configuration
1618
# Doxygen ships with an example indexer (doxyindexer) and search engine
2928
1308
# details.
1619
# (doxysearch.cgi) which are based on the open source search engine library
2929
1620
# Xapian (see: http://xapian.org/). See the section "External Indexing and
2930
1621
# Searching" for details.
2931
1622
# This tag requires that the tag SEARCHENGINE is set to YES.
2932
1309
1623
2933
1310
SEARCHENGINE_URL       =
1624
SEARCHENGINE_URL       =
2934
1311
1625
2935
1312
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1626
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
2936
1313
# search data is written to a file for indexing by an external tool. With the
1627
# search data is written to a file for indexing by an external tool. With the
2937
1314
# SEARCHDATA_FILE tag the name of this file can be specified.
1628
# SEARCHDATA_FILE tag the name of this file can be specified.
2938
1629
# The default file is: searchdata.xml.
2939
1630
# This tag requires that the tag SEARCHENGINE is set to YES.
2940
1315
1631
2941
1316
SEARCHDATA_FILE        = searchdata.xml
1632
SEARCHDATA_FILE        = searchdata.xml
2942
1317
1633
2944
1318
# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
1634
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
2945
1319
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1635
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
2946
1320
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1636
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
2947
1321
# projects and redirect the results back to the right project.
1637
# projects and redirect the results back to the right project.
2948
1638
# This tag requires that the tag SEARCHENGINE is set to YES.
2949
1322
1639
2950
1323
EXTERNAL_SEARCH_ID     =
1640
EXTERNAL_SEARCH_ID     =
2951
1324
1641
2952
1325
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1642
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
2953
1326
# projects other than the one defined by this configuration file, but that are
1643
# projects other than the one defined by this configuration file, but that are
2954
1327
# all added to the same external search index. Each project needs to have a
1644
# all added to the same external search index. Each project needs to have a
2958
1328
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
1645
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
2959
1329
# of to a relative location where the documentation can be found.
1646
# to a relative location where the documentation can be found. The format is:
2960
1330
# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
1647
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
2961
1648
# This tag requires that the tag SEARCHENGINE is set to YES.
2962
1331
1649
2963
1332
EXTRA_SEARCH_MAPPINGS  =
1650
EXTRA_SEARCH_MAPPINGS  =
2964
1333
1651
2965
1334
#---------------------------------------------------------------------------
1652
#---------------------------------------------------------------------------
2967
1335
# configuration options related to the LaTeX output
1653
# Configuration options related to the LaTeX output
2968
1336
#---------------------------------------------------------------------------
1654
#---------------------------------------------------------------------------
2969
1337
1655
2972
1338
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1656
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
2973
1339
# generate Latex output.
1657
# The default value is: YES.
2974
1340
1658
2975
1341
GENERATE_LATEX         = NO
1659
GENERATE_LATEX         = NO
2976
1342
1660
2980
1343
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1661
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
2981
1344
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1662
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2982
1345
# put in front of it. If left blank `latex' will be used as the default path.
1663
# it.
2983
1664
# The default directory is: latex.
2984
1665
# This tag requires that the tag GENERATE_LATEX is set to YES.
2985
1346
1666
2986
1347
LATEX_OUTPUT           = latex
1667
LATEX_OUTPUT           = latex
2987
1348
1668
2988
1349
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1669
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
2993
1350
# invoked. If left blank `latex' will be used as the default command name.
1670
# invoked.
2994
1351
# Note that when enabling USE_PDFLATEX this option is only used for
1671
#
2995
1352
# generating bitmaps for formulas in the HTML output, but not in the
1672
# Note that when enabling USE_PDFLATEX this option is only used for generating
2996
1353
# Makefile that is written to the output directory.
1673
# bitmaps for formulas in the HTML output, but not in the Makefile that is
2997
1674
# written to the output directory.
2998
1675
# The default file is: latex.
2999
1676
# This tag requires that the tag GENERATE_LATEX is set to YES.
3000
1354
1677
3001
1355
LATEX_CMD_NAME         = latex
1678
LATEX_CMD_NAME         = latex
3002
1356
1679
3006
1357
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1680
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
3007
1358
# generate index for LaTeX. If left blank `makeindex' will be used as the
1681
# index for LaTeX.
3008
1359
# default command name.
1682
# The default file is: makeindex.
3009
1683
# This tag requires that the tag GENERATE_LATEX is set to YES.
3010
1360
1684
3011
1361
MAKEINDEX_CMD_NAME     = makeindex
1685
MAKEINDEX_CMD_NAME     = makeindex
3012
1362
1686
3016
1363
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1687
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
3017
1364
# LaTeX documents. This may be useful for small projects and may help to
1688
# documents. This may be useful for small projects and may help to save some
3018
1365
# save some trees in general.
1689
# trees in general.
3019
1690
# The default value is: NO.
3020
1691
# This tag requires that the tag GENERATE_LATEX is set to YES.
3021
1366
1692
3022
1367
COMPACT_LATEX          = NO
1693
COMPACT_LATEX          = NO
3023
1368
1694
3027
1369
# The PAPER_TYPE tag can be used to set the paper type that is used
1695
# The PAPER_TYPE tag can be used to set the paper type that is used by the
3028
1370
# by the printer. Possible values are: a4, letter, legal and
1696
# printer.
3029
1371
# executive. If left blank a4 will be used.
1697
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
3030
1698
# 14 inches) and executive (7.25 x 10.5 inches).
3031
1699
# The default value is: a4.
3032
1700
# This tag requires that the tag GENERATE_LATEX is set to YES.
3033
1372
1701
3034
1373
PAPER_TYPE             = a4
1702
PAPER_TYPE             = a4
3035
1374
1703
3038
1375
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1704
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
3039
1376
# packages that should be included in the LaTeX output.
1705
# that should be included in the LaTeX output. The package can be specified just
3040
1706
# by its name or with the correct syntax as to be used with the LaTeX
3041
1707
# \usepackage command. To get the times font for instance you can specify :
3042
1708
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
3043
1709
# To use the option intlimits with the amsmath package you can specify:
3044
1710
# EXTRA_PACKAGES=[intlimits]{amsmath}
3045
1711
# If left blank no extra packages will be included.
3046
1712
# This tag requires that the tag GENERATE_LATEX is set to YES.
3047
1377
1713
3048
1378
EXTRA_PACKAGES         =
1714
EXTRA_PACKAGES         =
3049
1379
1715
3054
1380
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1716
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
3055
1381
# the generated latex document. The header should contain everything until
1717
# generated LaTeX document. The header should contain everything until the first
3056
1382
# the first chapter. If it is left blank doxygen will generate a
1718
# chapter. If it is left blank doxygen will generate a standard header. See
3057
1383
# standard header. Notice: only use this tag if you know what you are doing!
1719
# section "Doxygen usage" for information on how to let doxygen write the
3058
1720
# default header to a separate file.
3059
1721
#
3060
1722
# Note: Only use a user-defined header if you know what you are doing! The
3061
1723
# following commands have a special meaning inside the header: $title,
3062
1724
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
3063
1725
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
3064
1726
# string, for the replacement values of the other commands the user is referred
3065
1727
# to HTML_HEADER.
3066
1728
# This tag requires that the tag GENERATE_LATEX is set to YES.
3067
1384
1729
3068
1385
LATEX_HEADER           =
1730
LATEX_HEADER           =
3069
1386
1731
3074
1387
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1732
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
3075
1388
# the generated latex document. The footer should contain everything after
1733
# generated LaTeX document. The footer should contain everything after the last
3076
1389
# the last chapter. If it is left blank doxygen will generate a
1734
# chapter. If it is left blank doxygen will generate a standard footer. See
3077
1390
# standard footer. Notice: only use this tag if you know what you are doing!
1735
# LATEX_HEADER for more information on how to generate a default footer and what
3078
1736
# special commands can be used inside the footer.
3079
1737
#
3080
1738
# Note: Only use a user-defined footer if you know what you are doing!
3081
1739
# This tag requires that the tag GENERATE_LATEX is set to YES.
3082
1391
1740
3083
1392
LATEX_FOOTER           =
1741
LATEX_FOOTER           =
3084
1393
1742
3089
1394
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images
1743
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
3090
1395
# or other source files which should be copied to the LaTeX output directory.
1744
# LaTeX style sheets that are included after the standard style sheets created
3091
1396
# Note that the files will be copied as-is; there are no commands or markers
1745
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
3092
1397
# available.
1746
# will copy the style sheet files to the output directory.
3093
1747
# Note: The order of the extra style sheet files is of importance (e.g. the last
3094
1748
# style sheet in the list overrules the setting of the previous ones in the
3095
1749
# list).
3096
1750
# This tag requires that the tag GENERATE_LATEX is set to YES.
3097
1751
3098
1752
LATEX_EXTRA_STYLESHEET =
3099
1753
3100
1754
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
3101
1755
# other source files which should be copied to the LATEX_OUTPUT output
3102
1756
# directory. Note that the files will be copied as-is; there are no commands or
3103
1757
# markers available.
3104
1758
# This tag requires that the tag GENERATE_LATEX is set to YES.
3105
1398
1759
3106
1399
LATEX_EXTRA_FILES      =
1760
LATEX_EXTRA_FILES      =
3107
1400
1761
3112
1401
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1762
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
3113
1402
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1763
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
3114
1403
# contain links (just like the HTML output) instead of page references
1764
# contain links (just like the HTML output) instead of page references. This
3115
1404
# This makes the output suitable for online browsing using a pdf viewer.
1765
# makes the output suitable for online browsing using a PDF viewer.
3116
1766
# The default value is: YES.
3117
1767
# This tag requires that the tag GENERATE_LATEX is set to YES.
3118
1405
1768
3119
1406
PDF_HYPERLINKS         = YES
1769
PDF_HYPERLINKS         = YES
3120
1407
1770
3123
1408
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1771
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
3124
1409
# plain latex in the generated Makefile. Set this option to YES to get a
1772
# the PDF file directly from the LaTeX files. Set this option to YES, to get a
3125
1410
# higher quality PDF documentation.
1773
# higher quality PDF documentation.
3126
1774
# The default value is: YES.
3127
1775
# This tag requires that the tag GENERATE_LATEX is set to YES.
3128
1411
1776
3129
1412
USE_PDFLATEX           = YES
1777
USE_PDFLATEX           = YES
3130
1413
1778
3135
1414
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1779
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
3136
1415
# command to the generated LaTeX files. This will instruct LaTeX to keep
1780
# command to the generated LaTeX files. This will instruct LaTeX to keep running
3137
1416
# running if errors occur, instead of asking the user for help.
1781
# if errors occur, instead of asking the user for help. This option is also used
3138
1417
# This option is also used when generating formulas in HTML.
1782
# when generating formulas in HTML.
3139
1783
# The default value is: NO.
3140
1784
# This tag requires that the tag GENERATE_LATEX is set to YES.
3141
1418
1785
3142
1419
LATEX_BATCHMODE        = NO
1786
LATEX_BATCHMODE        = NO
3143
1420
1787
3147
1421
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1788
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
3148
1422
# include the index chapters (such as File Index, Compound Index, etc.)
1789
# index chapters (such as File Index, Compound Index, etc.) in the output.
3149
1423
# in the output.
1790
# The default value is: NO.
3150
1791
# This tag requires that the tag GENERATE_LATEX is set to YES.
3151
1424
1792
3152
1425
LATEX_HIDE_INDICES     = NO
1793
LATEX_HIDE_INDICES     = NO
3153
1426
1794
3158
1427
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1795
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
3159
1428
# source code with syntax highlighting in the LaTeX output.
1796
# code with syntax highlighting in the LaTeX output.
3160
1429
# Note that which sources are shown also depends on other settings
1797
#
3161
1430
# such as SOURCE_BROWSER.
1798
# Note that which sources are shown also depends on other settings such as
3162
1799
# SOURCE_BROWSER.
3163
1800
# The default value is: NO.
3164
1801
# This tag requires that the tag GENERATE_LATEX is set to YES.
3165
1431
1802
3166
1432
LATEX_SOURCE_CODE      = NO
1803
LATEX_SOURCE_CODE      = NO
3167
1433
1804
3168
1434
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1805
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
3171
1435
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1806
# bibliography, e.g. plainnat, or ieeetr. See
3172
1436
# http://en.wikipedia.org/wiki/BibTeX for more info.
1807
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
3173
1808
# The default value is: plain.
3174
1809
# This tag requires that the tag GENERATE_LATEX is set to YES.
3175
1437
1810
3176
1438
LATEX_BIB_STYLE        = plain
1811
LATEX_BIB_STYLE        = plain
3177
1439
1812
3185
1440
#---------------------------------------------------------------------------
1813
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
3186
1441
# configuration options related to the RTF output
1814
# page will contain the date and time when the page was generated. Setting this
3187
1442
#---------------------------------------------------------------------------
1815
# to NO can help when comparing the output of multiple runs.
3188
1443
1816
# The default value is: NO.
3189
1444
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1817
# This tag requires that the tag GENERATE_LATEX is set to YES.
3190
1445
# The RTF output is optimized for Word 97 and may not look very pretty with
1818
3191
1446
# other RTF readers or editors.
1819
LATEX_TIMESTAMP        = NO
3192
1820
3193
1821
#---------------------------------------------------------------------------
3194
1822
# Configuration options related to the RTF output
3195
1823
#---------------------------------------------------------------------------
3196
1824
3197
1825
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
3198
1826
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
3199
1827
# readers/editors.
3200
1828
# The default value is: NO.
3201
1447
1829
3202
1448
GENERATE_RTF           = NO
1830
GENERATE_RTF           = NO
3203
1449
1831
3207
1450
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1832
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
3208
1451
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1833
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
3209
1452
# put in front of it. If left blank `rtf' will be used as the default path.
1834
# it.
3210
1835
# The default directory is: rtf.
3211
1836
# This tag requires that the tag GENERATE_RTF is set to YES.
3212
1453
1837
3213
1454
RTF_OUTPUT             = rtf
1838
RTF_OUTPUT             = rtf
3214
1455
1839
3218
1456
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1840
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
3219
1457
# RTF documents. This may be useful for small projects and may help to
1841
# documents. This may be useful for small projects and may help to save some
3220
1458
# save some trees in general.
1842
# trees in general.
3221
1843
# The default value is: NO.
3222
1844
# This tag requires that the tag GENERATE_RTF is set to YES.
3223
1459
1845
3224
1460
COMPACT_RTF            = NO
1846
COMPACT_RTF            = NO
3225
1461
1847
3232
1462
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1848
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
3233
1463
# will contain hyperlink fields. The RTF file will
1849
# contain hyperlink fields. The RTF file will contain links (just like the HTML
3234
1464
# contain links (just like the HTML output) instead of page references.
1850
# output) instead of page references. This makes the output suitable for online
3235
1465
# This makes the output suitable for online browsing using WORD or other
1851
# browsing using Word or some other Word compatible readers that support those
3236
1466
# programs which support those fields.
1852
# fields.
3237
1467
# Note: wordpad (write) and others do not support links.
1853
#
3238
1854
# Note: WordPad (write) and others do not support links.
3239
1855
# The default value is: NO.
3240
1856
# This tag requires that the tag GENERATE_RTF is set to YES.
3241
1468
1857
3242
1469
RTF_HYPERLINKS         = NO
1858
RTF_HYPERLINKS         = NO
3243
1470
1859
3247
1471
# Load style sheet definitions from file. Syntax is similar to doxygen's
1860
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
3248
1472
# config file, i.e. a series of assignments. You only have to provide
1861
# file, i.e. a series of assignments. You only have to provide replacements,
3249
1473
# replacements, missing definitions are set to their default value.
1862
# missing definitions are set to their default value.
3250
1863
#
3251
1864
# See also section "Doxygen usage" for information on how to generate the
3252
1865
# default style sheet that doxygen normally uses.
3253
1866
# This tag requires that the tag GENERATE_RTF is set to YES.
3254
1474
1867
3255
1475
RTF_STYLESHEET_FILE    =
1868
RTF_STYLESHEET_FILE    =
3256
1476
1869
3259
1477
# Set optional variables used in the generation of an rtf document.
1870
# Set optional variables used in the generation of an RTF document. Syntax is
3260
1478
# Syntax is similar to doxygen's config file.
1871
# similar to doxygen's config file. A template extensions file can be generated
3261
1872
# using doxygen -e rtf extensionFile.
3262
1873
# This tag requires that the tag GENERATE_RTF is set to YES.
3263
1479
1874
3264
1480
RTF_EXTENSIONS_FILE    =
1875
RTF_EXTENSIONS_FILE    =
3265
1481
1876
3272
1482
#---------------------------------------------------------------------------
1877
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
3273
1483
# configuration options related to the man page output
1878
# with syntax highlighting in the RTF output.
3274
1484
#---------------------------------------------------------------------------
1879
#
3275
1485
1880
# Note that which sources are shown also depends on other settings such as
3276
1486
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1881
# SOURCE_BROWSER.
3277
1487
# generate man pages
1882
# The default value is: NO.
3278
1883
# This tag requires that the tag GENERATE_RTF is set to YES.
3279
1884
3280
1885
RTF_SOURCE_CODE        = NO
3281
1886
3282
1887
#---------------------------------------------------------------------------
3283
1888
# Configuration options related to the man page output
3284
1889
#---------------------------------------------------------------------------
3285
1890
3286
1891
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
3287
1892
# classes and files.
3288
1893
# The default value is: NO.
3289
1488
1894
3290
1489
GENERATE_MAN           = NO
1895
GENERATE_MAN           = NO
3291
1490
1896
3295
1491
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1897
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
3296
1492
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1898
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
3297
1493
# put in front of it. If left blank `man' will be used as the default path.
1899
# it. A directory man3 will be created inside the directory specified by
3298
1900
# MAN_OUTPUT.
3299
1901
# The default directory is: man.
3300
1902
# This tag requires that the tag GENERATE_MAN is set to YES.
3301
1494
1903
3302
1495
MAN_OUTPUT             = man
1904
MAN_OUTPUT             = man
3303
1496
1905
3306
1497
# The MAN_EXTENSION tag determines the extension that is added to
1906
# The MAN_EXTENSION tag determines the extension that is added to the generated
3307
1498
# the generated man pages (default is the subroutine's section .3)
1907
# man pages. In case the manual section does not start with a number, the number
3308
1908
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
3309
1909
# optional.
3310
1910
# The default value is: .3.
3311
1911
# This tag requires that the tag GENERATE_MAN is set to YES.
3312
1499
1912
3313
1500
MAN_EXTENSION          = .3
1913
MAN_EXTENSION          = .3
3314
1501
1914
3320
1502
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1915
# The MAN_SUBDIR tag determines the name of the directory created within
3321
1503
# then it will generate one additional man file for each entity
1916
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
3322
1504
# documented in the real man page(s). These additional files
1917
# MAN_EXTENSION with the initial . removed.
3323
1505
# only source the real man page, but without them the man command
1918
# This tag requires that the tag GENERATE_MAN is set to YES.
3324
1506
# would be unable to find the correct page. The default is NO.
1919
3325
1920
MAN_SUBDIR             =
3326
1921
3327
1922
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
3328
1923
# will generate one additional man file for each entity documented in the real
3329
1924
# man page(s). These additional files only source the real man page, but without
3330
1925
# them the man command would be unable to find the correct page.
3331
1926
# The default value is: NO.
3332
1927
# This tag requires that the tag GENERATE_MAN is set to YES.
3333
1507
1928
3334
1508
MAN_LINKS              = NO
1929
MAN_LINKS              = NO
3335
1509
1930
3336
1510
#---------------------------------------------------------------------------
1931
#---------------------------------------------------------------------------
3338
1511
# configuration options related to the XML output
1932
# Configuration options related to the XML output
3339
1512
#---------------------------------------------------------------------------
1933
#---------------------------------------------------------------------------
3340
1513
1934
3344
1514
# If the GENERATE_XML tag is set to YES Doxygen will
1935
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
3345
1515
# generate an XML file that captures the structure of
1936
# captures the structure of the code including all documentation.
3346
1516
# the code including all documentation.
1937
# The default value is: NO.
3347
1517
1938
3348
1518
GENERATE_XML           = YES
1939
GENERATE_XML           = YES
3349
1519
1940
3353
1520
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1941
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
3354
1521
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1942
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
3355
1522
# put in front of it. If left blank `xml' will be used as the default path.
1943
# it.
3356
1944
# The default directory is: xml.
3357
1945
# This tag requires that the tag GENERATE_XML is set to YES.
3358
1523
1946
3359
1524
XML_OUTPUT             = xml
1947
XML_OUTPUT             = xml
3360
1525
1948
3377
1526
# The XML_SCHEMA tag can be used to specify an XML schema,
1949
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
3378
1527
# which can be used by a validating XML parser to check the
1950
# listings (including syntax highlighting and cross-referencing information) to
3379
1528
# syntax of the XML files.
1951
# the XML output. Note that enabling this will significantly increase the size
3380
1529
1952
# of the XML output.
3381
1530
XML_SCHEMA             =
1953
# The default value is: YES.
3382
1531
1954
# This tag requires that the tag GENERATE_XML is set to YES.
3367
1532
# The XML_DTD tag can be used to specify an XML DTD,
3368
1533
# which can be used by a validating XML parser to check the
3369
1534
# syntax of the XML files.
3370
1535
3371
1536
XML_DTD                =
3372
1537
3373
1538
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
3374
1539
# dump the program listings (including syntax highlighting
3375
1540
# and cross-referencing information) to the XML output. Note that
3376
1541
# enabling this will significantly increase the size of the XML output.
3383
1542
1955
3384
1543
XML_PROGRAMLISTING     = YES
1956
XML_PROGRAMLISTING     = YES
3385
1544
1957
3386
1545
#---------------------------------------------------------------------------
1958
#---------------------------------------------------------------------------
3388
1546
# configuration options related to the DOCBOOK output
1959
# Configuration options related to the DOCBOOK output
3389
1547
#---------------------------------------------------------------------------
1960
#---------------------------------------------------------------------------
3390
1548
1961
3392
1549
# If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files
1962
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
3393
1550
# that can be used to generate PDF.
1963
# that can be used to generate PDF.
3394
1964
# The default value is: NO.
3395
1551
1965
3396
1552
GENERATE_DOCBOOK       = NO
1966
GENERATE_DOCBOOK       = NO
3397
1553
1967
3399
1554
# The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put.
1968
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
3400
1555
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1969
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
3402
1556
# front of it. If left blank docbook will be used as the default path.
1970
# front of it.
3403
1971
# The default directory is: docbook.
3404
1972
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
3405
1557
1973
3406
1558
DOCBOOK_OUTPUT         = docbook
1974
DOCBOOK_OUTPUT         = docbook
3407
1559
1975
3417
1560
#---------------------------------------------------------------------------
1976
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
3418
1561
# configuration options for the AutoGen Definitions output
1977
# program listings (including syntax highlighting and cross-referencing
3419
1562
#---------------------------------------------------------------------------
1978
# information) to the DOCBOOK output. Note that enabling this will significantly
3420
1563
1979
# increase the size of the DOCBOOK output.
3421
1564
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1980
# The default value is: NO.
3422
1565
# generate an AutoGen Definitions (see autogen.sf.net) file
1981
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
3423
1566
# that captures the structure of the code including all
1982
3424
1567
# documentation. Note that this feature is still experimental
1983
DOCBOOK_PROGRAMLISTING = NO
3425
1568
# and incomplete at the moment.
1984
3426
1985
#---------------------------------------------------------------------------
3427
1986
# Configuration options for the AutoGen Definitions output
3428
1987
#---------------------------------------------------------------------------
3429
1988
3430
1989
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
3431
1990
# AutoGen Definitions (see http://autogen.sf.net) file that captures the
3432
1991
# structure of the code including all documentation. Note that this feature is
3433
1992
# still experimental and incomplete at the moment.
3434
1993
# The default value is: NO.
3435
1569
1994
3436
1570
GENERATE_AUTOGEN_DEF   = NO
1995
GENERATE_AUTOGEN_DEF   = NO
3437
1571
1996
3438
1572
#---------------------------------------------------------------------------
1997
#---------------------------------------------------------------------------
3440
1573
# configuration options related to the Perl module output
1998
# Configuration options related to the Perl module output
3441
1574
#---------------------------------------------------------------------------
1999
#---------------------------------------------------------------------------
3442
1575
2000
3448
1576
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
2001
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
3449
1577
# generate a Perl module file that captures the structure of
2002
# file that captures the structure of the code including all documentation.
3450
1578
# the code including all documentation. Note that this
2003
#
3451
1579
# feature is still experimental and incomplete at the
2004
# Note that this feature is still experimental and incomplete at the moment.
3452
1580
# moment.
2005
# The default value is: NO.
3453
1581
2006
3454
1582
GENERATE_PERLMOD       = NO
2007
GENERATE_PERLMOD       = NO
3455
1583
2008
3459
1584
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
2009
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
3460
1585
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
2010
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
3461
1586
# to generate PDF and DVI output from the Perl module output.
2011
# output from the Perl module output.
3462
2012
# The default value is: NO.
3463
2013
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
3464
1587
2014
3465
1588
PERLMOD_LATEX          = NO
2015
PERLMOD_LATEX          = NO
3466
1589
2016
3474
1590
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
2017
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
3475
1591
# nicely formatted so it can be parsed by a human reader.
2018
# formatted so it can be parsed by a human reader. This is useful if you want to
3476
1592
# This is useful
2019
# understand what is going on. On the other hand, if this tag is set to NO, the
3477
1593
# if you want to understand what is going on.
2020
# size of the Perl module output will be much smaller and Perl will parse it
3478
1594
# On the other hand, if this
2021
# just the same.
3479
1595
# tag is set to NO the size of the Perl module output will be much smaller
2022
# The default value is: YES.
3480
1596
# and Perl will parse it just the same.
2023
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
3481
1597
2024
3482
1598
PERLMOD_PRETTY         = YES
2025
PERLMOD_PRETTY         = YES
3483
1599
2026
3488
1600
# The names of the make variables in the generated doxyrules.make file
2027
# The names of the make variables in the generated doxyrules.make file are
3489
1601
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
2028
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
3490
1602
# This is useful so different doxyrules.make files included by the same
2029
# so different doxyrules.make files included by the same Makefile don't
3491
1603
# Makefile don't overwrite each other's variables.
2030
# overwrite each other's variables.
3492
2031
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
3493
1604
2032
3494
1605
PERLMOD_MAKEVAR_PREFIX =
2033
PERLMOD_MAKEVAR_PREFIX =
3495
1606
2034
3496
@@ -1608,112 +2036,129 @@
3497
1608
# Configuration options related to the preprocessor
2036
# Configuration options related to the preprocessor
3498
1609
#---------------------------------------------------------------------------
2037
#---------------------------------------------------------------------------
3499
1610
2038
3503
1611
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
2039
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
3504
1612
# evaluate all C-preprocessor directives found in the sources and include
2040
# C-preprocessor directives found in the sources and include files.
3505
1613
# files.
2041
# The default value is: YES.
3506
1614
2042
3507
1615
ENABLE_PREPROCESSING   = YES
2043
ENABLE_PREPROCESSING   = YES
3508
1616
2044
3513
1617
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
2045
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
3514
1618
# names in the source code. If set to NO (the default) only conditional
2046
# in the source code. If set to NO, only conditional compilation will be
3515
1619
# compilation will be performed. Macro expansion can be done in a controlled
2047
# performed. Macro expansion can be done in a controlled way by setting
3516
1620
# way by setting EXPAND_ONLY_PREDEF to YES.
2048
# EXPAND_ONLY_PREDEF to YES.
3517
2049
# The default value is: NO.
3518
2050
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
3519
1621
2051
3520
1622
MACRO_EXPANSION        = NO
2052
MACRO_EXPANSION        = NO
3521
1623
2053
3525
1624
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
2054
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
3526
1625
# then the macro expansion is limited to the macros specified with the
2055
# the macro expansion is limited to the macros specified with the PREDEFINED and
3527
1626
# PREDEFINED and EXPAND_AS_DEFINED tags.
2056
# EXPAND_AS_DEFINED tags.
3528
2057
# The default value is: NO.
3529
2058
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
3530
1627
2059
3531
1628
EXPAND_ONLY_PREDEF     = NO
2060
EXPAND_ONLY_PREDEF     = NO
3532
1629
2061
3535
1630
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
2062
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
3536
1631
# pointed to by INCLUDE_PATH will be searched when a #include is found.
2063
# INCLUDE_PATH will be searched if a #include is found.
3537
2064
# The default value is: YES.
3538
2065
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
3539
1632
2066
3540
1633
SEARCH_INCLUDES        = YES
2067
SEARCH_INCLUDES        = YES
3541
1634
2068
3542
1635
# The INCLUDE_PATH tag can be used to specify one or more directories that
2069
# The INCLUDE_PATH tag can be used to specify one or more directories that
3545
1636
# contain include files that are not input files but should be processed by
2070
# contain include files that are not input files but should be processed by the
3546
1637
# the preprocessor.
2071
# preprocessor.
3547
2072
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
3548
1638
2073
3549
1639
INCLUDE_PATH           =
2074
INCLUDE_PATH           =
3550
1640
2075
3551
1641
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2076
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
3552
1642
# patterns (like *.h and *.hpp) to filter out the header-files in the
2077
# patterns (like *.h and *.hpp) to filter out the header-files in the
3555
1643
# directories. If left blank, the patterns specified with FILE_PATTERNS will
2078
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
3556
1644
# be used.
2079
# used.
3557
2080
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
3558
1645
2081
3559
1646
INCLUDE_FILE_PATTERNS  =
2082
INCLUDE_FILE_PATTERNS  =
3560
1647
2083
3568
1648
# The PREDEFINED tag can be used to specify one or more macro names that
2084
# The PREDEFINED tag can be used to specify one or more macro names that are
3569
1649
# are defined before the preprocessor is started (similar to the -D option of
2085
# defined before the preprocessor is started (similar to the -D option of e.g.
3570
1650
# gcc). The argument of the tag is a list of macros of the form: name
2086
# gcc). The argument of the tag is a list of macros of the form: name or
3571
1651
# or name=definition (no spaces). If the definition and the = are
2087
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
3572
1652
# omitted =1 is assumed. To prevent a macro definition from being
2088
# is assumed. To prevent a macro definition from being undefined via #undef or
3573
1653
# undefined via #undef or recursively expanded use the := operator
2089
# recursively expanded use the := operator instead of the = operator.
3574
1654
# instead of the = operator.
2090
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
3575
1655
2091
3576
1656
PREDEFINED             = __cplusplus
2092
PREDEFINED             = __cplusplus
3577
1657
2093
3583
1658
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
2094
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
3584
1659
# this tag can be used to specify a list of macro names that should be expanded.
2095
# tag can be used to specify a list of macro names that should be expanded. The
3585
1660
# The macro definition that is found in the sources will be used.
2096
# macro definition that is found in the sources will be used. Use the PREDEFINED
3586
1661
# Use the PREDEFINED tag if you want to use a different macro definition that
2097
# tag if you want to use a different macro definition that overrules the
3587
1662
# overrules the definition found in the source code.
2098
# definition found in the source code.
3588
2099
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
3589
1663
2100
3590
1664
EXPAND_AS_DEFINED      =
2101
EXPAND_AS_DEFINED      =
3591
1665
2102
3596
1666
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
2103
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
3597
1667
# doxygen's preprocessor will remove all references to function-like macros
2104
# remove all references to function-like macros that are alone on a line, have
3598
1668
# that are alone on a line, have an all uppercase name, and do not end with a
2105
# an all uppercase name, and do not end with a semicolon. Such function macros
3599
1669
# semicolon, because these will confuse the parser if not removed.
2106
# are typically used for boiler-plate code, and will confuse the parser if not
3600
2107
# removed.
3601
2108
# The default value is: YES.
3602
2109
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
3603
1670
2110
3604
1671
SKIP_FUNCTION_MACROS   = YES
2111
SKIP_FUNCTION_MACROS   = YES
3605
1672
2112
3606
1673
#---------------------------------------------------------------------------
2113
#---------------------------------------------------------------------------
3608
1674
# Configuration::additions related to external references
2114
# Configuration options related to external references
3609
1675
#---------------------------------------------------------------------------
2115
#---------------------------------------------------------------------------
3610
1676
2116
3615
1677
# The TAGFILES option can be used to specify one or more tagfiles. For each
2117
# The TAGFILES tag can be used to specify one or more tag files. For each tag
3616
1678
# tag file the location of the external documentation should be added. The
2118
# file the location of the external documentation should be added. The format of
3617
1679
# format of a tag file without this location is as follows:
2119
# a tag file without this location is as follows:
3614
1680
#
3618
1681
# TAGFILES = file1 file2 ...
2120
# TAGFILES = file1 file2 ...
3619
1682
# Adding location for the tag files is done as follows:
2121
# Adding location for the tag files is done as follows:
3620
1683
#
3621
1684
# TAGFILES = file1=loc1 "file2 = loc2" ...
2122
# TAGFILES = file1=loc1 "file2 = loc2" ...
3626
1685
# where "loc1" and "loc2" can be relative or absolute paths
2123
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
3627
1686
# or URLs. Note that each tag file must have a unique name (where the name does
2124
# section "Linking to external documentation" for more information about the use
3628
1687
# NOT include the path). If a tag file is not located in the directory in which
2125
# of tag files.
3629
1688
# doxygen is run, you must also specify the path to the tagfile here.
2126
# Note: Each tag file must have a unique name (where the name does NOT include
3630
2127
# the path). If a tag file is not located in the directory in which doxygen is
3631
2128
# run, you must also specify the path to the tagfile here.
3632
1689
2129
3633
1690
TAGFILES               =
2130
TAGFILES               =
3634
1691
2131
3637
1692
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
2132
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
3638
1693
# a tag file that is based on the input files it reads.
2133
# tag file that is based on the input files it reads. See section "Linking to
3639
2134
# external documentation" for more information about the usage of tag files.
3640
1694
2135
3641
1695
GENERATE_TAGFILE       =
2136
GENERATE_TAGFILE       =
3642
1696
2137
3646
1697
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
2138
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
3647
1698
# in the class index. If set to NO only the inherited external classes
2139
# the class index. If set to NO, only the inherited external classes will be
3648
1699
# will be listed.
2140
# listed.
3649
2141
# The default value is: NO.
3650
1700
2142
3651
1701
ALLEXTERNALS           = NO
2143
ALLEXTERNALS           = NO
3652
1702
2144
3655
1703
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
2145
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
3656
1704
# in the modules index. If set to NO, only the current project's groups will
2146
# in the modules index. If set to NO, only the current project's groups will be
3657
2147
# listed.
3658
2148
# The default value is: YES.
3659
2149
3660
2150
EXTERNAL_GROUPS        = YES
3661
2151
3662
2152
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
3663
2153
# the related pages index. If set to NO, only the current project's pages will
3664
1705
# be listed.
2154
# be listed.
3671
1706
2155
# The default value is: YES.
3666
1707
EXTERNAL_GROUPS        = YES
3667
1708
3668
1709
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed
3669
1710
# in the related pages index. If set to NO, only the current project's
3670
1711
# pages will be listed.
3672
1712
2156
3673
1713
EXTERNAL_PAGES         = YES
2157
EXTERNAL_PAGES         = YES
3674
1714
2158
3675
1715
# The PERL_PATH should be the absolute path and name of the perl script
2159
# The PERL_PATH should be the absolute path and name of the perl script
3677
1716
# interpreter (i.e. the result of `which perl').
2160
# interpreter (i.e. the result of 'which perl').
3678
2161
# The default file (with absolute path) is: /usr/bin/perl.
3679
1717
2162
3680
1718
PERL_PATH              = /usr/bin/perl
2163
PERL_PATH              = /usr/bin/perl
3681
1719
2164
3682
@@ -1721,222 +2166,314 @@
3683
1721
# Configuration options related to the dot tool
2166
# Configuration options related to the dot tool
3684
1722
#---------------------------------------------------------------------------
2167
#---------------------------------------------------------------------------
3685
1723
2168
3691
1724
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
2169
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
3692
1725
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
2170
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
3693
1726
# or super classes. Setting the tag to NO turns the diagrams off. Note that
2171
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
3694
1727
# this option also works with HAVE_DOT disabled, but it is recommended to
2172
# disabled, but it is recommended to install and use dot, since it yields more
3695
1728
# install and use dot, since it yields more powerful graphs.
2173
# powerful graphs.
3696
2174
# The default value is: YES.
3697
1729
2175
3698
1730
CLASS_DIAGRAMS         = YES
2176
CLASS_DIAGRAMS         = YES
3699
1731
2177
3700
1732
# You can define message sequence charts within doxygen comments using the \msc
2178
# You can define message sequence charts within doxygen comments using the \msc
3703
1733
# command. Doxygen will then run the mscgen tool (see
2179
# command. Doxygen will then run the mscgen tool (see:
3704
1734
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
2180
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
3705
1735
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2181
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
3706
1736
# the mscgen tool resides. If left empty the tool is assumed to be found in the
2182
# the mscgen tool resides. If left empty the tool is assumed to be found in the
3707
1737
# default search path.
2183
# default search path.
3708
1738
2184
3709
1739
MSCGEN_PATH            =
2185
MSCGEN_PATH            =
3710
1740
2186
3714
1741
# If set to YES, the inheritance and collaboration graphs will hide
2187
# You can include diagrams made with dia in doxygen documentation. Doxygen will
3715
1742
# inheritance and usage relations if the target is undocumented
2188
# then run dia to produce the diagram and insert it in the documentation. The
3716
1743
# or is not a class.
2189
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
3717
2190
# If left empty dia is assumed to be found in the default search path.
3718
2191
3719
2192
DIA_PATH               =
3720
2193
3721
2194
# If set to YES the inheritance and collaboration graphs will hide inheritance
3722
2195
# and usage relations if the target is undocumented or is not a class.
3723
2196
# The default value is: YES.
3724
1744
2197
3725
1745
HIDE_UNDOC_RELATIONS   = YES
2198
HIDE_UNDOC_RELATIONS   = YES
3726
1746
2199
3727
1747
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2200
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
3731
1748
# available from the path. This tool is part of Graphviz, a graph visualization
2201
# available from the path. This tool is part of Graphviz (see:
3732
1749
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
2202
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
3733
1750
# have no effect if this option is set to NO (the default)
2203
# Bell Labs. The other options in this section have no effect if this option is
3734
2204
# set to NO
3735
2205
# The default value is: YES.
3736
1751
2206
3737
1752
HAVE_DOT               = @DOXYGEN_DOT_FOUND@
2207
HAVE_DOT               = @DOXYGEN_DOT_FOUND@
3738
1753
2208
3744
1754
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
2209
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
3745
1755
# allowed to run in parallel. When set to 0 (the default) doxygen will
2210
# to run in parallel. When set to 0 doxygen will base this on the number of
3746
1756
# base this on the number of processors available in the system. You can set it
2211
# processors available in the system. You can set it explicitly to a value
3747
1757
# explicitly to a value larger than 0 to get control over the balance
2212
# larger than 0 to get control over the balance between CPU load and processing
3748
1758
# between CPU load and processing speed.
2213
# speed.
3749
2214
# Minimum value: 0, maximum value: 32, default value: 0.
3750
2215
# This tag requires that the tag HAVE_DOT is set to YES.
3751
1759
2216
3752
1760
DOT_NUM_THREADS        = 0
2217
DOT_NUM_THREADS        = 0
3753
1761
2218
3760
1762
# By default doxygen will use the Helvetica font for all dot files that
2219
# When you want a differently looking font in the dot files that doxygen
3761
1763
# doxygen generates. When you want a differently looking font you can specify
2220
# generates you can specify the font name using DOT_FONTNAME. You need to make
3762
1764
# the font name using DOT_FONTNAME. You need to make sure dot is able to find
2221
# sure dot is able to find the font, which can be done by putting it in a
3763
1765
# the font, which can be done by putting it in a standard location or by setting
2222
# standard location or by setting the DOTFONTPATH environment variable or by
3764
1766
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2223
# setting DOT_FONTPATH to the directory containing the font.
3765
1767
# directory containing the font.
2224
# The default value is: Helvetica.
3766
2225
# This tag requires that the tag HAVE_DOT is set to YES.
3767
1768
2226
3768
1769
DOT_FONTNAME           = Arial
2227
DOT_FONTNAME           = Arial
3769
1770
2228
3772
1771
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
2229
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
3773
1772
# The default size is 10pt.
2230
# dot graphs.
3774
2231
# Minimum value: 4, maximum value: 24, default value: 10.
3775
2232
# This tag requires that the tag HAVE_DOT is set to YES.
3776
1773
2233
3777
1774
DOT_FONTSIZE           = 10
2234
DOT_FONTSIZE           = 10
3778
1775
2235
3782
1776
# By default doxygen will tell dot to use the Helvetica font.
2236
# By default doxygen will tell dot to use the default font as specified with
3783
1777
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
2237
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
3784
1778
# set the path where dot can find it.
2238
# the path where dot can find it using this tag.
3785
2239
# This tag requires that the tag HAVE_DOT is set to YES.
3786
1779
2240
3787
1780
DOT_FONTPATH           =
2241
DOT_FONTPATH           =
3788
1781
2242
3793
1782
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
2243
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
3794
1783
# will generate a graph for each documented class showing the direct and
2244
# each documented class showing the direct and indirect inheritance relations.
3795
1784
# indirect inheritance relations. Setting this tag to YES will force the
2245
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
3796
1785
# CLASS_DIAGRAMS tag to NO.
2246
# The default value is: YES.
3797
2247
# This tag requires that the tag HAVE_DOT is set to YES.
3798
1786
2248
3799
1787
CLASS_GRAPH            = YES
2249
CLASS_GRAPH            = YES
3800
1788
2250
3805
1789
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
2251
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
3806
1790
# will generate a graph for each documented class showing the direct and
2252
# graph for each documented class showing the direct and indirect implementation
3807
1791
# indirect implementation dependencies (inheritance, containment, and
2253
# dependencies (inheritance, containment, and class references variables) of the
3808
1792
# class references variables) of the class with other documented classes.
2254
# class with other documented classes.
3809
2255
# The default value is: YES.
3810
2256
# This tag requires that the tag HAVE_DOT is set to YES.
3811
1793
2257
3812
1794
COLLABORATION_GRAPH    = NO
2258
COLLABORATION_GRAPH    = NO
3813
1795
2259
3816
1796
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
2260
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
3817
1797
# will generate a graph for groups, showing the direct groups dependencies
2261
# groups, showing the direct groups dependencies.
3818
2262
# The default value is: YES.
3819
2263
# This tag requires that the tag HAVE_DOT is set to YES.
3820
1798
2264
3821
1799
GROUP_GRAPHS           = YES
2265
GROUP_GRAPHS           = YES
3822
1800
2266
3824
1801
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2267
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
3825
1802
# collaboration diagrams in a style similar to the OMG's Unified Modeling
2268
# collaboration diagrams in a style similar to the OMG's Unified Modeling
3826
1803
# Language.
2269
# Language.
3827
2270
# The default value is: NO.
3828
2271
# This tag requires that the tag HAVE_DOT is set to YES.
3829
1804
2272
3830
1805
UML_LOOK               = NO
2273
UML_LOOK               = NO
3831
1806
2274
3838
1807
# If the UML_LOOK tag is enabled, the fields and methods are shown inside
2275
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
3839
1808
# the class node. If there are many fields or methods and many nodes the
2276
# class node. If there are many fields or methods and many nodes the graph may
3840
1809
# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
2277
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
3841
1810
# threshold limits the number of items for each type to make the size more
2278
# number of items for each type to make the size more manageable. Set this to 0
3842
1811
# manageable. Set this to 0 for no limit. Note that the threshold may be
2279
# for no limit. Note that the threshold may be exceeded by 50% before the limit
3843
1812
# exceeded by 50% before the limit is enforced.
2280
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
3844
2281
# but if the number exceeds 15, the total amount of fields shown is limited to
3845
2282
# 10.
3846
2283
# Minimum value: 0, maximum value: 100, default value: 10.
3847
2284
# This tag requires that the tag HAVE_DOT is set to YES.
3848
1813
2285
3849
1814
UML_LIMIT_NUM_FIELDS   = 10
2286
UML_LIMIT_NUM_FIELDS   = 10
3850
1815
2287
3853
1816
# If set to YES, the inheritance and collaboration graphs will show the
2288
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
3854
1817
# relations between templates and their instances.
2289
# collaboration graphs will show the relations between templates and their
3855
2290
# instances.
3856
2291
# The default value is: NO.
3857
2292
# This tag requires that the tag HAVE_DOT is set to YES.
3858
1818
2293
3859
1819
TEMPLATE_RELATIONS     = NO
2294
TEMPLATE_RELATIONS     = NO
3860
1820
2295
3865
1821
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
2296
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
3866
1822
# tags are set to YES then doxygen will generate a graph for each documented
2297
# YES then doxygen will generate a graph for each documented file showing the
3867
1823
# file showing the direct and indirect include dependencies of the file with
2298
# direct and indirect include dependencies of the file with other documented
3868
1824
# other documented files.
2299
# files.
3869
2300
# The default value is: YES.
3870
2301
# This tag requires that the tag HAVE_DOT is set to YES.
3871
1825
2302
3872
1826
INCLUDE_GRAPH          = YES
2303
INCLUDE_GRAPH          = YES
3873
1827
2304
3878
1828
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
2305
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
3879
1829
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
2306
# set to YES then doxygen will generate a graph for each documented file showing
3880
1830
# documented header file showing the documented files that directly or
2307
# the direct and indirect include dependencies of the file with other documented
3881
1831
# indirectly include this file.
2308
# files.
3882
2309
# The default value is: YES.
3883
2310
# This tag requires that the tag HAVE_DOT is set to YES.
3884
1832
2311
3885
1833
INCLUDED_BY_GRAPH      = YES
2312
INCLUDED_BY_GRAPH      = YES
3886
1834
2313
3892
1835
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
2314
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
3893
1836
# doxygen will generate a call dependency graph for every global function
2315
# dependency graph for every global function or class method.
3894
1837
# or class method. Note that enabling this option will significantly increase
2316
#
3895
1838
# the time of a run. So in most cases it will be better to enable call graphs
2317
# Note that enabling this option will significantly increase the time of a run.
3896
1839
# for selected functions only using the \callgraph command.
2318
# So in most cases it will be better to enable call graphs for selected
3897
2319
# functions only using the \callgraph command. Disabling a call graph can be
3898
2320
# accomplished by means of the command \hidecallgraph.
3899
2321
# The default value is: NO.
3900
2322
# This tag requires that the tag HAVE_DOT is set to YES.
3901
1840
2323
3902
1841
CALL_GRAPH             = NO
2324
CALL_GRAPH             = NO
3903
1842
2325
3909
1843
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
2326
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
3910
1844
# doxygen will generate a caller dependency graph for every global function
2327
# dependency graph for every global function or class method.
3911
1845
# or class method. Note that enabling this option will significantly increase
2328
#
3912
1846
# the time of a run. So in most cases it will be better to enable caller
2329
# Note that enabling this option will significantly increase the time of a run.
3913
1847
# graphs for selected functions only using the \callergraph command.
2330
# So in most cases it will be better to enable caller graphs for selected
3914
2331
# functions only using the \callergraph command. Disabling a caller graph can be
3915
2332
# accomplished by means of the command \hidecallergraph.
3916
2333
# The default value is: NO.
3917
2334
# This tag requires that the tag HAVE_DOT is set to YES.
3918
1848
2335
3919
1849
CALLER_GRAPH           = NO
2336
CALLER_GRAPH           = NO
3920
1850
2337
3923
1851
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
2338
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
3924
1852
# will generate a graphical hierarchy of all classes instead of a textual one.
2339
# hierarchy of all classes instead of a textual one.
3925
2340
# The default value is: YES.
3926
2341
# This tag requires that the tag HAVE_DOT is set to YES.
3927
1853
2342
3928
1854
GRAPHICAL_HIERARCHY    = YES
2343
GRAPHICAL_HIERARCHY    = YES
3929
1855
2344
3934
1856
# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
2345
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
3935
1857
# then doxygen will show the dependencies a directory has on other directories
2346
# dependencies a directory has on other directories in a graphical way. The
3936
1858
# in a graphical way. The dependency relations are determined by the #include
2347
# dependency relations are determined by the #include relations between the
3937
1859
# relations between the files in the directories.
2348
# files in the directories.
3938
2349
# The default value is: YES.
3939
2350
# This tag requires that the tag HAVE_DOT is set to YES.
3940
1860
2351
3941
1861
DIRECTORY_GRAPH        = YES
2352
DIRECTORY_GRAPH        = YES
3942
1862
2353
3943
1863
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2354
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
3948
1864
# generated by dot. Possible values are svg, png, jpg, or gif.
2355
# generated by dot. For an explanation of the image formats see the section
3949
1865
# If left blank png will be used. If you choose svg you need to set
2356
# output formats in the documentation of the dot tool (Graphviz (see:
3950
1866
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
2357
# http://www.graphviz.org/)).
3951
1867
# visible in IE 9+ (other browsers do not have this requirement).
2358
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
3952
2359
# to make the SVG files visible in IE 9+ (other browsers do not have this
3953
2360
# requirement).
3954
2361
# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
3955
2362
# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
3956
2363
# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
3957
2364
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
3958
2365
# png:gdiplus:gdiplus.
3959
2366
# The default value is: png.
3960
2367
# This tag requires that the tag HAVE_DOT is set to YES.
3961
1868
2368
3962
1869
DOT_IMAGE_FORMAT       = svg
2369
DOT_IMAGE_FORMAT       = svg
3963
1870
2370
3964
1871
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2371
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
3965
1872
# enable generation of interactive SVG images that allow zooming and panning.
2372
# enable generation of interactive SVG images that allow zooming and panning.
3970
1873
# Note that this requires a modern browser other than Internet Explorer.
2373
#
3971
1874
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
2374
# Note that this requires a modern browser other than Internet Explorer. Tested
3972
1875
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
2375
# and working are Firefox, Chrome, Safari, and Opera.
3973
1876
# visible. Older versions of IE do not have SVG support.
2376
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
3974
2377
# the SVG files visible. Older versions of IE do not have SVG support.
3975
2378
# The default value is: NO.
3976
2379
# This tag requires that the tag HAVE_DOT is set to YES.
3977
1877
2380
3978
1878
INTERACTIVE_SVG        = NO
2381
INTERACTIVE_SVG        = NO
3979
1879
2382
3981
1880
# The tag DOT_PATH can be used to specify the path where the dot tool can be
2383
# The DOT_PATH tag can be used to specify the path where the dot tool can be
3982
1881
# found. If left blank, it is assumed the dot tool can be found in the path.
2384
# found. If left blank, it is assumed the dot tool can be found in the path.
3983
2385
# This tag requires that the tag HAVE_DOT is set to YES.
3984
1882
2386
3985
1883
DOT_PATH               =
2387
DOT_PATH               =
3986
1884
2388
3987
1885
# The DOTFILE_DIRS tag can be used to specify one or more directories that
2389
# The DOTFILE_DIRS tag can be used to specify one or more directories that
3990
1886
# contain dot files that are included in the documentation (see the
2390
# contain dot files that are included in the documentation (see the \dotfile
3991
1887
# \dotfile command).
2391
# command).
3992
2392
# This tag requires that the tag HAVE_DOT is set to YES.
3993
1888
2393
3994
1889
DOTFILE_DIRS           =
2394
DOTFILE_DIRS           =
3995
1890
2395
3996
1891
# The MSCFILE_DIRS tag can be used to specify one or more directories that
2396
# The MSCFILE_DIRS tag can be used to specify one or more directories that
3999
1892
# contain msc files that are included in the documentation (see the
2397
# contain msc files that are included in the documentation (see the \mscfile
4000
1893
# \mscfile command).
2398
# command).
4001
1894
2399
4002
1895
MSCFILE_DIRS           =
2400
MSCFILE_DIRS           =
4003
1896
2401
4011
1897
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
2402
# The DIAFILE_DIRS tag can be used to specify one or more directories that
4012
1898
# nodes that will be shown in the graph. If the number of nodes in a graph
2403
# contain dia files that are included in the documentation (see the \diafile
4013
1899
# becomes larger than this value, doxygen will truncate the graph, which is
2404
# command).
4014
1900
# visualized by representing a node as a red box. Note that doxygen if the
2405
4015
1901
# number of direct children of the root node in a graph is already larger than
2406
DIAFILE_DIRS           =
4016
1902
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
2407
4017
1903
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2408
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
4018
2409
# path where java can find the plantuml.jar file. If left blank, it is assumed
4019
2410
# PlantUML is not used or called during a preprocessing step. Doxygen will
4020
2411
# generate a warning when it encounters a \startuml command in this case and
4021
2412
# will not generate output for the diagram.
4022
2413
4023
2414
PLANTUML_JAR_PATH      =
4024
2415
4025
2416
# When using plantuml, the specified paths are searched for files specified by
4026
2417
# the !include statement in a plantuml block.
4027
2418
4028
2419
PLANTUML_INCLUDE_PATH  =
4029
2420
4030
2421
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
4031
2422
# that will be shown in the graph. If the number of nodes in a graph becomes
4032
2423
# larger than this value, doxygen will truncate the graph, which is visualized
4033
2424
# by representing a node as a red box. Note that doxygen if the number of direct
4034
2425
# children of the root node in a graph is already larger than
4035
2426
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
4036
2427
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
4037
2428
# Minimum value: 0, maximum value: 10000, default value: 50.
4038
2429
# This tag requires that the tag HAVE_DOT is set to YES.
4039
1904
2430
4040
1905
DOT_GRAPH_MAX_NODES    = 50
2431
DOT_GRAPH_MAX_NODES    = 50
4041
1906
2432
4048
1907
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
2433
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
4049
1908
# graphs generated by dot. A depth value of 3 means that only nodes reachable
2434
# generated by dot. A depth value of 3 means that only nodes reachable from the
4050
1909
# from the root by following a path via at most 3 edges will be shown. Nodes
2435
# root by following a path via at most 3 edges will be shown. Nodes that lay
4051
1910
# that lay further from the root node will be omitted. Note that setting this
2436
# further from the root node will be omitted. Note that setting this option to 1
4052
1911
# option to 1 or 2 may greatly reduce the computation time needed for large
2437
# or 2 may greatly reduce the computation time needed for large code bases. Also
4053
1912
# code bases. Also note that the size of a graph can be further restricted by
2438
# note that the size of a graph can be further restricted by
4054
1913
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2439
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
4055
2440
# Minimum value: 0, maximum value: 1000, default value: 0.
4056
2441
# This tag requires that the tag HAVE_DOT is set to YES.
4057
1914
2442
4058
1915
MAX_DOT_GRAPH_DEPTH    = 0
2443
MAX_DOT_GRAPH_DEPTH    = 0
4059
1916
2444
4060
1917
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2445
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
4065
1918
# background. This is disabled by default, because dot on Windows does not
2446
# background. This is disabled by default, because dot on Windows does not seem
4066
1919
# seem to support this out of the box. Warning: Depending on the platform used,
2447
# to support this out of the box.
4067
1920
# enabling this option may lead to badly anti-aliased labels on the edges of
2448
#
4068
1921
# a graph (i.e. they become hard to read).
2449
# Warning: Depending on the platform used, enabling this option may lead to
4069
2450
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
4070
2451
# read).
4071
2452
# The default value is: NO.
4072
2453
# This tag requires that the tag HAVE_DOT is set to YES.
4073
1922
2454
4074
1923
DOT_TRANSPARENT        = NO
2455
DOT_TRANSPARENT        = NO
4075
1924
2456
4077
1925
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2457
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
4078
1926
# files in one run (i.e. multiple -o and -T options on the command line). This
2458
# files in one run (i.e. multiple -o and -T options on the command line). This
4081
1927
# makes dot run faster, but since only newer versions of dot (>1.8.10)
2459
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
4082
1928
# support this, this feature is disabled by default.
2460
# this, this feature is disabled by default.
4083
2461
# The default value is: NO.
4084
2462
# This tag requires that the tag HAVE_DOT is set to YES.
4085
1929
2463
4086
1930
DOT_MULTI_TARGETS      = NO
2464
DOT_MULTI_TARGETS      = NO
4087
1931
2465
4091
1932
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
2466
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
4092
1933
# generate a legend page explaining the meaning of the various boxes and
2467
# explaining the meaning of the various boxes and arrows in the dot generated
4093
1934
# arrows in the dot generated graphs.
2468
# graphs.
4094
2469
# The default value is: YES.
4095
2470
# This tag requires that the tag HAVE_DOT is set to YES.
4096
1935
2471
4097
1936
GENERATE_LEGEND        = YES
2472
GENERATE_LEGEND        = YES
4098
1937
2473
4102
1938
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
2474
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
4103
1939
# remove the intermediate dot files that are used to generate
2475
# files that are used to generate the various graphs.
4104
1940
# the various graphs.
2476
# The default value is: YES.
4105
2477
# This tag requires that the tag HAVE_DOT is set to YES.
4106
1941
2478
4107
1942
DOT_CLEANUP            = YES
2479
DOT_CLEANUP            = YES
4108
1943
2480
4109
=== modified file 'doc/abi_compatibility_tools.md'
4110
--- doc/abi_compatibility_tools.md	2016-05-03 06:55:25 +0000
4111
+++ doc/abi_compatibility_tools.md	2016-11-29 04:47:53 +0000
4112
@@ -11,7 +11,7 @@
4113
11
11
4114
12
  Compiles all the public libraries in the current tree and checks their ABI against the latest released archive version
12
  Compiles all the public libraries in the current tree and checks their ABI against the latest released archive version
4115
13
13
4117
14
* **make abi-check-<library>**
14
* **make abi-check-\<library>**
4118
15
15
4119
16
  Compiles only the specified library in the current tree and checks its ABI against the latest released archive version
16
  Compiles only the specified library in the current tree and checks its ABI against the latest released archive version
4120
17
17
4121
18
18
4122
=== modified file 'doc/building_source_for_arm.md'
4123
--- doc/building_source_for_arm.md	2016-01-29 08:18:22 +0000
4124
+++ doc/building_source_for_arm.md	2016-11-29 04:47:53 +0000
4125
@@ -71,7 +71,7 @@
4126
71
Emulated sbuild package generation
71
Emulated sbuild package generation
4127
72
----------------------------------
72
----------------------------------
4128
73
73
4130
74
This uses qemu to compile the package. Substitute <version_string> for the .dsc
74
This uses qemu to compile the package. Substitute \<version_string> for the .dsc
4131
75
file name generated by the debuild command.
75
file name generated by the debuild command.
4132
76
76
4133
77
       $ cd mir_source_dir
77
       $ cd mir_source_dir
4134
@@ -85,11 +85,11 @@
4135
85
This uses a cross-compile toolchain to compile the package, and generally 
85
This uses a cross-compile toolchain to compile the package, and generally 
4136
86
should be faster than the emulated sbuild package generation.
86
should be faster than the emulated sbuild package generation.
4137
87
87
4139
88
Substitute <version_string> for the .dsc file name generated by the debuild 
88
Substitute \<version_string> for the .dsc file name generated by the debuild 
4140
89
command.
89
command.
4141
90
90
4142
91
       $ cd mir_source_dir
91
       $ cd mir_source_dir
4143
92
       $ debuild -S -uc -us
92
       $ debuild -S -uc -us
4144
93
       $ cd .. 
93
       $ cd .. 
4146
94
       $ sbuild -d vivid --host armhf --build amd64 mir_<version_string>.dsc
94
       $ sbuild -d vivid --host armhf --build amd64 mir_\<version_string>.dsc
4147
95
95
4148
96
96
4149
=== modified file 'doc/component_reports.md'
4150
--- doc/component_reports.md	2015-04-28 07:54:10 +0000
4151
+++ doc/component_reports.md	2016-11-29 04:47:53 +0000
4152
@@ -23,6 +23,7 @@
4153
23
display-report               | log,lttng
23
display-report               | log,lttng
4154
24
input-report                 | log,lttng
24
input-report                 | log,lttng
4155
25
legacy-input-report          | log
25
legacy-input-report          | log
4156
26
seat-report                  | log
4157
26
msg-processor-report         | log,lttng
27
msg-processor-report         | log,lttng
4158
27
session-mediator-report      | log,lttng
28
session-mediator-report      | log,lttng
4159
28
scene-report                 | log,lttng
29
scene-report                 | log,lttng
4160
29
30
4161
=== modified file 'doc/footer.html.in'
4162
--- doc/footer.html.in	2015-06-17 05:20:42 +0000
4163
+++ doc/footer.html.in	2016-11-29 04:47:53 +0000
4164
@@ -1,5 +1,5 @@
4165
1
<hr>
1
<hr>
4167
2
<p align="center">Copyright &copy; 2012-2015 Canonical Ltd. <br />
2
<p align="center">Copyright &copy; 2012-2016 Canonical Ltd. <br />
4168
3
Generated on @DATE_TODAY@</p>
3
Generated on @DATE_TODAY@</p>
4169
4
</body>
4
</body>
4170
5
</html>
5
</html>
4171
6
6
4172
=== modified file 'doc/mainpage.md'
4173
--- doc/mainpage.md	2016-05-03 06:55:25 +0000
4174
+++ doc/mainpage.md	2016-11-29 04:47:53 +0000
4175
@@ -47,8 +47,8 @@
4176
47
Getting involved
47
Getting involved
4177
48
----------------
48
----------------
4178
49
49
4181
50
The best place to ask questions and discuss about the Mir project is the
50
The best place to ask questions and discuss about the Mir project is
4182
51
#ubuntu-mir IRC channel on freenode.
51
the \#ubuntu-mir IRC channel on freenode.
4183
52
52
4184
53
The Mir project is hosted on Launchpad: https://launchpad.net/mir
53
The Mir project is hosted on Launchpad: https://launchpad.net/mir
4185
54
54
4186
@@ -98,8 +98,6 @@
4187
98
   "server_example_window_management.cpp: simple window management examples"
98
   "server_example_window_management.cpp: simple window management examples"
4188
99
 - \subpage server_example_canonical_window_manager.cpp 
99
 - \subpage server_example_canonical_window_manager.cpp 
4189
100
   "server_example_canonical_window_manager.cpp: canonical window management policy"
100
   "server_example_canonical_window_manager.cpp: canonical window management policy"
4190
101
 - \subpage server_example_tiling_window_manager.cpp 
4191
102
   "server_example_tiling_window_manager.cpp: an alternative window management policy"
4192
103
 - \subpage server_example_custom_compositor.cpp 
101
 - \subpage server_example_custom_compositor.cpp 
4193
104
   "server_example_custom_compositor.cpp: demonstrate writing an alternative GL rendering code"
102
   "server_example_custom_compositor.cpp: demonstrate writing an alternative GL rendering code"
4194
105
103
4195
@@ -112,5 +110,5 @@
4196
112
 - \ref component_reports
110
 - \ref component_reports
4197
113
 - \ref dso_versioning_guide
111
 - \ref dso_versioning_guide
4198
114
 - \ref abi_compatibility_tools
112
 - \ref abi_compatibility_tools
4200
115
 - \ref mir_performance_framework
113
 - \ref performance_framework
4201
116
 - \ref latency "Measuring visual latency"
114
 - \ref latency "Measuring visual latency"
4202
117
115
4203
=== modified file 'doc/measuring_latency.md'
4204
--- doc/measuring_latency.md	2016-04-07 03:13:18 +0000
4205
+++ doc/measuring_latency.md	2016-11-29 04:47:53 +0000
4206
@@ -22,3 +22,31 @@
4207
22
  4. Run `mirvanity`
22
  4. Run `mirvanity`
4208
23
  5. Wait until the output (in the console/stdout for now) shows that the
23
  5. Wait until the output (in the console/stdout for now) shows that the
4209
24
     test is complete (which means enough data has been gathered).
24
     test is complete (which means enough data has been gathered).
4210
25
4211
26
Accuracy
4212
27
--------
4213
28
4214
29
A common question is how accurate mirvanity's results are. An LCD monitor
4215
30
typically refreshes at 60Hz on an interval of about 16.6ms, and you have
4216
31
the added variability of the camera which even at high speed has a frame
4217
32
interval of about 5ms. So surely you have at least 22ms of variability?
4218
33
4219
34
Yes indeed instantaneous measurements will have wide variability that is
4220
35
the sum of the display and camera frame intervals. However both of these
4221
36
devices are very precise even though they're not in phase. So using
4222
37
many samples over a short period of time, `mirvanity` calculates the
4223
38
expected variability and compares it to the measured variability. After
4224
39
the expectation starts to match the measurement you have a good estimate of
4225
40
the baseline latency and estimated error range. `mirvanity` prints out this
4226
41
error and for a typical 60Hz monitor and common 187Hz PlayStation Eye camera,
4227
42
we observe pretty much the variability expected of around 22ms.
4228
43
4229
44
Knowing this variability is the sum of both waves, you can simply take the
4230
45
trough (or peak) as your measurement and thus eliminate the variability of
4231
46
the display and camera from the results. If you take the trough, you are
4232
47
excluding all display and camera latency. If you take the peak then you are
4233
48
including worst case display and camera latency. `mirvanity` reports all of
4234
49
these numbers for completeness. This is based on the
4235
50
[Superposition Principle](https://en.wikipedia.org/wiki/Superposition_principle)
4236
51
and typically yields a stable measurement with approximately 3ms or less
4237
52
random variation.
4238
25
53
4239
=== modified file 'doc/setup_vmware_for_mir.md'
4240
--- doc/setup_vmware_for_mir.md	2016-01-29 08:18:22 +0000
4241
+++ doc/setup_vmware_for_mir.md	2016-11-29 04:47:53 +0000
4242
@@ -6,7 +6,7 @@
4243
6
1. Go to https://my.vmware.com/web/vmware/downloads and download
6
1. Go to https://my.vmware.com/web/vmware/downloads and download
4244
7
   VMware Player (last in Desktop & End-User Computing section).
7
   VMware Player (last in Desktop & End-User Computing section).
4245
8
8
4247
9
2. Install VMware player with: sudo bash VMware-Player-<VERSION>.x86_64.bundle
9
2. Install VMware player with: sudo bash VMware-Player-\<VERSION>.x86_64.bundle
4248
10
10
4249
11
3. Get the latest vivid daily iso (*not* the unity-next iso!).
11
3. Get the latest vivid daily iso (*not* the unity-next iso!).
4250
12
12
4251
13
13
4252
=== modified file 'examples/CMakeLists.txt'
4253
--- examples/CMakeLists.txt	2016-06-02 05:33:50 +0000
4254
+++ examples/CMakeLists.txt	2016-11-29 04:47:53 +0000
4255
@@ -70,6 +70,12 @@
4256
70
target_link_libraries(mir_demo_client_target
70
target_link_libraries(mir_demo_client_target
4257
71
  eglapp
71
  eglapp
4258
72
)
72
)
4259
73
mir_add_wrapped_executable(mir_demo_client_pointer_confinement
4260
74
  pointer_confinement.c
4261
75
)
4262
76
target_link_libraries(mir_demo_client_pointer_confinement
4263
77
  eglapp
4264
78
)
4265
73
mir_add_wrapped_executable(mir_demo_client_camera
79
mir_add_wrapped_executable(mir_demo_client_camera
4266
74
  camera.c
80
  camera.c
4267
75
)
81
)
4268
@@ -180,6 +186,7 @@
4269
180
  ${PROJECT_SOURCE_DIR}/include/client
186
  ${PROJECT_SOURCE_DIR}/include/client
4270
181
  ${PROJECT_SOURCE_DIR}/include/platform
187
  ${PROJECT_SOURCE_DIR}/include/platform
4271
182
  ${PROJECT_SOURCE_DIR}/include/renderers/gl
188
  ${PROJECT_SOURCE_DIR}/include/renderers/gl
4272
189
  ${PROJECT_SOURCE_DIR}/include/renderers/sw
4273
183
  ${GL_INCLUDE_DIRS}
190
  ${GL_INCLUDE_DIRS}
4274
184
)
191
)
4275
185
192
4276
186
193
4277
=== modified file 'examples/animated_cursor_demo_client.c'
4278
--- examples/animated_cursor_demo_client.c	2016-05-03 06:55:25 +0000
4279
+++ examples/animated_cursor_demo_client.c	2016-11-29 04:47:53 +0000
4280
@@ -84,7 +84,7 @@
4281
84
{
84
{
4282
85
    unsigned int width = 128, height = 128;
85
    unsigned int width = 128, height = 128;
4283
86
86
4285
87
    if (!mir_eglapp_init(argc, argv, &width, &height))
87
    if (!mir_eglapp_init(argc, argv, &width, &height, NULL))
4286
88
        return 1;
88
        return 1;
4287
89
89
4288
90
    glClearColor(0.5, 0.5, 0.5, mir_eglapp_background_opacity);
90
    glClearColor(0.5, 0.5, 0.5, mir_eglapp_background_opacity);
4289
@@ -99,7 +99,7 @@
4290
99
        animate_cursor(stream);
99
        animate_cursor(stream);
4291
100
    }
100
    }
4292
101
101
4294
102
    mir_eglapp_shutdown();
102
    mir_eglapp_cleanup();
4295
103
103
4296
104
    return 0;
104
    return 0;
4297
105
}
105
}
4298
106
106
4299
=== modified file 'examples/camera.c'
4300
--- examples/camera.c	2016-05-03 06:55:25 +0000
4301
+++ examples/camera.c	2016-11-29 04:47:53 +0000
4302
@@ -87,6 +87,7 @@
4303
87
{
87
{
4304
88
    (void)surface;
88
    (void)surface;
4305
89
    State *state = (State*)context;
89
    State *state = (State*)context;
4306
90
    bool handled = true;
4307
90
91
4308
91
    // FIXME: We presently need to know that events come in on a different
92
    // FIXME: We presently need to know that events come in on a different
4309
92
    //        thread to main (LP: #1194384). When that's resolved, simple
93
    //        thread to main (LP: #1194384). When that's resolved, simple
4310
@@ -95,21 +96,19 @@
4311
95
96
4312
96
    switch (mir_event_get_type(event))
97
    switch (mir_event_get_type(event))
4313
97
    {
98
    {
4314
98
    case mir_event_type_input:
4315
99
        break;
4316
100
    case mir_event_type_resize:
99
    case mir_event_type_resize:
4317
101
        state->resized = true;
100
        state->resized = true;
4318
102
        break;
101
        break;
4319
103
    case mir_event_type_close_surface:
4320
104
        // TODO: eglapp.h needs a quit() function or different behaviour of
4321
105
        //       mir_eglapp_shutdown().
4322
106
        raise(SIGTERM);  // handled by eglapp
4323
107
        break;
4324
108
    default:
102
    default:
4325
103
        handled = false;
4326
109
        break;
104
        break;
4327
110
    }
105
    }
4328
111
106
4329
112
    pthread_mutex_unlock(&state->mutex);
107
    pthread_mutex_unlock(&state->mutex);
4330
108
4331
109
    if (!handled)
4332
110
        mir_eglapp_handle_event(surface, event, NULL);
4333
111
4334
113
}
112
}
4335
114
113
4336
115
static void fourcc_string(__u32 x, char str[5])
114
static void fourcc_string(__u32 x, char str[5])
4337
@@ -369,17 +368,49 @@
4338
369
    // TODO: Selectable between high-res grey vs half-res colour?
368
    // TODO: Selectable between high-res grey vs half-res colour?
4339
370
    const char * const fshadersrc = yuyv_quickcolour_fshadersrc;
369
    const char * const fshadersrc = yuyv_quickcolour_fshadersrc;
4340
371
370
4342
372
    Camera *cam = open_camera("/dev/video0", camera_pref_resolution, 1);
371
    unsigned int win_width = 1;
4343
372
    unsigned int win_height = 1;
4344
373
4345
374
    char const* dev_video = "/dev/video0";
4346
375
    mir_eglapp_bool ultrafast = 0;
4347
376
    struct mir_eglapp_arg custom_args[] =
4348
377
    {
4349
378
        {"-d <path>", "=", &dev_video, "Path to camera device"},
4350
379
        {"-u", "!", &ultrafast, "Ultra fast mode (low resolution)"},
4351
380
        {NULL, NULL, NULL, NULL},
4352
381
    };
4353
382
    if (!mir_eglapp_init(argc, argv, &win_width, &win_height, custom_args))
4354
383
        return 1;
4355
384
4356
385
    // By default we prefer high resolution and low CPU usage but if you
4357
386
    // ask for ultrafast mode expect low resolution and high CPU usage...
4358
387
    enum CameraPref pref = camera_pref_resolution;
4359
388
    if (ultrafast)
4360
389
    {
4361
390
        pref = camera_pref_speed;
4362
391
        mir_surface_set_swapinterval(mir_eglapp_native_surface(), 0);
4363
392
    }
4364
393
    Camera *cam = open_camera(dev_video, pref, 1);
4365
373
    if (!cam)
394
    if (!cam)
4366
374
    {
395
    {
4367
375
        fprintf(stderr, "Failed to set up camera device\n");
396
        fprintf(stderr, "Failed to set up camera device\n");
4368
376
        return 0;
397
        return 0;
4369
377
    }
398
    }
4370
378
399
4375
379
    unsigned int win_width = cam->pix.width;
400
    MirSurface* surface = mir_eglapp_native_surface();
4376
380
    unsigned int win_height = cam->pix.height;
401
    if (win_width == 1)  /* Fullscreen was not chosen */
4377
381
    if (!mir_eglapp_init(argc, argv, &win_width, &win_height))
402
    {
4378
382
        return 1;
403
        /* Chicken or egg? init before open_camera, before size is known */
4379
404
        MirConnection* connection = mir_eglapp_native_connection();
4380
405
        MirSurfaceSpec* changes =
4381
406
            mir_connection_create_spec_for_changes(connection);
4382
407
        win_width = cam->pix.width;
4383
408
        win_height = cam->pix.height;
4384
409
        mir_surface_spec_set_width(changes, win_width);
4385
410
        mir_surface_spec_set_height(changes, win_height);
4386
411
        mir_surface_apply_spec(surface, changes);
4387
412
        mir_surface_spec_release(changes);
4388
413
    }
4389
383
414
4390
384
    GLuint vshader = load_shader(vshadersrc, GL_VERTEX_SHADER);
415
    GLuint vshader = load_shader(vshadersrc, GL_VERTEX_SHADER);
4391
385
    assert(vshader);
416
    assert(vshader);
4392
@@ -439,7 +470,6 @@
4393
439
        PTHREAD_MUTEX_INITIALIZER,
470
        PTHREAD_MUTEX_INITIALIZER,
4394
440
        true
471
        true
4395
441
    };
472
    };
4396
442
    MirSurface *surface = mir_eglapp_native_surface();
4397
443
    mir_surface_set_event_handler(surface, on_event, &state);
473
    mir_surface_set_event_handler(surface, on_event, &state);
4398
444
474
4399
445
    bool first_frame = true;
475
    bool first_frame = true;
4400
@@ -534,7 +564,7 @@
4401
534
    }
564
    }
4402
535
565
4403
536
    mir_surface_set_event_handler(surface, NULL, NULL);
566
    mir_surface_set_event_handler(surface, NULL, NULL);
4405
537
    mir_eglapp_shutdown();
567
    mir_eglapp_cleanup();
4406
538
    close_camera(cam);
568
    close_camera(cam);
4407
539
569
4408
540
    return 0;
570
    return 0;
4409
541
571
4410
=== modified file 'examples/client_touch_validator.cpp'
4411
--- examples/client_touch_validator.cpp	2015-06-02 20:14:56 +0000
4412
+++ examples/client_touch_validator.cpp	2016-11-29 04:47:53 +0000
4413
@@ -162,7 +162,7 @@
4414
162
{
162
{
4415
163
    unsigned int width = 0, height = 0;
163
    unsigned int width = 0, height = 0;
4416
164
164
4418
165
    if (!mir_eglapp_init(argc, argv, &width, &height))
165
    if (!mir_eglapp_init(argc, argv, &width, &height, NULL))
4419
166
        return 1;
166
        return 1;
4420
167
167
4421
168
    TouchState state;
168
    TouchState state;
4422
@@ -194,7 +194,7 @@
4423
194
        sleep(1);
194
        sleep(1);
4424
195
    }
195
    }
4425
196
196
4427
197
    mir_eglapp_shutdown();
197
    mir_eglapp_cleanup();
4428
198
198
4429
199
    return 0;
199
    return 0;
4430
200
}
200
}
4431
201
201
4432
=== modified file 'examples/cursors_demo_client.c'
4433
--- examples/cursors_demo_client.c	2016-07-20 11:16:01 +0000
4434
+++ examples/cursors_demo_client.c	2016-11-29 04:47:53 +0000
4435
@@ -58,7 +58,7 @@
4436
58
{
58
{
4437
59
    unsigned int width = 128, height = 128;
59
    unsigned int width = 128, height = 128;
4438
60
60
4440
61
    if (!mir_eglapp_init(argc, argv, &width, &height))
61
    if (!mir_eglapp_init(argc, argv, &width, &height, NULL))
4441
62
        return 1;
62
        return 1;
4442
63
63
4443
64
    glClearColor(0.5, 0.5, 0.5, mir_eglapp_background_opacity);
64
    glClearColor(0.5, 0.5, 0.5, mir_eglapp_background_opacity);
4444
@@ -72,7 +72,7 @@
4445
72
        usleep(100000);
72
        usleep(100000);
4446
73
    }
73
    }
4447
74
74
4449
75
    mir_eglapp_shutdown();
75
    mir_eglapp_cleanup();
4450
76
76
4451
77
    return 0;
77
    return 0;
4452
78
}
78
}
4453
79
79
4454
=== modified file 'examples/demo_client_display_config.c'
4455
--- examples/demo_client_display_config.c	2015-04-28 07:54:10 +0000
4456
+++ examples/demo_client_display_config.c	2016-11-29 04:47:53 +0000
4457
@@ -347,7 +347,7 @@
4458
347
{
347
{
4459
348
    unsigned int width = 256, height = 256;
348
    unsigned int width = 256, height = 256;
4460
349
349
4462
350
    if (!mir_eglapp_init(argc, argv, &width, &height))
350
    if (!mir_eglapp_init(argc, argv, &width, &height, NULL))
4463
351
    {
351
    {
4464
352
        printf("A demo client that allows changing the display configuration. While the client\n"
352
        printf("A demo client that allows changing the display configuration. While the client\n"
4465
353
               "has the focus, use the following keys to change and get information about the\n"
353
               "has the focus, use the following keys to change and get information about the\n"
4466
@@ -390,7 +390,7 @@
4467
390
        }
390
        }
4468
391
    }
391
    }
4469
392
392
4471
393
    mir_eglapp_shutdown();
393
    mir_eglapp_cleanup();
4472
394
394
4473
395
    return 0;
395
    return 0;
4474
396
}
396
}
4475
397
397
4476
=== modified file 'examples/eglapp.c'
4477
--- examples/eglapp.c	2016-05-03 06:55:25 +0000
4478
+++ examples/eglapp.c	2016-11-29 04:47:53 +0000
4479
@@ -22,6 +22,7 @@
4480
22
#include <stdlib.h>
22
#include <stdlib.h>
4481
23
#include <signal.h>
23
#include <signal.h>
4482
24
#include <time.h>
24
#include <time.h>
4483
25
#include <string.h>
4484
25
#include <EGL/egl.h>
26
#include <EGL/egl.h>
4485
26
#include <GLES2/gl2.h>
27
#include <GLES2/gl2.h>
4486
27
28
4487
@@ -36,6 +37,7 @@
4488
36
static EGLDisplay egldisplay;
37
static EGLDisplay egldisplay;
4489
37
static EGLSurface eglsurface;
38
static EGLSurface eglsurface;
4490
38
static volatile sig_atomic_t running = 0;
39
static volatile sig_atomic_t running = 0;
4491
40
static double refresh_rate = 0.0;
4492
39
41
4493
40
#define CHECK(_cond, _err) \
42
#define CHECK(_cond, _err) \
4494
41
    if (!(_cond)) \
43
    if (!(_cond)) \
4495
@@ -44,7 +46,7 @@
4496
44
        return 0; \
46
        return 0; \
4497
45
    }
47
    }
4498
46
48
4500
47
void mir_eglapp_shutdown(void)
49
void mir_eglapp_cleanup(void)
4501
48
{
50
{
4502
49
    eglMakeCurrent(egldisplay, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
51
    eglMakeCurrent(egldisplay, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
4503
50
    eglTerminate(egldisplay);
52
    eglTerminate(egldisplay);
4504
@@ -54,11 +56,16 @@
4505
54
    connection = NULL;
56
    connection = NULL;
4506
55
}
57
}
4507
56
58
4508
59
void mir_eglapp_quit(void)
4509
60
{
4510
61
    running = 0;
4511
62
}
4512
63
4513
57
static void shutdown(int signum)
64
static void shutdown(int signum)
4514
58
{
65
{
4515
59
    if (running)
66
    if (running)
4516
60
    {
67
    {
4518
61
        running = 0;
68
        mir_eglapp_quit();
4519
62
        printf("Signal %d received. Good night.\n", signum);
69
        printf("Signal %d received. Good night.\n", signum);
4520
63
    }
70
    }
4521
64
}
71
}
4522
@@ -106,25 +113,48 @@
4523
106
static void mir_eglapp_handle_surface_event(MirSurfaceEvent const* sev)
113
static void mir_eglapp_handle_surface_event(MirSurfaceEvent const* sev)
4524
107
{
114
{
4525
108
    MirSurfaceAttrib attrib = mir_surface_event_get_attribute(sev);
115
    MirSurfaceAttrib attrib = mir_surface_event_get_attribute(sev);
4529
109
    if (attrib != mir_surface_attrib_visibility)
116
    int value = mir_surface_event_get_attribute_value(sev);
4530
110
        return;
117
4531
111
    switch (mir_surface_event_get_attribute_value(sev))
118
    switch (attrib)
4532
112
    {
119
    {
4535
113
    case mir_surface_visibility_exposed:
120
    case mir_surface_attrib_visibility:
4536
114
        printf("Surface exposed\n");
121
        printf("Surface %s\n", value == mir_surface_visibility_exposed ?
4537
122
                               "exposed" : "occluded");
4538
115
        break;
123
        break;
4541
116
    case mir_surface_visibility_occluded:
124
    case mir_surface_attrib_dpi:
4542
117
        printf("Surface occluded\n");
125
        // value is still zero - never implemented. Deprecate? (LP: #1559831)
4543
118
        break;
126
        break;
4544
119
    default:
127
    default:
4545
120
        break;
128
        break;
4546
121
    }
129
    }
4547
122
}
130
}
4548
123
131
4550
124
static void mir_eglapp_handle_event(MirSurface* surface, MirEvent const* ev, void* context)
132
static void handle_surface_output_event(MirSurfaceOutputEvent const* out)
4551
133
{
4552
134
    static char const* const form_factor_name[6] =
4553
135
        {"unknown", "phone", "tablet", "monitor", "TV", "projector"};
4554
136
    unsigned ff = mir_surface_output_event_get_form_factor(out);
4555
137
    char const* form_factor = (ff < 6) ? form_factor_name[ff] : "out-of-range";
4556
138
4557
139
    refresh_rate = mir_surface_output_event_get_refresh_rate(out);
4558
140
4559
141
    printf("Surface is on output %u: %d DPI, scale %.1fx, %s form factor, %.2fHz\n",
4560
142
           mir_surface_output_event_get_output_id(out),
4561
143
           mir_surface_output_event_get_dpi(out),
4562
144
           mir_surface_output_event_get_scale(out),
4563
145
           form_factor,
4564
146
           refresh_rate);
4565
147
}
4566
148
4567
149
double mir_eglapp_display_hz(void)
4568
150
{
4569
151
    return refresh_rate;
4570
152
}
4571
153
4572
154
void mir_eglapp_handle_event(MirSurface* surface, MirEvent const* ev, void* unused)
4573
125
{
155
{
4574
126
    (void) surface;
156
    (void) surface;
4576
127
    (void) context;
157
    (void) unused;
4577
128
    
158
    
4578
129
    switch (mir_event_get_type(ev))
159
    switch (mir_event_get_type(ev))
4579
130
    {
160
    {
4580
@@ -134,6 +164,9 @@
4581
134
    case mir_event_type_surface:
164
    case mir_event_type_surface:
4582
135
        mir_eglapp_handle_surface_event(mir_event_get_surface_event(ev));
165
        mir_eglapp_handle_surface_event(mir_event_get_surface_event(ev));
4583
136
        break;
166
        break;
4584
167
    case mir_event_type_surface_output:
4585
168
        handle_surface_output_event(mir_event_get_surface_output_event(ev));
4586
169
        break;
4587
137
    case mir_event_type_resize:
170
    case mir_event_type_resize:
4588
138
        /*
171
        /*
4589
139
         * FIXME: https://bugs.launchpad.net/mir/+bug/1194384
172
         * FIXME: https://bugs.launchpad.net/mir/+bug/1194384
4590
@@ -181,8 +214,115 @@
4591
181
    return output;
214
    return output;
4592
182
}
215
}
4593
183
216
4596
184
mir_eglapp_bool mir_eglapp_init(int argc, char *argv[],
217
static void show_help(struct mir_eglapp_arg const* const* arg_lists)
4597
185
                                unsigned int *width, unsigned int *height)
218
{
4598
219
    int const indent = 2, desc_offset = 2;
4599
220
    struct mir_eglapp_arg const* const* list;
4600
221
    int max_len = 0;
4601
222
4602
223
    for (list = arg_lists; *list != NULL; ++list)
4603
224
    {
4604
225
        struct mir_eglapp_arg const* arg;
4605
226
        for (arg = *list; arg->syntax != NULL; ++arg)
4606
227
        {
4607
228
            int len = indent + strlen(arg->syntax);
4608
229
            if (len > max_len)
4609
230
                max_len = len;
4610
231
        }
4611
232
    }
4612
233
    for (list = arg_lists; *list != NULL; ++list)
4613
234
    {
4614
235
        struct mir_eglapp_arg const* arg;
4615
236
        for (arg = *list; arg->syntax != NULL; ++arg)
4616
237
        {
4617
238
            int len = 0, remainder = 0;
4618
239
            printf("%*c%s%n", indent, ' ', arg->syntax, &len);
4619
240
            remainder = desc_offset + max_len - len;
4620
241
            printf("%*c%s", remainder, ' ', arg->description);
4621
242
            switch (arg->format[0])
4622
243
            {
4623
244
            case '=':
4624
245
                {
4625
246
                    char const* str = *(char const**)arg->variable;
4626
247
                    if (str)
4627
248
                        printf(" [%s]", str);
4628
249
                }
4629
250
                break;
4630
251
            case '%':
4631
252
                switch (arg->format[1])
4632
253
                {
4633
254
                case 'u': printf(" [%u]", *(unsigned*)arg->variable); break;
4634
255
                case 'f': printf(" [%.1f]", *(float*)arg->variable); break;
4635
256
                default: break;
4636
257
                }
4637
258
            default:
4638
259
                break;
4639
260
            }
4640
261
            printf("\n");
4641
262
        }
4642
263
    }
4643
264
}
4644
265
4645
266
static mir_eglapp_bool parse_args(int argc, char *argv[],
4646
267
                             struct mir_eglapp_arg const* const* arg_lists)
4647
268
{
4648
269
    for (int i = 1; i < argc; ++i)
4649
270
    {
4650
271
        char const* operator = argv[i];
4651
272
        struct mir_eglapp_arg const* const* list;
4652
273
        for (list = arg_lists; *list != NULL; ++list)
4653
274
        {
4654
275
            struct mir_eglapp_arg const* arg;
4655
276
            for (arg = *list; arg->syntax != NULL; ++arg)
4656
277
            {
4657
278
                char const* space = strchr(arg->syntax, ' ');
4658
279
                int operator_len = space != NULL ? space - arg->syntax
4659
280
                                                 : (int)strlen(arg->syntax);
4660
281
                if (!strncmp(operator, arg->syntax, operator_len))
4661
282
                {
4662
283
                    char const* operand = operator + operator_len;
4663
284
                    if (!operand[0] && strchr("=%", arg->format[0]))
4664
285
                    {
4665
286
                        if (i+1 < argc)
4666
287
                            operand = argv[++i];
4667
288
                        else
4668
289
                        {
4669
290
                            fprintf(stderr, "Missing argument for %s\n",
4670
291
                                    operator);
4671
292
                            return 0;
4672
293
                        }
4673
294
                    }
4674
295
                    switch (arg->format[0])
4675
296
                    {
4676
297
                    case '$': return 1;  /* -- is special */
4677
298
                    case '!': *(mir_eglapp_bool*)arg->variable = 1; break;
4678
299
                    case '=': *(char const**)arg->variable = operand; break;
4679
300
                    case '%':
4680
301
                        if (!sscanf(operand, arg->format, arg->variable))
4681
302
                        {
4682
303
                            fprintf(stderr,
4683
304
                                    "Invalid option: %s  (expected %s)\n",
4684
305
                                    operand, arg->syntax);
4685
306
                            return 0;
4686
307
                        }
4687
308
                        break;
4688
309
                    default: abort(); break;
4689
310
                    }
4690
311
                    goto next;
4691
312
                }
4692
313
            }
4693
314
        }
4694
315
        fprintf(stderr, "Unknown option: %s\n", operator);
4695
316
        return 0;
4696
317
        next:
4697
318
        (void)0; /* Stop compiler warnings about label at the end */
4698
319
    }
4699
320
    return 1;
4700
321
}
4701
322
4702
323
mir_eglapp_bool mir_eglapp_init(int argc, char* argv[],
4703
324
                                unsigned int* width, unsigned int* height,
4704
325
                                struct mir_eglapp_arg const* custom_args)
4705
186
{
326
{
4706
187
    EGLint ctxattribs[] =
327
    EGLint ctxattribs[] =
4707
188
    {
328
    {
4708
@@ -195,153 +335,60 @@
4709
195
    EGLBoolean ok;
335
    EGLBoolean ok;
4710
196
    EGLint swapinterval = 1;
336
    EGLint swapinterval = 1;
4711
197
    unsigned int output_id = mir_display_output_id_invalid;
337
    unsigned int output_id = mir_display_output_id_invalid;
4713
198
    char *mir_socket = NULL;
338
    char const* mir_socket = NULL;
4714
339
    char const* dims = NULL;
4715
199
    char const* cursor_name = mir_default_cursor_name;
340
    char const* cursor_name = mir_default_cursor_name;
4716
200
    unsigned int rgb_bits = 8;
341
    unsigned int rgb_bits = 8;
4861
201
342
    mir_eglapp_bool help = 0, no_vsync = 0, quiet = 0;
4862
202
    if (argc > 1)
343
    mir_eglapp_bool fullscreen = !*width || !*height;
4863
203
    {
344
4864
204
        int i;
345
    struct mir_eglapp_arg const default_args[] =
4865
205
        for (i = 1; i < argc; i++)
346
    {
4866
206
        {
347
        {"-a <name>", "=", &appname, "Set application name"},
4867
207
            mir_eglapp_bool help = 0;
348
        {"-b <0.0-0.1>", "%f", &mir_eglapp_background_opacity, "Background opacity"},
4868
208
            const char *arg = argv[i];
349
        {"-c <name>", "=", &cursor_name, "Request cursor image by name"},
4869
209
350
        {"-e <nbits>", "%u", &rgb_bits, "EGL colour channel size"},
4870
210
            if (arg[0] == '-')
351
        {"-f", "!", &fullscreen, "Force full screen"},
4871
211
            {
352
        {"-h", "!", &help, "Show this help text"},
4872
212
                if (arg[1] == '-' && arg[2] == '\0')
353
        {"-m <socket>", "=", &mir_socket, "Mir server socket"},
4873
213
                    break;
354
        {"-n", "!", &no_vsync, "Don't sync to vblank"},
4874
214
355
        {"-o <id>", "%u", &output_id, "Force placement on output monitor ID"},
4875
215
                switch (arg[1])
356
        {"-q", "!", &quiet, "Quiet mode (no messages output)"},
4876
216
                {
357
        {"-s <width>x<height>", "=", &dims, "Force surface size"},
4877
217
                case 'a':
358
        {"--", "$", NULL, "Ignore all arguments that follow"},
4878
218
                    appname = argv[++i];
359
        {NULL, NULL, NULL, NULL}
4879
219
                    break;
360
    };
4880
220
                case 'b':
361
4881
221
                    {
362
    struct mir_eglapp_arg const* const arg_lists[] =
4882
222
                        float alpha = 1.0f;
363
    {
4883
223
                        arg += 2;
364
        default_args,
4884
224
                        if (!arg[0] && i < argc-1)
365
        custom_args,
4885
225
                        {
366
        NULL
4886
226
                            i++;
367
    };
4887
227
                            arg = argv[i];
368
4888
228
                        }
369
    if (!parse_args(argc, argv, arg_lists))
4889
229
                        if (sscanf(arg, "%f", &alpha) == 1)
370
        return 0;
4890
230
                        {
371
4891
231
                            mir_eglapp_background_opacity = alpha;
372
    if (help)
4892
232
                        }
373
    {
4893
233
                        else
374
        printf("Usage: %s [<options>]\n", argv[0]);
4894
234
                        {
375
        show_help(arg_lists);
4895
235
                            printf("Invalid opacity value: %s\n", arg);
376
        return 0;
4896
236
                            help = 1;
377
    }
4897
237
                        }
378
4898
238
                    }
379
    if (no_vsync)
4899
239
                    break;
380
        swapinterval = 0;
4900
240
                case 'e':
381
4901
241
                    {
382
    if (dims && (2 != sscanf(dims, "%ux%u", width, height)))
4902
242
                        arg += 2;
383
    {
4903
243
                        if (!arg[0] && i < argc-1)
384
        fprintf(stderr, "Invalid dimensions: %s\n", dims);
4904
244
                        {
385
        return 0;
4905
245
                            ++i;
386
    }
4906
246
                            arg = argv[i];
387
4907
247
                        }
388
    if (quiet)
4908
248
                        if (sscanf(arg, "%u", &rgb_bits) != 1)
389
    {
4909
249
                        {
390
        FILE *unused = freopen("/dev/null", "a", stdout);
4910
250
                            printf("Invalid colour channel depth: %s\n", arg);
391
        (void)unused;
4767
251
                            help = 1;
4768
252
                        }
4769
253
                    }
4770
254
                    break;
4771
255
                case 'n':
4772
256
                    swapinterval = 0;
4773
257
                    break;
4774
258
                case 'o':
4775
259
                    {
4776
260
                        unsigned int the_id = 0;
4777
261
                        arg += 2;
4778
262
                        if (!arg[0] && i < argc-1)
4779
263
                        {
4780
264
                            i++;
4781
265
                            arg = argv[i];
4782
266
                        }
4783
267
                        if (sscanf(arg, "%u", &the_id) == 1)
4784
268
                        {
4785
269
                            output_id = the_id;
4786
270
                        }
4787
271
                        else
4788
272
                        {
4789
273
                            printf("Invalid output ID: %s\n", arg);
4790
274
                            help = 1;
4791
275
                        }
4792
276
                    }
4793
277
                    break;
4794
278
                case 'f':
4795
279
                    *width = 0;
4796
280
                    *height = 0;
4797
281
                    break;
4798
282
                case 's':
4799
283
                    {
4800
284
                        unsigned int w, h;
4801
285
                        arg += 2;
4802
286
                        if (!arg[0] && i < argc-1)
4803
287
                        {
4804
288
                            i++;
4805
289
                            arg = argv[i];
4806
290
                        }
4807
291
                        if (sscanf(arg, "%ux%u", &w, &h) == 2)
4808
292
                        {
4809
293
                            *width = w;
4810
294
                            *height = h;
4811
295
                        }
4812
296
                        else
4813
297
                        {
4814
298
                            printf("Invalid size: %s\n", arg);
4815
299
                            help = 1;
4816
300
                        }
4817
301
                    }
4818
302
                    break;
4819
303
                case 'm':
4820
304
                    mir_socket = argv[++i];
4821
305
                    break;
4822
306
                case 'c':
4823
307
                    cursor_name = argv[++i];
4824
308
                    break;
4825
309
                case 'q':
4826
310
                    {
4827
311
                        FILE *unused = freopen("/dev/null", "a", stdout);
4828
312
                        (void)unused;
4829
313
                        break;
4830
314
                    }
4831
315
                case 'h':
4832
316
                default:
4833
317
                    help = 1;
4834
318
                    break;
4835
319
                }
4836
320
            }
4837
321
            else
4838
322
            {
4839
323
                help = 1;
4840
324
            }
4841
325
4842
326
            if (help)
4843
327
            {
4844
328
                printf("Usage: %s [<options>]\n"
4845
329
                       "  -a name          Set application name\n"
4846
330
                       "  -b               Background opacity (0.0 - 1.0)\n"
4847
331
                       "  -e               EGL colour channel size in bits\n"
4848
332
                       "  -h               Show this help text\n"
4849
333
                       "  -f               Force full screen\n"
4850
334
                       "  -o ID            Force placement on output monitor ID\n"
4851
335
                       "  -n               Don't sync to vblank\n"
4852
336
                       "  -m socket        Mir server socket\n"
4853
337
                       "  -s WIDTHxHEIGHT  Force surface size\n"
4854
338
                       "  -c name          Request cursor image by name\n"
4855
339
                       "  -q               Quiet mode (no messages output)\n"
4856
340
                       "  --               Ignore all arguments that follow\n"
4857
341
                       , argv[0]);
4858
342
                return 0;
4859
343
            }
4860
344
        }
4911
345
    }
392
    }
4912
346
393
4913
347
    connection = mir_connect_sync(mir_socket, appname);
394
    connection = mir_connect_sync(mir_socket, appname);
4914
@@ -409,10 +456,11 @@
4915
409
           mode->horizontal_resolution, mode->vertical_resolution,
456
           mode->horizontal_resolution, mode->vertical_resolution,
4916
410
           output->position_x, output->position_y);
457
           output->position_x, output->position_y);
4917
411
458
4919
412
    if (*width == 0)
459
    if (fullscreen)  /* TODO: Use surface states for this */
4920
460
    {
4921
413
        *width = mode->horizontal_resolution;
461
        *width = mode->horizontal_resolution;
4922
414
    if (*height == 0)
4923
415
        *height = mode->vertical_resolution;
462
        *height = mode->vertical_resolution;
4924
463
    }
4925
416
464
4926
417
    mir_display_config_destroy(display_config);
465
    mir_display_config_destroy(display_config);
4927
418
466
4928
@@ -459,7 +507,6 @@
4929
459
    signal(SIGTERM, shutdown);
507
    signal(SIGTERM, shutdown);
4930
460
    signal(SIGHUP, shutdown);
508
    signal(SIGHUP, shutdown);
4931
461
509
4932
462
    printf("Surface %d DPI\n", mir_surface_get_dpi(surface));
4933
463
    eglSwapInterval(egldisplay, swapinterval);
510
    eglSwapInterval(egldisplay, swapinterval);
4934
464
511
4935
465
    running = 1;
512
    running = 1;
4936
466
513
4937
=== modified file 'examples/eglapp.h'
4938
--- examples/eglapp.h	2015-02-22 07:46:25 +0000
4939
+++ examples/eglapp.h	2016-11-29 04:47:53 +0000
4940
@@ -23,17 +23,31 @@
4941
23
extern "C" {
23
extern "C" {
4942
24
#endif
24
#endif
4943
25
25
4944
26
typedef int mir_eglapp_bool;
4945
27
struct MirConnection;
26
struct MirConnection;
4946
28
struct MirSurface;
27
struct MirSurface;
4947
28
struct MirEvent;
4948
29
4949
30
typedef int mir_eglapp_bool;
4950
31
4951
32
struct mir_eglapp_arg
4952
33
{
4953
34
    char const* syntax;
4954
35
    char const* format; /* "%" scanf format or "!"=flag, "$"=--, "="=copy */
4955
36
    void* variable;
4956
37
    char const* description;
4957
38
};
4958
29
39
4959
30
extern float mir_eglapp_background_opacity;
40
extern float mir_eglapp_background_opacity;
4960
31
41
4963
32
mir_eglapp_bool mir_eglapp_init(int argc, char *argv[],
42
mir_eglapp_bool mir_eglapp_init(int argc, char* argv[],
4964
33
                                unsigned int *width, unsigned int *height);
43
                                unsigned int* width, unsigned int* height,
4965
44
                                struct mir_eglapp_arg const* custom_args);
4966
34
void            mir_eglapp_swap_buffers(void);
45
void            mir_eglapp_swap_buffers(void);
4967
46
void            mir_eglapp_quit(void);
4968
35
mir_eglapp_bool mir_eglapp_running(void);
47
mir_eglapp_bool mir_eglapp_running(void);
4970
36
void            mir_eglapp_shutdown(void);
48
void            mir_eglapp_cleanup(void);
4971
49
void            mir_eglapp_handle_event(struct MirSurface* surface, struct MirEvent const* ev, void* unused);
4972
50
double          mir_eglapp_display_hz(void);
4973
37
51
4974
38
struct MirConnection* mir_eglapp_native_connection();
52
struct MirConnection* mir_eglapp_native_connection();
4975
39
struct MirSurface*    mir_eglapp_native_surface();
53
struct MirSurface*    mir_eglapp_native_surface();
4976
40
54
4977
=== modified file 'examples/eglcounter.cpp'
4978
--- examples/eglcounter.cpp	2015-02-22 07:46:25 +0000
4979
+++ examples/eglcounter.cpp	2016-11-29 04:47:53 +0000
4980
@@ -231,7 +231,7 @@
4981
231
    GLint linked, col;
231
    GLint linked, col;
4982
232
    unsigned int width = 512, height = 256;
232
    unsigned int width = 512, height = 256;
4983
233
233
4985
234
    if (!mir_eglapp_init(argc, argv, &width, &height))
234
    if (!mir_eglapp_init(argc, argv, &width, &height, NULL))
4986
235
        return 1;
235
        return 1;
4987
236
236
4988
237
    vshader = load_shader(vshadersrc, GL_VERTEX_SHADER);
237
    vshader = load_shader(vshadersrc, GL_VERTEX_SHADER);
4989
@@ -274,7 +274,7 @@
4990
274
        mir_eglapp_swap_buffers();
274
        mir_eglapp_swap_buffers();
4991
275
    }
275
    }
4992
276
276
4994
277
    mir_eglapp_shutdown();
277
    mir_eglapp_cleanup();
4995
278
278
4996
279
    return 0;
279
    return 0;
4997
280
}
280
}
4998
281
281
4999
=== modified file 'examples/eglflash.c'
5000
--- examples/eglflash.c	2015-02-22 07:46:25 +0000
Reviewer	Review Type	Date Requested	Status
Daniel van Vugt		2016-11-07	Approve on 2016-11-15
Mir CI Bot	continuous-integration		Approve on 2016-11-15
Review via email: mp+310238@code.launchpad.net