Merge lp:~unity-api-team/connectivity-api/connectivity-service-source-package-shuffle into lp:connectivity-api/14.10

Proposed by Antti Kaijanmäki on 2014-08-19
Status: Merged
Approved by: Charles Kerr on 2014-08-20
Approved revision: 22
Merged at revision: 16
Proposed branch: lp:~unity-api-team/connectivity-api/connectivity-service-source-package-shuffle
Merge into: lp:connectivity-api/14.10
Diff against target: 17450 lines (+6872/-9840)
117 files modified
.bzrignore (+2/-0)
CMakeLists.txt (+18/-80)
data/CMakeLists.txt (+0/-26)
data/connectivity-cpp.pc.in (+0/-11)
data/session.conf (+0/-42)
data/system.conf (+0/-23)
dbus-cpp/services/nm.h (+0/-986)
dbus-cpp/services/ofono.h (+0/-339)
dbus-cpp/services/urfkill.h (+0/-338)
dbus-cpp/services/util.h (+0/-36)
debian/connectivity-doc.install (+1/-0)
debian/control (+46/-27)
debian/libconnectivity-cpp-dev.install (+0/-3)
debian/libconnectivity-cpp-doc.install (+0/-1)
debian/libconnectivity-cpp0.install (+0/-1)
debian/libconnectivity-qt1-dev.install (+3/-0)
debian/libconnectivity-qt1.install (+1/-0)
debian/qml-module-ubuntu-connectivity.install (+1/-0)
doc/CMakeLists.txt (+0/-65)
doc/Doxyfile.in (+0/-1869)
doc/dbus/connectivity-api.txt (+26/-0)
doc/pages/mainpage.dox (+0/-23)
doc/pages/networking-status.dox (+0/-31)
doc/pages/using.dox (+0/-23)
doc/qt/CMakeLists.txt (+3/-0)
doc/qt/cpp/CMakeLists.txt (+40/-0)
doc/qt/cpp/Doxyfile.in (+2316/-0)
doc/qt/cpp/css/base.css (+638/-0)
doc/qt/cpp/css/qtquick.css (+772/-0)
doc/qt/cpp/css/reset.css (+8/-0)
doc/qt/cpp/css/scratch.css (+61/-0)
doc/qt/cpp/examples/CMakeLists.txt (+18/-0)
doc/qt/cpp/examples/example_networking_status.cpp (+86/-0)
doc/qt/cpp/pages/mainpage.dox (+18/-0)
doc/qt/cpp/pages/networking-status.dox (+35/-0)
doc/qt/cpp/pages/using.dox (+26/-0)
doc/qt/cpp/ubuntu-appdev-site-footer.html (+53/-0)
doc/qt/cpp/ubuntu-appdev-site-header.html (+35/-0)
doc/qt/qml/CMakeLists.txt (+41/-0)
doc/qt/qml/connectivity-qml.qdocconf.in (+55/-0)
doc/qt/qml/css/base.css (+638/-0)
doc/qt/qml/css/qtquick.css (+772/-0)
doc/qt/qml/css/reset.css (+8/-0)
doc/qt/qml/css/scratch.css (+61/-0)
doc/qt/qml/examples/example_networking_status.qml (+66/-0)
doc/qt/qml/pages/mainpage.qdoc (+25/-0)
doc/qt/qml/qml-api/NetworkingStatus.qml (+84/-0)
examples/CMakeLists.txt (+0/-51)
examples/example_airplane_mode.cpp (+0/-71)
examples/example_available_links.cpp (+0/-67)
examples/example_connect_to_wifi_network.cpp (+0/-61)
examples/example_networking_status.cpp (+0/-88)
examples/example_tor_over_vpn.cpp (+0/-91)
include/connectivity/networking/link.h (+0/-125)
include/connectivity/networking/manager.h (+0/-144)
include/connectivity/networking/service.h (+0/-83)
include/connectivity/networking/service/tethering/service.h (+0/-59)
include/connectivity/networking/service/tor/service.h (+0/-46)
include/connectivity/networking/service/vpn/service.h (+0/-49)
include/connectivity/networking/wifi/access-point.h (+0/-56)
include/connectivity/networking/wifi/link.h (+0/-61)
include/connectivity/networking/wwan/link.h (+0/-54)
src/CMakeLists.txt (+0/-33)
src/manager.cpp (+0/-36)
src/platform/nmofono/CMakeLists.txt (+0/-41)
src/platform/nmofono/bounded_integer.h (+0/-178)
src/platform/nmofono/kill-switch.cpp (+0/-96)
src/platform/nmofono/kill-switch.h (+0/-84)
src/platform/nmofono/manager.cpp (+0/-263)
src/platform/nmofono/manager.h (+0/-60)
src/platform/nmofono/manager_ref.h (+0/-483)
src/platform/nmofono/ofono_nm_connectivity_manager.cpp (+0/-338)
src/platform/nmofono/service.cpp (+0/-18)
src/platform/nmofono/service.h (+0/-47)
src/platform/nmofono/set_name_for_thread.cpp (+0/-24)
src/platform/nmofono/set_name_for_thread.h (+0/-28)
src/platform/nmofono/wifi/access-point.cpp (+0/-101)
src/platform/nmofono/wifi/access-point.h (+0/-82)
src/platform/nmofono/wifi/grouped-access-point.cpp (+0/-218)
src/platform/nmofono/wifi/grouped-access-point.h (+0/-84)
src/platform/nmofono/wifi/link.cpp (+0/-503)
src/platform/nmofono/wifi/link.h (+0/-86)
src/platform/util.cpp (+0/-33)
src/qt/CMakeLists.txt (+14/-0)
src/qt/include/ubuntu/connectivity/networking-status.h (+129/-0)
src/qt/qml/CMakeLists.txt (+1/-0)
src/qt/qml/Ubuntu/CMakeLists.txt (+1/-0)
src/qt/qml/Ubuntu/Connectivity/CMakeLists.txt (+38/-0)
src/qt/qml/Ubuntu/Connectivity/networking-status.cpp (+43/-0)
src/qt/qml/Ubuntu/Connectivity/networking-status.h (+52/-0)
src/qt/qml/Ubuntu/Connectivity/plugin.cpp (+40/-0)
src/qt/qml/Ubuntu/Connectivity/plugin.h (+36/-0)
src/qt/qml/Ubuntu/Connectivity/qmldir (+2/-0)
src/qt/src/CMakeLists.txt (+49/-0)
src/qt/src/connectivity-qt.pc.in (+10/-0)
src/qt/src/dbus-properties-interface.cpp (+34/-0)
src/qt/src/dbus-properties-interface.h (+53/-0)
src/qt/src/networking-status.cpp (+188/-0)
tests/CMakeLists.txt (+0/-132)
tests/integration/CMakeLists.txt (+1/-0)
tests/integration/qt/CMakeLists.txt (+13/-0)
tests/integration/qt/cpp/CMakeLists.txt (+16/-0)
tests/integration/qt/cpp/main.cpp (+36/-0)
tests/integration/qt/cpp/tst_networking.cpp (+51/-0)
tests/integration/qt/cpp/tst_networking.h (+36/-0)
tests/integration/qt/qml/CMakeLists.txt (+19/-0)
tests/integration/qt/qml/tst_api.qml (+53/-0)
tests/mocks/urfkill.h (+0/-162)
tests/sig_term_catcher.h (+0/-74)
tests/test_data.h.in (+0/-109)
tests/test_flight_mode.cpp (+0/-138)
tests/test_networking_status.cpp (+0/-178)
tests/test_service.h (+0/-124)
tests/test_wifi_connect.cpp (+0/-269)
tests/test_wifi_link.cpp (+0/-362)
tests/test_wifi_link_dedup.cpp (+0/-240)
tests/test_wifi_link_enable_disable.cpp (+0/-186)
To merge this branch: bzr merge lp:~unity-api-team/connectivity-api/connectivity-service-source-package-shuffle
Reviewer Review Type Date Requested Status
Robert Bruce Park (community) Approve on 2014-08-21
Timo Jyrinki (community) Needs Fixing on 2014-08-21
Charles Kerr (community) 2014-08-19 Approve on 2014-08-20
PS Jenkins bot (community) continuous-integration Approve on 2014-08-19
Review via email: mp+231431@code.launchpad.net

Commit message

* Move out connectivity-cpp to lp:indicator-network
* Move in libconnectivity-qt and qtdeclarative5-connectivity-plugin
  from lp:indicator-network
* removes binary packages
  - libconnectivity-cpp0
  - libconnectivity-cpp-dev
  - libconnectivity-cpp-doc
* adds binary packages:
  - libconnectivity-qt1
  - libconnectivity-qt1-dev
  - qml-module-ubuntu-connectivity
  - connectivity-doc

To post a comment you must log in.
21. By Antti Kaijanmäki on 2014-08-19

fix coverage target.

22. By Antti Kaijanmäki on 2014-08-19

add missing dbus-test-runner builddep

Charles Kerr (charlesk) :
review: Approve
Timo Jyrinki (timo-jyrinki) wrote :

Antti asked to check the debian/ changes. Nothing wrong otherwise, but please use the qml-module-foo naming instead, so that it won't need to be renamed later again.

See bug #1342031.

So, it'd be qml-module-connectivity and referred to as module, not a plugin. Please also change the dependencies to point to the correct packages instead of the transtional ones:

qml-module-qtquick2,
qml-module-qttest,

review: Needs Fixing
Timo Jyrinki (timo-jyrinki) wrote :

For the connectivity QML module, the precise naming depends on which name you install it with.

For example, the "test" in qtdeclarative5 naming became "qttest" in the new naming since it's installed under /usr/lib/*/qt5/qml/QtTest/

qml-module-qtquick-xmllistmodel has path /usr/lib/*/qt5/qml/QtQuick/XmlListModel, as an example if you have more than one subdir.

23. By Antti Kaijanmäki on 2014-08-21

change qml package name.

24. By Antti Kaijanmäki on 2014-08-21

rename qml module

Robert Bruce Park (robru) wrote :

lgtm

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file '.bzrignore'
2--- .bzrignore 2014-04-11 13:58:10 +0000
3+++ .bzrignore 2014-08-21 18:21:03 +0000
4@@ -2,3 +2,5 @@
5 .cproject
6 .settings
7 build
8+*~
9+*.user
10
11=== modified file 'CMakeLists.txt'
12--- CMakeLists.txt 2014-05-28 15:29:04 +0000
13+++ CMakeLists.txt 2014-08-21 18:21:03 +0000
14@@ -1,31 +1,22 @@
15-# Copyright © 2013 Canonical Ltd.
16-#
17-# This program is free software: you can redistribute it and/or modify it
18-# under the terms of the GNU Lesser General Public License version 3,
19-# as published by the Free Software Foundation.
20-#
21-# This program is distributed in the hope that it will be useful,
22-# but WITHOUT ANY WARRANTY; without even the implied warranty of
23-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24-# GNU Lesser General Public License for more details.
25-#
26-# You should have received a copy of the GNU Lesser General Public License
27-# along with this program. If not, see <http://www.gnu.org/licenses/>.
28-#
29-# Authors:
30-# Antti Kaijanmäki <antti.kaijanmaki@canonical.com>
31-
32 cmake_minimum_required(VERSION 2.8)
33 project(connectivity-cpp)
34
35+string(TOLOWER "${CMAKE_BUILD_TYPE}" build_type_lower)
36+
37 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules)
38
39 include(EnableCoverageReport)
40 include(GNUInstallDirs)
41
42-set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -pedantic -Wextra -fPIC -fvisibility=hidden -pthread")
43-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -Wall -fno-strict-aliasing -fvisibility=hidden -fvisibility-inlines-hidden -pedantic -Wextra -fPIC -pthread")
44-#set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--no-undefined")
45+set(COMMON_FLAGS "-Wall -Wextra -Wpedantic -fno-permissive -fPIC -fvisibility=hidden -pthread")
46+if(NOT build_type_lower MATCHES debug)
47+ set(COMMON_FLAGS "${COMMON_FLAGS} -Werror")
48+endif()
49+
50+# "nice bug" in cmake... http://www.cmake.org/Bug/view.php?id=15058
51+# let's not set C_FLAGS as it will break pthreads detection \o/
52+#set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${COMMON_FLAGS}")
53+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 ${COMMON_FLAGS} -fno-strict-aliasing -fvisibility-inlines-hidden")
54
55 #####################################################################
56 # Enable code coverage calculation with gcov/gcovr/lcov
57@@ -35,78 +26,25 @@
58 # * Find html report in subdir coveragereport
59 # * Find xml report feasible for jenkins in coverage.xml
60 #####################################################################
61-IF(CMAKE_BUILD_TYPE MATCHES [cC][oO][vV][eE][rR][aA][gG][eE])
62+IF(build_type_lower MATCHES coverage)
63 SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -ftest-coverage -fprofile-arcs" )
64 SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -ftest-coverage -fprofile-arcs" )
65 SET(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -ftest-coverage -fprofile-arcs" )
66 SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -ftest-coverage -fprofile-arcs" )
67-ENDIF(CMAKE_BUILD_TYPE MATCHES [cC][oO][vV][eE][rR][aA][gG][eE])
68-
69-set(CONNECTIVITY_CPP_VERSION_MAJOR 0)
70-set(CONNECTIVITY_CPP_VERSION_MINOR 0)
71-set(CONNECTIVITY_CPP_VERSION_PATCH 1)
72+ENDIF()
73
74 include(CTest)
75
76 find_package(PkgConfig REQUIRED)
77
78-include_directories(include)
79-include_directories(dbus-cpp)
80-
81-pkg_check_modules(
82- PROPERTIESCPP REQUIRED
83- properties-cpp
84-)
85-include_directories(${PROPERTIESCPP_INCLUDE_DIRS})
86-
87-pkg_check_modules(
88- DBUSCPP REQUIRED
89- dbus-cpp
90-)
91-include_directories(${DBUSCPP_INCLUDE_DIRS})
92-
93-pkg_check_modules(
94- NETWORKMANAGER REQUIRED
95- NetworkManager
96-)
97-include_directories(${NETWORKMANAGER_NCLUDE_DIRS})
98-
99-# list these here to have them visible in Qt Creator
100-set(CONNECTIVITY_INTERFACES
101- include/connectivity/networking/link.h
102- include/connectivity/networking/manager.h
103- include/connectivity/networking/service.h
104-
105- include/connectivity/networking/service/tethering/service.h
106- include/connectivity/networking/service/tor/service.h
107- include/connectivity/networking/service/vpn/service.h
108-
109- include/connectivity/networking/wifi/access-point.h
110- include/connectivity/networking/wifi/link.h
111-
112- include/connectivity/networking/wwan/link.h
113-)
114-add_custom_target(QtCreatorHeaderHack SOURCES ${CONNECTIVITY_INTERFACES})
115-
116-# list these here to have them visible in Qt Creator
117-set(DBUS_INTERFACES
118- dbus-cpp/services/nm.h
119- dbus-cpp/services/ofono.h
120- dbus-cpp/services/urfkill.h
121-)
122-add_custom_target(QtCreatorHeaderHack2 SOURCES ${DBUS_INTERFACES})
123-
124-add_subdirectory(data)
125+set(CONNECTIVITY_QT_VERSION_MAJOR 1)
126+set(CONNECTIVITY_QT_VERSION_MINOR 0)
127+set(CONNECTIVITY_QT_LIB_TARGET connectivity-qt${CONNECTIVITY_QT_VERSION_MAJOR})
128+
129 add_subdirectory(doc)
130-add_subdirectory(examples)
131 enable_testing()
132 add_subdirectory(tests)
133 add_subdirectory(src)
134
135-install(
136- DIRECTORY include/
137- DESTINATION include/connectivity-cpp-${CONNECTIVITY_CPP_VERSION_MAJOR}
138-)
139-
140-enable_coverage_report(TARGETS connectivity-cpp
141+enable_coverage_report(TARGETS connectivity-qt1
142 FILTER ${CMAKE_SOURCE_DIR}/tests/* ${CMAKE_BINARY_DIR}/*)
143
144=== removed directory 'data'
145=== removed file 'data/CMakeLists.txt'
146--- data/CMakeLists.txt 2014-01-23 22:09:36 +0000
147+++ data/CMakeLists.txt 1970-01-01 00:00:00 +0000
148@@ -1,26 +0,0 @@
149-# Copyright © 2013 Canonical Ltd.
150-#
151-# This program is free software: you can redistribute it and/or modify it
152-# under the terms of the GNU Lesser General Public License version 3,
153-# as published by the Free Software Foundation.
154-#
155-# This program is distributed in the hope that it will be useful,
156-# but WITHOUT ANY WARRANTY; without even the implied warranty of
157-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
158-# GNU Lesser General Public License for more details.
159-#
160-# You should have received a copy of the GNU Lesser General Public License
161-# along with this program. If not, see <http://www.gnu.org/licenses/>.
162-#
163-# Authors:
164-# Antti Kaijanmäki <antti.kaijanmaki@canonical.com>
165-
166-configure_file(
167- connectivity-cpp.pc.in connectivity-cpp.pc @ONLY
168-)
169-
170-install(
171- FILES ${CMAKE_CURRENT_BINARY_DIR}/connectivity-cpp.pc
172- DESTINATION lib/pkgconfig
173-)
174-
175
176=== removed file 'data/connectivity-cpp.pc.in'
177--- data/connectivity-cpp.pc.in 2014-04-23 14:18:33 +0000
178+++ data/connectivity-cpp.pc.in 1970-01-01 00:00:00 +0000
179@@ -1,11 +0,0 @@
180-prefix=@CMAKE_INSTALL_PREFIX@
181-exec_prefix=${prefix}
182-libdir=${exec_prefix}/@CMAKE_INSTALL_LIBDIR@
183-includedir=${exec_prefix}/include
184-
185-Name: @CMAKE_PROJECT_NAME@
186-Description:
187-Version: @CONNECTIVITY_CPP_VERSION_MAJOR@.@CONNECTIVITY_CPP_VERSION_MINOR@.@CONNECTIVITY_CPP_VERSION_PATCH@
188-Cflags: -I${includedir}/connectivity-cpp-@CONNECTIVITY_CPP_VERSION_MAJOR@
189-Libs: -L${libdir} -lconnectivity-cpp
190-Requires: dbus-cpp properties-cpp
191
192=== removed file 'data/session.conf'
193--- data/session.conf 2014-01-23 22:09:36 +0000
194+++ data/session.conf 1970-01-01 00:00:00 +0000
195@@ -1,42 +0,0 @@
196-<!DOCTYPE busconfig PUBLIC "-//freedesktop//DTD D-Bus Bus Configuration 1.0//EN"
197- "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd">
198-<busconfig>
199- <!-- If we fork, keep the user's original umask to avoid affecting
200- the behavior of child processes. -->
201- <keep_umask/>
202-
203- <type>session</type>
204-
205- <listen>unix:tmpdir=/tmp</listen>
206-
207- <standard_session_servicedirs />
208-
209- <policy context="default">
210- <!-- Allow everything to be sent -->
211- <allow send_destination="*" eavesdrop="true"/>
212- <!-- Allow everything to be received -->
213- <allow eavesdrop="true"/>
214- <!-- Allow anyone to own anything -->
215- <allow own="*"/>
216- </policy>
217-
218- <!-- raise the service start timeout to 40 seconds as it can timeout
219- on the live cd on slow machines -->
220- <limit name="service_start_timeout">60000</limit>
221-
222- <!-- the memory limits are 1G instead of say 4G because they can't exceed 32-bit signed int max -->
223- <limit name="max_incoming_bytes">1000000000</limit>
224- <limit name="max_outgoing_bytes">1000000000</limit>
225- <limit name="max_message_size">1000000000</limit>
226- <limit name="service_start_timeout">120000</limit>
227- <limit name="auth_timeout">240000</limit>
228- <limit name="max_completed_connections">100000</limit>
229- <limit name="max_incomplete_connections">10000</limit>
230- <limit name="max_connections_per_user">100000</limit>
231- <limit name="max_pending_service_starts">10000</limit>
232- <limit name="max_names_per_connection">50000</limit>
233- <limit name="max_match_rules_per_connection">50000</limit>
234- <limit name="max_replies_per_connection">50000</limit>
235- <limit name="reply_timeout">300000</limit>
236-
237-</busconfig>
238
239=== removed file 'data/system.conf'
240--- data/system.conf 2014-01-23 22:09:36 +0000
241+++ data/system.conf 1970-01-01 00:00:00 +0000
242@@ -1,23 +0,0 @@
243-<!DOCTYPE busconfig PUBLIC "-//freedesktop//DTD D-Bus Bus Configuration 1.0//EN"
244- "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd">
245-<busconfig>
246- <!-- If we fork, keep the user's original umask to avoid affecting
247- the behavior of child processes. -->
248- <keep_umask/>
249-
250- <type>system</type>
251-
252- <listen>unix:tmpdir=/tmp</listen>
253-
254- <standard_system_servicedirs/>
255-
256- <policy context="default">
257- <!-- Allow everything to be sent -->
258- <allow send_destination="*" eavesdrop="true"/>
259- <!-- Allow everything to be received -->
260- <allow eavesdrop="true"/>
261- <!-- Allow anyone to own anything -->
262- <allow own="*"/>
263- </policy>
264-
265-</busconfig>
266
267=== removed directory 'dbus-cpp'
268=== removed directory 'dbus-cpp/services'
269=== removed file 'dbus-cpp/services/nm.h'
270--- dbus-cpp/services/nm.h 2014-04-30 12:06:30 +0000
271+++ dbus-cpp/services/nm.h 1970-01-01 00:00:00 +0000
272@@ -1,986 +0,0 @@
273-/*
274- * Copyright © 2012-2013 Canonical Ltd.
275- *
276- * This program is free software: you can redistribute it and/or modify it
277- * under the terms of the GNU Lesser General Public License version 3,
278- * as published by the Free Software Foundation.
279- *
280- * This program is distributed in the hope that it will be useful,
281- * but WITHOUT ANY WARRANTY; without even the implied warranty of
282- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
283- * GNU Lesser General Public License for more details.
284- *
285- * You should have received a copy of the GNU Lesser General Public License
286- * along with this program. If not, see <http://www.gnu.org/licenses/>.
287- *
288- * Authored by: Antti Kaijanmäki <antti.kaijanmaki@canonical.com>
289- */
290-#ifndef PLATFORM_MANAGER_NMOFONO_NM_H
291-#define PLATFORM_MANAGER_NMOFONO_NM_H
292-
293-#include <core/dbus/bus.h>
294-#include <core/dbus/object.h>
295-#include <core/dbus/property.h>
296-#include <core/dbus/service.h>
297-#include <core/dbus/types/object_path.h>
298-#include <core/dbus/types/any.h>
299-#include <core/dbus/types/struct.h>
300-#include <core/dbus/types/stl/map.h>
301-#include <core/dbus/types/stl/string.h>
302-#include <core/dbus/types/stl/tuple.h>
303-#include <core/dbus/types/stl/vector.h>
304-#include <NetworkManager/NetworkManager.h>
305-#include "util.h"
306-
307-namespace org
308-{
309-namespace freedesktop
310-{
311-namespace NetworkManager
312-{
313- struct Interface {
314-
315- struct AccessPoint
316- {
317- static const std::string& name()
318- {
319- static const std::string s{NM_DBUS_INTERFACE_ACCESS_POINT};
320- return s;
321- }
322-
323- struct Property {
324- struct Frequency
325- {
326- static const std::string& name()
327- {
328- static const std::string s{"Frequency"};
329- return s;
330- }
331-
332- typedef AccessPoint Interface;
333- typedef std::uint32_t ValueType;
334- static const bool readable = true;
335- static const bool writable = false;
336- };
337-
338- struct Flags
339- {
340- static const std::string& name()
341- {
342- static const std::string s{"Flags"};
343- return s;
344- }
345-
346- typedef AccessPoint Interface;
347- typedef std::uint32_t ValueType;
348- static const bool readable = true;
349- static const bool writable = false;
350- };
351-
352- struct WpaFlags
353- {
354- static const std::string& name()
355- {
356- static const std::string s{"WpaFlags"};
357- return s;
358- }
359-
360- typedef AccessPoint Interface;
361- typedef std::uint32_t ValueType;
362- static const bool readable = true;
363- static const bool writable = false;
364- };
365-
366- struct RsnFlags
367- {
368- static const std::string& name()
369- {
370- static const std::string s{"RsnFlags"};
371- return s;
372- }
373-
374- typedef AccessPoint Interface;
375- typedef std::uint32_t ValueType;
376- static const bool readable = true;
377- static const bool writable = false;
378- };
379-
380- struct Mode
381- {
382- static const std::string& name()
383- {
384- static const std::string s{"Mode"};
385- return s;
386- }
387-
388- typedef AccessPoint Interface;
389- typedef std::uint32_t ValueType;
390- static const bool readable = true;
391- static const bool writable = false;
392- };
393-
394- struct Ssid
395- {
396- static const std::string& name()
397- {
398- static const std::string s{"Ssid"};
399- return s;
400- }
401-
402- typedef AccessPoint Interface;
403- /// @todo bug tvoss.. D-Bus BYTE(y) should be unsigned
404- typedef std::vector<std::int8_t> ValueType;
405- static const bool readable = true;
406- static const bool writable = false;
407- };
408-
409- struct HwAddress
410- {
411- static const std::string& name()
412- {
413- static const std::string s{"HwAddress"};
414- return s;
415- }
416-
417- typedef AccessPoint Interface;
418- typedef std::string ValueType;
419- static const bool readable = true;
420- static const bool writable = false;
421- };
422-
423- struct Strength
424- {
425- static const std::string& name()
426- {
427- static const std::string s{"Strength"};
428- return s;
429- }
430-
431- typedef AccessPoint Interface;
432- typedef std::int8_t ValueType;
433- static const bool readable = true;
434- static const bool writable = false;
435- };
436- };
437-
438- struct Signal {
439- struct PropertiesChanged
440- {
441- static const std::string& name()
442- {
443- static const std::string s{"PropertiesChanged"};
444- return s;
445- }
446-
447- typedef AccessPoint Interface;
448- typedef std::map<std::string, core::dbus::types::Variant> ArgumentType;
449- };
450- };
451-
452- AccessPoint(const std::shared_ptr<core::dbus::Object>& object)
453- : object(object),
454- frequency(object->get_property<Property::Frequency>()),
455- hw_address(object->get_property<Property::HwAddress>()),
456- strength(object->get_property<Property::Strength>()),
457- flags(object->get_property<Property::Flags>()),
458- wpa_flags(object->get_property<Property::WpaFlags>()),
459- rsn_flags(object->get_property<Property::RsnFlags>()),
460- mode(object->get_property<Property::Mode>()),
461- ssid(object->get_property<Property::Ssid>()),
462- properties_changed(object->get_signal<Signal::PropertiesChanged>())
463-
464- {}
465-
466- std::shared_ptr<core::dbus::Object> object;
467- std::shared_ptr<core::dbus::Property<Property::Frequency>> frequency;
468- std::shared_ptr<core::dbus::Property<Property::HwAddress>> hw_address;
469- std::shared_ptr<core::dbus::Property<Property::Strength>> strength;
470- std::shared_ptr<core::dbus::Property<Property::Flags>> flags;
471- std::shared_ptr<core::dbus::Property<Property::WpaFlags>> wpa_flags;
472- std::shared_ptr<core::dbus::Property<Property::RsnFlags>> rsn_flags;
473- std::shared_ptr<core::dbus::Property<Property::Mode>> mode;
474- std::shared_ptr<core::dbus::Property<Property::Ssid>> ssid;
475- std::shared_ptr<core::dbus::Signal<Signal::PropertiesChanged, Signal::PropertiesChanged::ArgumentType>> properties_changed;
476- }; // Interface::AccessPoint
477-
478-
479- struct ActiveConnection
480- {
481- static const std::string& name()
482- {
483- static const std::string s{NM_DBUS_INTERFACE_ACTIVE_CONNECTION};
484- return s;
485- }
486-
487- struct Property {
488- struct Connection
489- {
490- static const std::string& name()
491- {
492- static const std::string s{"Connection"};
493- return s;
494- }
495-
496- typedef ActiveConnection Interface;
497- typedef core::dbus::types::ObjectPath ValueType;
498- static const bool readable = true;
499- static const bool writable = false;
500- };
501- struct SpecificObject
502- {
503- static const std::string& name()
504- {
505- static const std::string s{"SpecificObject"};
506- return s;
507- }
508-
509- typedef ActiveConnection Interface;
510- typedef core::dbus::types::ObjectPath ValueType;
511- static const bool readable = true;
512- static const bool writable = false;
513- };
514- struct Uuid
515- {
516- static const std::string& name()
517- {
518- static const std::string s{"Uuid"};
519- return s;
520- }
521-
522- typedef ActiveConnection Interface;
523- typedef std::string ValueType;
524- static const bool readable = true;
525- static const bool writable = false;
526- };
527- struct Devices
528- {
529- static const std::string& name()
530- {
531- static const std::string s{"Devices"};
532- return s;
533- }
534-
535- typedef ActiveConnection Interface;
536- typedef std::vector<core::dbus::types::ObjectPath> ValueType;
537- static const bool readable = true;
538- static const bool writable = false;
539- };
540- struct State
541- {
542- static const std::string& name()
543- {
544- static const std::string s{"State"};
545- return s;
546- }
547-
548- typedef ActiveConnection Interface;
549- typedef std::uint32_t ValueType;
550- static const bool readable = true;
551- static const bool writable = false;
552- };
553- struct Default
554- {
555- static const std::string& name()
556- {
557- static const std::string s{"Default"};
558- return s;
559- }
560-
561- typedef ActiveConnection Interface;
562- typedef bool ValueType;
563- static const bool readable = true;
564- static const bool writable = false;
565- };
566- struct Default6
567- {
568- static const std::string& name()
569- {
570- static const std::string s{"Default6"};
571- return s;
572- }
573-
574- typedef ActiveConnection Interface;
575- typedef bool ValueType;
576- static const bool readable = true;
577- static const bool writable = false;
578- };
579- struct Vpn
580- {
581- static const std::string& name()
582- {
583- static const std::string s{"Vpn"};
584- return s;
585- }
586-
587- typedef ActiveConnection Interface;
588- typedef bool ValueType;
589- static const bool readable = true;
590- static const bool writable = false;
591- };
592- struct Master
593- {
594- static const std::string& name()
595- {
596- static const std::string s{"Master"};
597- return s;
598- }
599-
600- typedef ActiveConnection Interface;
601- typedef bool ValueType;
602- static const bool readable = true;
603- static const bool writable = false;
604- };
605- }; // struct Property
606-
607- struct Signal {
608- struct PropertiesChanged
609- {
610- static const std::string& name()
611- {
612- static const std::string s{"PropertiesChanged"};
613- return s;
614- }
615-
616- typedef ActiveConnection Interface;
617- typedef std::map<std::string, core::dbus::types::Variant> ArgumentType;
618- };
619- };
620-
621- enum class State
622- {
623- unknown = NM_ACTIVE_CONNECTION_STATE_UNKNOWN,
624- activating = NM_ACTIVE_CONNECTION_STATE_ACTIVATING,
625- activated = NM_ACTIVE_CONNECTION_STATE_ACTIVATED,
626- deactivating = NM_ACTIVE_CONNECTION_STATE_DEACTIVATING,
627- deactivated = NM_ACTIVE_CONNECTION_STATE_DEACTIVATED
628- };
629-
630- ActiveConnection(const std::shared_ptr<core::dbus::Object>& object)
631- : object(object),
632- connection(object->get_property<Property::Connection>()),
633- specific_object(object->get_property<Property::SpecificObject>()),
634- uuid(object->get_property<Property::Uuid>()),
635- devices(object->get_property<Property::Devices>()),
636- state(object->get_property<Property::State>()),
637- default_ipv4(object->get_property<Property::Default>()),
638- default_ipv6(object->get_property<Property::Default6>()),
639- vpn(object->get_property<Property::Vpn>()),
640- master(object->get_property<Property::Master>()),
641- properties_changed(object->get_signal<Signal::PropertiesChanged>())
642- {
643- token = properties_changed->connect([this](const Signal::PropertiesChanged::ArgumentType &map){
644- for (auto entry: map) {
645- if (entry.first == "State") {
646-#if 0
647- std::uint32_t new_value = entry.second.as<std::uint32_t>();
648- state->update([&new_value](std::uint32_t &current_value){
649- if (new_value == current_value)
650- return false;
651- current_value = new_value;
652- return true;
653- });
654-#endif
655- continue;
656- }
657- else {
658- std::cout << "Unexpected Connection.Active update: " << entry.first << std::endl;
659- }
660- }
661- });
662- }
663- ~ActiveConnection()
664- {
665- /// @todo fix dbus-cpp...
666- //properties_changed->disconnect(token);
667- }
668-
669- State get_state() { return static_cast<State>(state->get()); }
670-
671- std::shared_ptr<core::dbus::Object> object;
672- std::shared_ptr<core::dbus::Property<Property::Connection>> connection;
673- std::shared_ptr<core::dbus::Property<Property::SpecificObject>> specific_object;
674- std::shared_ptr<core::dbus::Property<Property::Uuid>> uuid;
675- std::shared_ptr<core::dbus::Property<Property::Devices>> devices;
676- std::shared_ptr<core::dbus::Property<Property::State>> state;
677- std::shared_ptr<core::dbus::Property<Property::Default>> default_ipv4;
678- std::shared_ptr<core::dbus::Property<Property::Default6>> default_ipv6;
679- std::shared_ptr<core::dbus::Property<Property::Vpn>> vpn;
680- std::shared_ptr<core::dbus::Property<Property::Master>> master;
681-
682- private:
683- std::shared_ptr<core::dbus::Signal<Signal::PropertiesChanged, Signal::PropertiesChanged::ArgumentType>> properties_changed;
684- core::dbus::Signal<Signal::PropertiesChanged, Signal::PropertiesChanged::ArgumentType>::SubscriptionToken token;
685- }; // Interface::ActiveConnection
686-
687- struct Connection
688- {
689- std::shared_ptr<core::dbus::Object> object;
690-
691- Connection(const std::shared_ptr<core::dbus::Object>& object)
692- : object(object)
693- {}
694-
695- static const std::string& name()
696- {
697- static const std::string s{NM_DBUS_IFACE_SETTINGS_CONNECTION};
698- return s;
699- }
700-
701- struct Method {
702- struct GetSettings
703- {
704- static const std::string& name()
705- {
706- static const std::string s{"GetSettings"};
707- return s;
708- }
709-
710- typedef Connection Interface;
711- typedef std::map<std::string, std::map<std::string, core::dbus::types::Variant>> ResultType;
712-
713- static std::chrono::milliseconds default_timeout()
714- {
715- return std::chrono::seconds{1};
716- }
717- };
718- };
719-
720- Method::GetSettings::ResultType
721- get_settings()
722- {
723-
724- auto result = object->invoke_method_synchronously<Method::GetSettings, Method::GetSettings::ResultType>();
725-
726- if (result.is_error())
727- connectivity::throw_dbus_exception(result.error());
728-
729- return result.value();
730- }
731- }; // Interface::Connection
732-
733- struct Device
734- {
735- static const std::string& name()
736- {
737- static const std::string s{NM_DBUS_INTERFACE_DEVICE};
738- return s;
739- }
740-
741- enum class Type
742- {
743- unknown = NM_DEVICE_TYPE_UNKNOWN,
744- ethernet = NM_DEVICE_TYPE_ETHERNET,
745- wifi = NM_DEVICE_TYPE_WIFI,
746- unused_1 = NM_DEVICE_TYPE_UNUSED1,
747- unused_2 = NM_DEVICE_TYPE_UNUSED2,
748- bluetooth = NM_DEVICE_TYPE_BT,
749- olpc_mesh = NM_DEVICE_TYPE_OLPC_MESH,
750- wimax = NM_DEVICE_TYPE_WIMAX,
751- modem = NM_DEVICE_TYPE_MODEM,
752- infiniband = NM_DEVICE_TYPE_INFINIBAND,
753- bond = NM_DEVICE_TYPE_BOND,
754- vlan = NM_DEVICE_TYPE_VLAN,
755- adsl = NM_DEVICE_TYPE_ADSL,
756- bridge = NM_DEVICE_TYPE_BRIDGE
757- };
758-
759- struct Wireless
760- {
761- static const std::string& name()
762- {
763- static const std::string s{NM_DBUS_INTERFACE_DEVICE_WIRELESS};
764- return s;
765- }
766-
767- struct Method {
768- struct GetAccessPoints
769- {
770- static const std::string& name()
771- {
772- static const std::string s{"GetAccessPoints"};
773- return s;
774- }
775-
776- typedef Wireless Interface;
777- typedef std::vector<core::dbus::types::ObjectPath> ResultType;
778-
779- static std::chrono::milliseconds default_timeout()
780- {
781- return std::chrono::seconds{1};
782- }
783- };
784- };
785-
786- struct Signal {
787- struct AccessPointAdded
788- {
789- static const std::string& name()
790- {
791- static const std::string s{"AccessPointAdded"};
792- return s;
793- }
794-
795- typedef Wireless Interface;
796- typedef core::dbus::types::ObjectPath ArgumentType;
797- };
798-
799- struct AccessPointRemoved
800- {
801- static const std::string& name()
802- {
803- static const std::string s{"AccessPointRemoved"};
804- return s;
805- }
806-
807- typedef Wireless Interface;
808- typedef core::dbus::types::ObjectPath ArgumentType;
809- };
810- };
811-
812- Wireless(std::shared_ptr<core::dbus::Object> &base)
813- : access_point_added(base->get_signal<Signal::AccessPointAdded>()),
814- access_point_removed(base->get_signal<Signal::AccessPointRemoved>())
815- {}
816-
817- std::shared_ptr<core::dbus::Signal<Signal::AccessPointAdded, Signal::AccessPointAdded::ArgumentType>> access_point_added;
818- std::shared_ptr<core::dbus::Signal<Signal::AccessPointRemoved, Signal::AccessPointRemoved::ArgumentType>> access_point_removed;
819-
820- }; // Interface::Device::Wireless
821-
822- struct Property {
823- struct DeviceType
824- {
825- static const std::string& name()
826- {
827- static const std::string s{"DeviceType"};
828- return s;
829- }
830-
831- typedef Device Interface;
832- typedef std::uint32_t ValueType;
833- static const bool readable = true;
834- static const bool writable = false;
835- };
836-
837- struct DeviceInterface {
838- static const std::string& name()
839- {
840- static const std::string s{"Interface"};
841- return s;
842- }
843-
844- typedef Device Interface;
845- typedef std::string ValueType;
846- static const bool readable = true;
847- static const bool writable = false;
848- };
849-
850- struct Autoconnect
851- {
852- static const std::string& name()
853- {
854- static const std::string s{"Autoconnect"};
855- return s;
856- }
857-
858- typedef Device Interface;
859- typedef bool ValueType;
860- static const bool readable = true;
861- static const bool writable = true;
862- };
863-
864- struct State {
865- static const std::string &name()
866- {
867- static const std::string s{"State"};
868- return s;
869- }
870-
871- typedef Device Interface;
872- typedef std::uint32_t ValueType;
873- static const bool readable = true;
874- static const bool writable = false;
875- };
876-
877- struct AvailableConnections {
878- static const std::string &name()
879- {
880- static const std::string s{"AvailableConnections"};
881- return s;
882- }
883-
884- typedef Device Interface;
885- typedef std::vector<core::dbus::types::ObjectPath> ValueType;
886- static const bool readable = true;
887- static const bool writable = false;
888- };
889-
890- struct ActiveConnection {
891- static const std::string &name()
892- {
893- static const std::string s{"ActiveConnection"};
894- return s;
895- }
896-
897- typedef Device Interface;
898- typedef core::dbus::types::ObjectPath ValueType;
899- static const bool readable = true;
900- static const bool writable = false;
901- };
902- };
903-
904- std::vector<Connection>
905- get_available_connections() {
906- std::vector<Connection> list;
907- for (auto c: available_connections->get()) {
908- list.push_back(Connection(service->object_for_path(c)));
909- }
910- return list;
911- }
912-
913- struct Method {
914-
915- struct Disconnect
916- {
917- static const std::string& name()
918- {
919- static const std::string s{"Disconnect"};
920- return s;
921- }
922-
923- typedef Device Interface;
924- typedef void ResultType;
925-
926- static std::chrono::milliseconds default_timeout()
927- {
928- return std::chrono::seconds{1};
929- }
930- };
931- };
932-
933- void disconnect()
934- {
935- auto result =
936- object->invoke_method_synchronously<
937- Device::Method::Disconnect, Device::Method::Disconnect::ResultType>();
938-
939- if (result.is_error())
940- connectivity::throw_dbus_exception(result.error());
941- }
942-
943- struct Signal {
944- struct StateChanged
945- {
946- static const std::string& name()
947- {
948- static const std::string s{"StateChanged"};
949- return s;
950- }
951-
952- typedef Device Interface;
953- typedef std::tuple<std::uint32_t, std::uint32_t, std::uint32_t> ArgumentType;
954- };
955- };
956-
957-
958- Type type() const
959- {
960- return static_cast<Type>(device_type->get());
961- }
962-
963- std::string interface() const
964- {
965- return device_interface->get();
966- }
967-
968- Wireless::Method::GetAccessPoints::ResultType get_access_points() const
969- {
970- auto result = object->invoke_method_synchronously<Wireless::Method::GetAccessPoints,
971- Wireless::Method::GetAccessPoints::ResultType>();
972-
973- if (result.is_error())
974- connectivity::throw_dbus_exception(result.error());
975-
976- return result.value();
977- }
978-
979- Device(const std::shared_ptr<core::dbus::Service>& service,
980- const std::shared_ptr<core::dbus::Object>& object)
981- : service(service),
982- object(object),
983- device_type(object->get_property<Property::DeviceType>()),
984- autoconnect(object->get_property<Property::Autoconnect>()),
985- device_interface(object->get_property<Property::DeviceInterface>()),
986- state(object->get_property<Property::State>()),
987- state_changed(object->get_signal<Signal::StateChanged>()),
988- available_connections(object->get_property<Property::AvailableConnections>()),
989- active_connection(object->get_property<Property::ActiveConnection>())
990- {}
991-
992- std::shared_ptr<core::dbus::Service> service;
993- std::shared_ptr<core::dbus::Object> object;
994- std::shared_ptr<core::dbus::Property<Property::DeviceType>> device_type;
995- std::shared_ptr<core::dbus::Property<Property::Autoconnect>> autoconnect;
996- std::shared_ptr<core::dbus::Property<Property::DeviceInterface>> device_interface;
997- std::shared_ptr<core::dbus::Property<Property::State>> state;
998- std::shared_ptr<core::dbus::Signal<Signal::StateChanged, Signal::StateChanged::ArgumentType>> state_changed;
999- std::shared_ptr<core::dbus::Property<Property::AvailableConnections>> available_connections;
1000- std::shared_ptr<core::dbus::Property<Property::ActiveConnection>> active_connection;
1001- }; // Interface::Device
1002-
1003- struct NetworkManager
1004- {
1005- static const std::string& name()
1006- {
1007- static const std::string s{NM_DBUS_INTERFACE};
1008- return s;
1009- }
1010-
1011- struct Method {
1012- struct ActivateConnection
1013- {
1014- static const std::string& name()
1015- {
1016- static const std::string s{"ActivateConnection"};
1017- return s;
1018- }
1019-
1020- typedef NetworkManager Interface;
1021- typedef core::dbus::types::ObjectPath ResultType;
1022-
1023- static std::chrono::milliseconds default_timeout()
1024- {
1025- return std::chrono::seconds{1};
1026- }
1027- };
1028-
1029- struct AddAndActivateConnection
1030- {
1031- static const std::string& name()
1032- {
1033- static const std::string s{"AddAndActivateConnection"};
1034- return s;
1035- }
1036-
1037- typedef NetworkManager Interface;
1038- typedef std::tuple<core::dbus::types::ObjectPath, core::dbus::types::ObjectPath> ResultType;
1039-
1040- static std::chrono::milliseconds default_timeout()
1041- {
1042- return std::chrono::seconds{1};
1043- }
1044- };
1045-
1046- struct GetDevices
1047- {
1048- static const std::string& name()
1049- {
1050- static const std::string s{"GetDevices"};
1051- return s;
1052- }
1053-
1054- typedef NetworkManager Interface;
1055- typedef std::vector<core::dbus::types::ObjectPath> ResultType;
1056-
1057- static std::chrono::milliseconds default_timeout()
1058- {
1059- return std::chrono::seconds{1};
1060- }
1061- };
1062-
1063- };
1064-
1065-
1066- struct Property
1067- {
1068- struct WirelessEnabled {
1069- static const std::string &name()
1070- {
1071- static const std::string s{"WirelessEnabled"};
1072- return s;
1073- }
1074-
1075- typedef NetworkManager Interface;
1076- typedef bool ValueType;
1077- static const bool readable = true;
1078- static const bool writable = true;
1079- };
1080-
1081- struct State {
1082- static const std::string &name()
1083- {
1084- static const std::string s{"State"};
1085- return s;
1086- }
1087-
1088- typedef NetworkManager Interface;
1089- typedef std::uint32_t ValueType;
1090- static const bool readable = true;
1091- static const bool writable = false;
1092- };
1093-
1094- struct PrimaryConnection {
1095- static const std::string &name()
1096- {
1097- static const std::string s{"PrimaryConnection"};
1098- return s;
1099- }
1100-
1101- typedef NetworkManager Interface;
1102- typedef core::dbus::types::ObjectPath ValueType;
1103- static const bool readable = true;
1104- static const bool writable = false;
1105- };
1106-
1107- };
1108-
1109- struct Signal {
1110-
1111- struct PropertiesChanged
1112- {
1113- static const std::string& name()
1114- {
1115- static const std::string s{"PropertiesChanged"};
1116- return s;
1117- }
1118-
1119- typedef NetworkManager Interface;
1120- typedef std::map<std::string, core::dbus::types::Variant> ArgumentType;
1121- };
1122-
1123- struct DeviceAdded
1124- {
1125- static const std::string& name()
1126- {
1127- static const std::string s{"DeviceAdded"};
1128- return s;
1129- }
1130-
1131- typedef NetworkManager Interface;
1132- typedef core::dbus::types::ObjectPath ArgumentType;
1133- };
1134-
1135- struct DeviceRemoved
1136- {
1137- static const std::string& name()
1138- {
1139- static const std::string s{"DeviceRemoved"};
1140- return s;
1141- }
1142-
1143- typedef NetworkManager Interface;
1144- typedef core::dbus::types::ObjectPath ArgumentType;
1145- };
1146- };
1147-
1148- Method::ActivateConnection::ResultType
1149- activate_connection(const core::dbus::types::ObjectPath &connection,
1150- const core::dbus::types::ObjectPath &device,
1151- const core::dbus::types::ObjectPath &specific_object)
1152- {
1153- auto result =
1154- object->invoke_method_synchronously<
1155- Method::ActivateConnection,
1156- Method::ActivateConnection::ResultType>
1157- (connection, device, specific_object);
1158-
1159- if (result.is_error())
1160- connectivity::throw_dbus_exception(result.error());
1161-
1162- return result.value();
1163- }
1164-
1165- Method::AddAndActivateConnection::ResultType
1166- add_and_activate_connection(std::map<std::string, std::map<std::string, core::dbus::types::Variant>> &connection,
1167- const core::dbus::types::ObjectPath &device,
1168- const core::dbus::types::ObjectPath &specific_object)
1169- {
1170- auto result =
1171- object->invoke_method_synchronously<
1172- Method::AddAndActivateConnection,
1173- Method::AddAndActivateConnection::ResultType>
1174- (connection, device, specific_object);
1175-
1176- if (result.is_error())
1177- connectivity::throw_dbus_exception(result.error());
1178-
1179-
1180- /// @todo return the settings (std::get<0>) object at some point
1181- return result.value();
1182- }
1183-
1184- std::vector<Device> get_devices()
1185- {
1186- auto result =
1187- object->invoke_method_synchronously<
1188- Method::GetDevices,
1189- Method::GetDevices::ResultType>();
1190-
1191- if (result.is_error())
1192- connectivity::throw_dbus_exception(result.error());
1193-
1194- std::vector<Device> devices;
1195- for (const auto& path : result.value())
1196- {
1197- devices.emplace_back(
1198- Device(
1199- service,
1200- service->object_for_path(path)));
1201- }
1202-
1203- return devices;
1204- }
1205-
1206- NetworkManager(std::shared_ptr<core::dbus::Service> &service,
1207- std::shared_ptr<core::dbus::Object> &object)
1208- : service(service),
1209- object(object),
1210- wireless_enabled(object->get_property<Property::WirelessEnabled>()),
1211- state(object->get_property<Property::State>()),
1212- properties_changed(object->get_signal<Signal::PropertiesChanged>()),
1213- primary_connection(object->get_property<Property::PrimaryConnection>()),
1214- device_added(object->get_signal<Signal::DeviceAdded>()),
1215- device_removed(object->get_signal<Signal::DeviceRemoved>())
1216- {
1217- }
1218-
1219- std::shared_ptr<core::dbus::Service> service;
1220- std::shared_ptr<core::dbus::Object> object;
1221-
1222- std::shared_ptr<core::dbus::Property<Property::WirelessEnabled>> wireless_enabled;
1223- std::shared_ptr<core::dbus::Property<Property::State>> state;
1224- std::shared_ptr<core::dbus::Signal<Signal::PropertiesChanged, Signal::PropertiesChanged::ArgumentType>> properties_changed;
1225- std::shared_ptr<core::dbus::Property<Property::PrimaryConnection>> primary_connection;
1226- std::shared_ptr<core::dbus::Signal<Signal::DeviceAdded, Signal::DeviceAdded::ArgumentType>> device_added;
1227- std::shared_ptr<core::dbus::Signal<Signal::DeviceRemoved, Signal::DeviceRemoved::ArgumentType>> device_removed;
1228- }; // Interface::NetworkManager
1229- };
1230-
1231- struct Service
1232- {
1233- std::shared_ptr<Interface::NetworkManager> nm;
1234-
1235- Service(const core::dbus::Bus::Ptr& bus)
1236- {
1237- auto service = core::dbus::Service::use_service<Interface::NetworkManager>(bus);
1238- auto object = service->object_for_path(core::dbus::types::ObjectPath(NM_DBUS_PATH));
1239- nm = std::make_shared<Interface::NetworkManager>(service, object);
1240- }
1241-
1242- struct Mock
1243- {
1244- std::shared_ptr<Interface::NetworkManager> nm;
1245-
1246- Mock(const core::dbus::Bus::Ptr& bus)
1247- {
1248- auto service = core::dbus::Service::add_service<Interface::NetworkManager>(bus);
1249- auto object = service->add_object_for_path(core::dbus::types::ObjectPath(NM_DBUS_PATH));
1250- nm = std::make_shared<Interface::NetworkManager>(service, object);
1251- }
1252- };
1253- };
1254-}
1255-}
1256-}
1257-
1258-#endif // PLATFORM_MANAGER_NMOFONO_NM_H
1259
1260=== removed file 'dbus-cpp/services/ofono.h'
1261--- dbus-cpp/services/ofono.h 2014-04-14 07:39:46 +0000
1262+++ dbus-cpp/services/ofono.h 1970-01-01 00:00:00 +0000
1263@@ -1,339 +0,0 @@
1264-/*
1265- * Copyright © 2012-2013 Canonical Ltd.
1266- *
1267- * This program is free software: you can redistribute it and/or modify it
1268- * under the terms of the GNU Lesser General Public License version 3,
1269- * as published by the Free Software Foundation.
1270- *
1271- * This program is distributed in the hope that it will be useful,
1272- * but WITHOUT ANY WARRANTY; without even the implied warranty of
1273- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1274- * GNU Lesser General Public License for more details.
1275- *
1276- * You should have received a copy of the GNU Lesser General Public License
1277- * along with this program. If not, see <http://www.gnu.org/licenses/>.
1278- *
1279- * Authored by: Thomas Voß <thomas.voss@canonical.com>
1280- */
1281-#ifndef LOCATION_SERVICE_LOCATION_CONNECTIVITY_OFONO_H
1282-#define LOCATION_SERVICE_LOCATION_CONNECTIVITY_OFONO_H
1283-
1284-#include <core/dbus/bus.h>
1285-#include <core/dbus/object.h>
1286-#include <core/dbus/property.h>
1287-#include <core/dbus/service.h>
1288-#include <core/dbus/types/object_path.h>
1289-#include <core/dbus/types/struct.h>
1290-#include <core/dbus/types/stl/map.h>
1291-#include <core/dbus/types/stl/string.h>
1292-#include <core/dbus/types/stl/tuple.h>
1293-#include <core/dbus/types/stl/vector.h>
1294-#include<com/ubuntu/connectivity/util.h>
1295-
1296-namespace org
1297-{
1298-struct Ofono
1299-{
1300-static const std::string& name()
1301-{
1302- static const std::string s{"org.ofono"};
1303- return s;
1304-}
1305-struct Manager
1306-{
1307- static const std::string& name()
1308- {
1309- static const std::string s{"org.ofono.Manager"};
1310- return s;
1311- }
1312-
1313- struct GetModems
1314- {
1315- static const std::string& name()
1316- {
1317- static const std::string s{"GetModems"};
1318- return s;
1319- }
1320-
1321- typedef Manager Interface;
1322- typedef std::vector<
1323- core::dbus::types::Struct<
1324- core::dbus::types::ObjectPath
1325- >
1326- > ResultType;
1327-
1328- static std::chrono::milliseconds default_timeout()
1329- {
1330- return std::chrono::seconds{1};
1331- }
1332- };
1333-
1334- struct ModemAdded
1335- {
1336- static const std::string& name()
1337- {
1338- static const std::string s{"ModemAdded"};
1339- return s;
1340- }
1341-
1342- typedef Manager Interface;
1343- typedef std::tuple<core::dbus::types::ObjectPath, std::map<std::string, std::string>> ArgumentType;
1344- };
1345-
1346- struct ModemRemoved
1347- {
1348- static const std::string& name()
1349- {
1350- static const std::string s{"ModemRemoved"};
1351- return s;
1352- }
1353-
1354- typedef Manager Interface;
1355- typedef core::dbus::types::ObjectPath ArgumentType;
1356- };
1357-
1358- struct Modem
1359- {
1360- struct NetworkRegistration
1361- {
1362- static const std::string& name()
1363- {
1364- static const std::string s{"org.ofono.NetworkRegistration"};
1365- return s;
1366- }
1367-
1368- struct GetProperties
1369- {
1370- static const std::string& name()
1371- {
1372- static const std::string s{"GetProperties"};
1373- return s;
1374- }
1375-
1376- typedef NetworkRegistration Interface;
1377- typedef std::map<std::string, core::dbus::types::Variant<>> ValueType;
1378-
1379- static std::chrono::milliseconds default_timeout()
1380- {
1381- return std::chrono::seconds{1};
1382- }
1383- };
1384-
1385- struct Mode
1386- {
1387- static const char* unregistered() { return "unregistered"; }
1388- static const char* registered() { return "registered"; }
1389- static const char* searching() { return "searching"; }
1390- static const char* denied() { return "denied"; }
1391- static const char* unknown() { return "unknown"; }
1392- static const char* roaming() { return "roaming"; }
1393-
1394- static const std::string& name()
1395- {
1396- static const std::string s{"Mode"};
1397- return s;
1398- }
1399-
1400- typedef NetworkRegistration Interface;
1401- typedef std::string ValueType;
1402- static const bool readable = true;
1403- static const bool writable = false;
1404- };
1405-
1406- struct LocationAreaCode
1407- {
1408- static const std::string& name()
1409- {
1410- static const std::string s{"LocationAreaCode"};
1411- return s;
1412- }
1413-
1414- typedef NetworkRegistration Interface;
1415- typedef std::uint16_t ValueType;
1416- static const bool readable = true;
1417- static const bool writable = false;
1418- };
1419-
1420- struct CellId
1421- {
1422- static const std::string& name()
1423- {
1424- static const std::string s{"CellId"};
1425- return s;
1426- }
1427-
1428- typedef NetworkRegistration Interface;
1429- typedef std::uint32_t ValueType;
1430- static const bool readable = true;
1431- static const bool writable = false;
1432- };
1433-
1434- struct MobileCountryCode
1435- {
1436- static const std::string& name()
1437- {
1438- static const std::string s{"MobileCountryCode"};
1439- return s;
1440- }
1441-
1442- typedef NetworkRegistration Interface;
1443- typedef std::string ValueType;
1444- static const bool readable = true;
1445- static const bool writable = false;
1446- };
1447-
1448- struct MobileNetworkCode
1449- {
1450- static const std::string& name()
1451- {
1452- static const std::string s{"MobileNetworkCode"};
1453- return s;
1454- }
1455-
1456- typedef NetworkRegistration Interface;
1457- typedef std::string ValueType;
1458- static const bool readable = true;
1459- static const bool writable = false;
1460- };
1461-
1462- struct Technology
1463- {
1464- static const char* gsm() { return "gsm"; }
1465- static const char* edge() { return "edge"; }
1466- static const char* umts() { return "umts"; }
1467- static const char* hspa() { return "hspa"; }
1468- static const char* lte() { return "lte"; }
1469-
1470- static const std::string& name()
1471- {
1472- static const std::string s{"Technology"};
1473- return s;
1474- }
1475-
1476- typedef NetworkRegistration Interface;
1477- typedef std::string ValueType;
1478- static const bool readable = true;
1479- static const bool writable = false;
1480- };
1481-
1482- struct Strength
1483- {
1484- static const std::string& name()
1485- {
1486- static const std::string s{"Strength"};
1487- return s;
1488- }
1489-
1490- typedef NetworkRegistration Interface;
1491- typedef std::int8_t ValueType;
1492- static const bool readable = true;
1493- static const bool writable = false;
1494- };
1495-
1496- NetworkRegistration(const std::shared_ptr<core::dbus::Object>& object)
1497- : object(object),
1498- properties{}
1499- {
1500- auto result = object->invoke_method_synchronously<GetProperties, GetProperties::ValueType>();
1501- if (result.is_error())
1502- connectivity::throw_dbus_exception(result.error());
1503-
1504- properties = result.value();
1505- }
1506-
1507- template<typename Property>
1508- typename Property::ValueType get(
1509- const typename Property::ValueType& default_value = typename Property::ValueType{}) const
1510- {
1511- try
1512- {
1513- core::dbus::types::Any value = properties.at(Property::name()).get();
1514- typename Property::ValueType result; value.reader() >> result;
1515-
1516- return result;
1517- } catch(...)
1518- {
1519- }
1520-
1521- return default_value;
1522- }
1523-
1524- std::shared_ptr<core::dbus::Object> object;
1525- GetProperties::ValueType properties;
1526- };
1527-
1528- Modem(const std::shared_ptr<core::dbus::Service>& service,
1529- const std::shared_ptr<core::dbus::Object>& object)
1530- : service(service),
1531- object(object),
1532- network_registration{object}
1533- {
1534- }
1535-
1536- std::shared_ptr<core::dbus::Service> service;
1537- std::shared_ptr<core::dbus::Object> object;
1538- NetworkRegistration network_registration;
1539- };
1540-
1541- Manager(const core::dbus::Bus::Ptr& bus)
1542- : service(core::dbus::Service::use_service<org::Ofono>(bus)),
1543- object(service->object_for_path(core::dbus::types::ObjectPath("/"))),
1544- modem_added(object->get_signal<ModemAdded>()),
1545- modem_removed(object->get_signal<ModemRemoved>())
1546- {
1547- auto result = object->invoke_method_synchronously<GetModems, GetModems::ResultType>();
1548-
1549- if (result.is_error())
1550- connectivity::throw_dbus_exception(result.error());
1551-
1552- for (const auto& element : result.value())
1553- {
1554- modems.insert(
1555- std::make_pair(
1556- element.value,
1557- Modem
1558- {
1559- service,
1560- service->object_for_path(element.value)
1561- }));
1562- }
1563-
1564- modem_added->connect([this](const ModemAdded::ArgumentType& arg)
1565- {
1566- std::lock_guard<std::mutex> lg(guard);
1567- modems.insert(
1568- std::make_pair(
1569- std::get<0>(arg),
1570- Modem{
1571- service,
1572- service->object_for_path(std::get<0>(arg))
1573- }));
1574- });
1575-
1576- modem_removed->connect([this](const ModemRemoved::ArgumentType& arg)
1577- {
1578- std::lock_guard<std::mutex> lg(guard);
1579- modems.erase(arg);
1580- });
1581- }
1582-
1583- void for_each_modem(const std::function<void(const Modem&)>& functor) const
1584- {
1585- std::lock_guard<std::mutex> lg(guard);
1586- for (const auto& modem : modems)
1587- {
1588- functor(modem.second);
1589- }
1590- }
1591-
1592- std::shared_ptr<core::dbus::Service> service;
1593- std::shared_ptr<core::dbus::Object> object;
1594- std::shared_ptr<core::dbus::Signal<ModemAdded, ModemAdded::ArgumentType>> modem_added;
1595- std::shared_ptr<core::dbus::Signal<ModemRemoved, ModemRemoved::ArgumentType>> modem_removed;
1596- mutable std::mutex guard;
1597- std::map<core::dbus::types::ObjectPath, Modem> modems;
1598-};
1599-};
1600-}
1601-
1602-#endif // LOCATION_SERVICE_LOCATION_CONNECTIVITY_OFONO_H
1603
1604=== removed file 'dbus-cpp/services/urfkill.h'
1605--- dbus-cpp/services/urfkill.h 2014-05-30 13:18:36 +0000
1606+++ dbus-cpp/services/urfkill.h 1970-01-01 00:00:00 +0000
1607@@ -1,338 +0,0 @@
1608-/*
1609- * Copyright © 2014 Canonical Ltd.
1610- *
1611- * This program is free software: you can redistribute it and/or modify it
1612- * under the terms of the GNU Lesser General Public License version 3,
1613- * as published by the Free Software Foundation.
1614- *
1615- * This program is distributed in the hope that it will be useful,
1616- * but WITHOUT ANY WARRANTY; without even the implied warranty of
1617- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1618- * GNU Lesser General Public License for more details.
1619- *
1620- * You should have received a copy of the GNU Lesser General Public License
1621- * along with this program. If not, see <http://www.gnu.org/licenses/>.
1622- *
1623- * Authored by: Antti Kaijanmäki <antti.kaijanmaki@canonical.com>
1624- */
1625-#ifndef PLATFORM_MANAGER_NMOFONO_URFKILL_H
1626-#define PLATFORM_MANAGER_NMOFONO_URFKILL_H
1627-
1628-#include <core/dbus/bus.h>
1629-#include <core/dbus/object.h>
1630-#include <core/dbus/property.h>
1631-#include <core/dbus/service.h>
1632-#include <core/dbus/types/object_path.h>
1633-#include <core/dbus/types/any.h>
1634-#include <core/dbus/types/struct.h>
1635-#include <core/dbus/types/stl/map.h>
1636-#include <core/dbus/types/stl/string.h>
1637-#include <core/dbus/types/stl/tuple.h>
1638-#include <core/dbus/types/stl/vector.h>
1639-#include "util.h"
1640-
1641-namespace org
1642-{
1643-namespace freedesktop
1644-{
1645-namespace URfkill
1646-{
1647-
1648-struct Interface
1649-{
1650- struct Killswitch
1651- {
1652- static const std::string& name()
1653- {
1654- static const std::string s{"org.freedesktop.URfkill.Killswitch"};
1655- return s;
1656- }
1657-
1658- struct Property
1659- {
1660- struct State
1661- {
1662- static const std::string& name()
1663- {
1664- static const std::string s{"state"};
1665- return s;
1666- }
1667-
1668- typedef Killswitch Interface;
1669- typedef std::int32_t ValueType;
1670- static const bool readable = true;
1671- static const bool writable = false;
1672- };
1673- };
1674-
1675- enum class Type;
1676- Killswitch(const std::shared_ptr<core::dbus::Object>& object,
1677- Type type)
1678- : object(object),
1679- type(type),
1680- _state(object->get_property<Property::State>())
1681- {
1682- _state->changed().connect(std::bind(&Killswitch::_stateChanged, this, std::placeholders::_1));
1683- _stateChanged(_state->get());
1684- }
1685-
1686- enum class State
1687- {
1688- not_available = -1,
1689- unblocked = 0,
1690- soft_blocked = 1,
1691- hard_blocked = 2
1692- };
1693-
1694- enum class Type {
1695- bluetooth,
1696- fm,
1697- gps,
1698- nfc,
1699- uwb,
1700- wimax,
1701- wlan,
1702- wwan
1703- };
1704-
1705- static const std::string path(Type type)
1706- {
1707- switch(type) {
1708- case Type::bluetooth:
1709- return "/org/freedesktop/URfkill/BLUETOOTH";
1710- case Type::fm:
1711- return "/org/freedesktop/URfkill/FM";
1712- case Type::gps:
1713- return "/org/freedesktop/URfkill/GPS";
1714- case Type::nfc:
1715- return "/org/freedesktop/URfkill/NFC";
1716- case Type::uwb:
1717- return "/org/freedesktop/URfkill/UWB";
1718- case Type::wimax:
1719- return "/org/freedesktop/URfkill/WIMAX";
1720- case Type::wlan:
1721- return "/org/freedesktop/URfkill/WLAN";
1722- case Type::wwan:
1723- return "/org/freedesktop/URfkill/WWAN";
1724- }
1725-
1726- return "";
1727- }
1728-
1729- void _stateChanged(Property::State::ValueType val)
1730- {
1731- if (val == -1)
1732- state.set(State::not_available);
1733- else if (val == 0)
1734- state.set(State::unblocked);
1735- else if (val == 1)
1736- state.set(State::soft_blocked);
1737- else if (val == 2)
1738- state.set(State::hard_blocked);
1739- else
1740- throw std::runtime_error("got unknown Killswitch state from urfkill: " + std::to_string(val));
1741- }
1742-
1743- std::shared_ptr<core::dbus::Object> object;
1744- const Type type;
1745- std::shared_ptr<core::dbus::Property<Property::State>> _state;
1746- core::Property<State> state;
1747- };
1748-
1749- struct URfkill
1750- {
1751- static const std::string& name()
1752- {
1753- static const std::string s{"org.freedesktop.URfkill"};
1754- return s;
1755- }
1756-
1757- struct Method
1758- {
1759- struct Block
1760- {
1761- static const std::string& name()
1762- {
1763- static const std::string s{"Block"};
1764- return s;
1765- }
1766-
1767- typedef URfkill Interface;
1768- typedef bool ResultType;
1769-
1770- static std::chrono::milliseconds default_timeout()
1771- {
1772- return std::chrono::seconds{5};
1773- }
1774- };
1775-
1776- struct FlightMode
1777- {
1778- static const std::string& name()
1779- {
1780- static const std::string s{"FlightMode"};
1781- return s;
1782- }
1783-
1784- typedef URfkill Interface;
1785- typedef bool ResultType;
1786-
1787- static std::chrono::milliseconds default_timeout()
1788- {
1789- return std::chrono::seconds{5};
1790- }
1791- };
1792-
1793- struct IsFlightMode
1794- {
1795- static const std::string& name()
1796- {
1797- static const std::string s{"IsFlightMode"};
1798- return s;
1799- }
1800-
1801- typedef URfkill Interface;
1802- typedef bool ResultType;
1803-
1804- static std::chrono::milliseconds default_timeout()
1805- {
1806- return std::chrono::seconds{1};
1807- }
1808- };
1809- };
1810-
1811- struct Signal
1812- {
1813- struct FlightModeChanged
1814- {
1815- static const std::string& name()
1816- {
1817- static const std::string s{"FlightModeChanged"};
1818- return s;
1819- }
1820-
1821- typedef URfkill Interface;
1822- typedef bool ArgumentType;
1823- };
1824- };
1825-
1826- URfkill(std::shared_ptr<core::dbus::Service> &service,
1827- std::shared_ptr<core::dbus::Object> &object)
1828- : service{service},
1829- object{object},
1830- flightModeChanged{object->get_signal<Signal::FlightModeChanged>()}
1831- {
1832- switches[Killswitch::Type::bluetooth] = std::make_shared<Killswitch>(service->object_for_path(Killswitch::path(Killswitch::Type::bluetooth)), Killswitch::Type::bluetooth);
1833- switches[Killswitch::Type::fm] = std::make_shared<Killswitch>(service->object_for_path(Killswitch::path(Killswitch::Type::fm)), Killswitch::Type::fm);
1834- switches[Killswitch::Type::gps] = std::make_shared<Killswitch>(service->object_for_path(Killswitch::path(Killswitch::Type::gps)), Killswitch::Type::gps);
1835- switches[Killswitch::Type::nfc] = std::make_shared<Killswitch>(service->object_for_path(Killswitch::path(Killswitch::Type::nfc)), Killswitch::Type::nfc);
1836- switches[Killswitch::Type::uwb] = std::make_shared<Killswitch>(service->object_for_path(Killswitch::path(Killswitch::Type::uwb)), Killswitch::Type::uwb);
1837- switches[Killswitch::Type::wimax] = std::make_shared<Killswitch>(service->object_for_path(Killswitch::path(Killswitch::Type::wimax)), Killswitch::Type::wimax);
1838- switches[Killswitch::Type::wlan] = std::make_shared<Killswitch>(service->object_for_path(Killswitch::path(Killswitch::Type::wlan)), Killswitch::Type::wlan);
1839- switches[Killswitch::Type::wwan] = std::make_shared<Killswitch>(service->object_for_path(Killswitch::path(Killswitch::Type::wwan)), Killswitch::Type::wwan);
1840- }
1841-
1842- bool block(Killswitch::Type type, bool block)
1843- {
1844- std::uint32_t utype;
1845- switch (type) {
1846- case Killswitch::Type::bluetooth:
1847- utype = 2;
1848- break;
1849- case Killswitch::Type::fm:
1850- utype = 7;
1851- break;
1852- case Killswitch::Type::gps:
1853- utype = 6;
1854- break;
1855- case Killswitch::Type::nfc:
1856- utype = 8; /// @todo verify me
1857- break;
1858- case Killswitch::Type::uwb:
1859- utype = 3;
1860- break;
1861- case Killswitch::Type::wimax:
1862- utype = 4;
1863- break;
1864- case Killswitch::Type::wlan:
1865- utype = 1;
1866- break;
1867- case Killswitch::Type::wwan:
1868- utype = 5;
1869- break;
1870- }
1871- // we can't handle "all" (0) with this, but that's deprecated by FlightMode anyway
1872-
1873- auto result =
1874- object->invoke_method_synchronously<
1875- Method::Block, Method::Block::ResultType>
1876- (utype, block);
1877-
1878- if (result.is_error())
1879- throw std::runtime_error(result.error().print());
1880-
1881- return result.value();
1882- }
1883-
1884- bool flightMode(bool block)
1885- {
1886- auto result =
1887- object->invoke_method_synchronously<
1888- Method::FlightMode, Method::FlightMode::ResultType>
1889- (block);
1890-
1891- if (result.is_error())
1892- throw std::runtime_error(result.error().print());
1893-
1894- return result.value();
1895- }
1896-
1897- bool isFlightMode()
1898- {
1899- auto result =
1900- object->invoke_method_synchronously<
1901- Method::IsFlightMode, Method::IsFlightMode::ResultType>
1902- ();
1903-
1904- if (result.is_error())
1905- throw std::runtime_error(result.error().print());
1906-
1907- return result.value();
1908- }
1909-
1910- std::shared_ptr<core::dbus::Service> service;
1911- std::shared_ptr<core::dbus::Object> object;
1912- std::shared_ptr<core::dbus::Signal<Signal::FlightModeChanged, Signal::FlightModeChanged::ArgumentType>> flightModeChanged;
1913-
1914- std::map<Killswitch::Type, std::shared_ptr<Killswitch>> switches;
1915- };
1916-};
1917-
1918-struct Service
1919-{
1920- std::shared_ptr<Interface::URfkill> urfkill;
1921-
1922- Service(const core::dbus::Bus::Ptr& bus)
1923- {
1924- auto service = core::dbus::Service::use_service<Interface::URfkill>(bus);
1925- auto object = service->object_for_path(core::dbus::types::ObjectPath("/org/freedesktop/URfkill"));
1926- urfkill = std::make_shared<Interface::URfkill>(service, object);
1927- }
1928-
1929- struct Mock
1930- {
1931- std::shared_ptr<Interface::URfkill> urfkill;
1932-
1933- Mock(const core::dbus::Bus::Ptr& bus)
1934- {
1935- auto service = core::dbus::Service::add_service<Interface::URfkill>(bus);
1936- auto object = service->add_object_for_path(core::dbus::types::ObjectPath("/org/freedesktop/URfkill"));
1937- urfkill = std::make_shared<Interface::URfkill>(service, object);
1938- }
1939- };
1940-};
1941-}
1942-}
1943-}
1944-
1945-#endif // PLATFORM_MANAGER_NMOFONO_URFKILL_H
1946
1947=== removed file 'dbus-cpp/services/util.h'
1948--- dbus-cpp/services/util.h 2014-04-23 13:27:07 +0000
1949+++ dbus-cpp/services/util.h 1970-01-01 00:00:00 +0000
1950@@ -1,36 +0,0 @@
1951-/*
1952- * Copyright © 2013 Canonical Ltd.
1953- *
1954- * This program is free software: you can redistribute it and/or modify it
1955- * under the terms of the GNU Lesser General Public License version 3,
1956- * as published by the Free Software Foundation.
1957- *
1958- * This program is distributed in the hope that it will be useful,
1959- * but WITHOUT ANY WARRANTY; without even the implied warranty of
1960- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1961- * GNU Lesser General Public License for more details.
1962- *
1963- * You should have received a copy of the GNU Lesser General Public License
1964- * along with this program. If not, see <http://www.gnu.org/licenses/>.
1965- *
1966- * Authors:
1967- * Jussi Pakkanen <jussi.pakkanen@canonical.com>
1968- */
1969-
1970-#ifndef CONNECTIVITY_UTIL_H
1971-#define CONNECTIVITY_UTIL_H
1972-
1973-namespace core {
1974-namespace dbus {
1975-class Error;
1976-}
1977-}
1978-
1979-namespace connectivity {
1980-
1981-void throw_dbus_exception(const core::dbus::Error &e);
1982-
1983-}
1984-
1985-
1986-#endif
1987
1988=== added file 'debian/connectivity-doc.install'
1989--- debian/connectivity-doc.install 1970-01-01 00:00:00 +0000
1990+++ debian/connectivity-doc.install 2014-08-21 18:21:03 +0000
1991@@ -0,0 +1,1 @@
1992+usr/share/doc/connectivity-api/*
1993
1994=== modified file 'debian/control'
1995--- debian/control 2014-07-22 19:54:24 +0000
1996+++ debian/control 2014-08-21 18:21:03 +0000
1997@@ -3,7 +3,7 @@
1998 Section: libs
1999 Maintainer: Ubuntu Developers <ubuntu-devel-discuss@lists.ubuntu.com>
2000 Build-Depends: cmake,
2001- dbus,
2002+ dbus-test-runner,
2003 debhelper (>= 9),
2004 doxygen,
2005 google-mock,
2006@@ -13,44 +13,63 @@
2007 # version.
2008 g++-4.9,
2009 lcov,
2010- libdbus-1-dev,
2011- libdbus-cpp-dev (>= 4.0.0),
2012 libgtest-dev,
2013- libprocess-cpp-dev,
2014- libproperties-cpp-dev,
2015- network-manager-dev,
2016 pkg-config,
2017+ qt5-default,
2018+ qtbase5-dev,
2019+ qtbase5-dev-tools,
2020+ qtdeclarative5-dev,
2021+ qtdeclarative5-dev-tools,
2022+ qml-module-qtquick2,
2023+ qml-module-qttest,
2024 Standards-Version: 3.9.5
2025 Homepage: https://launchpad.net/connectivity-api
2026 Vcs-Bzr: lp:connectivity-api
2027 Vcs-Browser: https://bazaar.launchpad.net/~unity-api-team/connectivity-api/trunk.14.04/files
2028
2029-Package: libconnectivity-cpp0
2030+Package: libconnectivity-qt1
2031 Architecture: any
2032+Pre-Depends: ${misc:Pre-Depends}
2033 Multi-Arch: same
2034-Pre-Depends: ${misc:Pre-Depends}
2035-Depends: ${shlibs:Depends},
2036- ${misc:Depends},
2037- network-manager,
2038-# urfkill,
2039-Description: C++11 library providing connectivity API.
2040- Connectivity API provides information on system networking.
2041+Depends: ${misc:Depends},
2042+ ${shlibs:Depends},
2043+ indicator-network (>= 0.5.1+14.10.20140819),
2044+Description: Ubuntu Connectivity Qt API
2045+ Ubuntu Connectivity API - Qt bindings
2046
2047-Package: libconnectivity-cpp-dev
2048+Package: libconnectivity-qt1-dev
2049 Section: libdevel
2050 Architecture: any
2051-Multi-Arch: same
2052-Depends: ${misc:Depends},
2053- libconnectivity-cpp0 (= ${binary:Version}),
2054- libdbus-cpp-dev,
2055- libproperties-cpp-dev,
2056-Suggests: libconnectivity-cpp-doc
2057-Description: C++11 library providing connectivity API. - dev headers
2058- All the development headers and libraries for libconnectivity-cpp.
2059-
2060-Package: libconnectivity-cpp-doc
2061+Pre-Depends: ${misc:Pre-Depends}
2062+Multi-Arch: same
2063+Depends: ${misc:Depends},
2064+ ${shlibs:Depends},
2065+ libconnectivity-qt1 (= ${binary:Version}),
2066+ qtbase5-dev
2067+Suggests: connectivity-doc,
2068+Description: Ubuntu Connectivity Qt API - development files
2069+ Ubuntu Connectivity API - Qt bindings
2070+ .
2071+ This package contains development files to develop against the Qt library.
2072+
2073+Package: qml-module-ubuntu-connectivity
2074+Architecture: any
2075+Pre-Depends: ${misc:Pre-Depends}
2076+Multi-Arch: same
2077+Depends: ${misc:Depends},
2078+ ${shlibs:Depends},
2079+ libconnectivity-qt1 (= ${binary:Version}),
2080+Description: Ubuntu Connectivity API QML Components
2081+ Ubuntu Connectivity API - QML bindings
2082+ .
2083+ This package contains the qtdeclarative bindings for Ubuntu connectivity API.
2084+
2085+Package: connectivity-doc
2086 Section: doc
2087 Architecture: all
2088 Depends: ${misc:Depends},
2089-Description: Documentation files for libconnectivity-cpp-dev
2090- Documentation files for the libconnectivity-cpp development.
2091+ ${shlibs:Depends},
2092+Description: Unity Action API - documentation
2093+ Ubuntu Connectivity API
2094+ .
2095+ This package contains developer documentation.
2096
2097=== removed file 'debian/libconnectivity-cpp-dev.install'
2098--- debian/libconnectivity-cpp-dev.install 2014-01-23 22:09:36 +0000
2099+++ debian/libconnectivity-cpp-dev.install 1970-01-01 00:00:00 +0000
2100@@ -1,3 +0,0 @@
2101-usr/include/*
2102-usr/lib/*/*.so
2103-usr/lib/pkgconfig/*
2104\ No newline at end of file
2105
2106=== removed file 'debian/libconnectivity-cpp-doc.install'
2107--- debian/libconnectivity-cpp-doc.install 2014-01-23 22:09:36 +0000
2108+++ debian/libconnectivity-cpp-doc.install 1970-01-01 00:00:00 +0000
2109@@ -1,1 +0,0 @@
2110-usr/share/doc/connectivity-cpp/
2111\ No newline at end of file
2112
2113=== removed file 'debian/libconnectivity-cpp0.install'
2114--- debian/libconnectivity-cpp0.install 2014-03-11 21:08:34 +0000
2115+++ debian/libconnectivity-cpp0.install 1970-01-01 00:00:00 +0000
2116@@ -1,1 +0,0 @@
2117-usr/lib/*/*.so.*
2118
2119=== added file 'debian/libconnectivity-qt1-dev.install'
2120--- debian/libconnectivity-qt1-dev.install 1970-01-01 00:00:00 +0000
2121+++ debian/libconnectivity-qt1-dev.install 2014-08-21 18:21:03 +0000
2122@@ -0,0 +1,3 @@
2123+usr/lib/*/libconnectivity-qt1.so
2124+usr/include/*
2125+usr/lib/*/pkgconfig/*
2126
2127=== added file 'debian/libconnectivity-qt1.install'
2128--- debian/libconnectivity-qt1.install 1970-01-01 00:00:00 +0000
2129+++ debian/libconnectivity-qt1.install 2014-08-21 18:21:03 +0000
2130@@ -0,0 +1,1 @@
2131+usr/lib/*/libconnectivity-qt1.so.*
2132
2133=== added file 'debian/qml-module-ubuntu-connectivity.install'
2134--- debian/qml-module-ubuntu-connectivity.install 1970-01-01 00:00:00 +0000
2135+++ debian/qml-module-ubuntu-connectivity.install 2014-08-21 18:21:03 +0000
2136@@ -0,0 +1,1 @@
2137+usr/lib/*/qt5/qml
2138
2139=== added directory 'doc'
2140=== removed directory 'doc'
2141=== added file 'doc/CMakeLists.txt'
2142--- doc/CMakeLists.txt 1970-01-01 00:00:00 +0000
2143+++ doc/CMakeLists.txt 2014-08-21 18:21:03 +0000
2144@@ -0,0 +1,27 @@
2145+set(INSTALL_DOCDIR ${CMAKE_INSTALL_DATAROOTDIR}/doc/connectivity-api)
2146+
2147+if(build_type_lower MATCHES debug)
2148+ option(BUILD_DOC "Build documentation by default" FALSE)
2149+else()
2150+ option(BUILD_DOC "Build documentation by default" TRUE)
2151+endif()
2152+option(PRIVATE_DOCS "Build private documentation" FALSE)
2153+
2154+if(${BUILD_DOC})
2155+ set(IS_ALL ALL)
2156+endif()
2157+
2158+add_subdirectory(qt)
2159+set(DBUS_FILES
2160+ dbus/connectivity-api.txt
2161+)
2162+
2163+add_custom_target(doc ${IS_ALL}
2164+ SOURCES ${DBUS_FILES}
2165+)
2166+add_dependencies(doc cppdoc qmldoc)
2167+
2168+install(
2169+ DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/dbus/
2170+ DESTINATION ${INSTALL_DOCDIR}/dbus/
2171+)
2172
2173=== removed file 'doc/CMakeLists.txt'
2174--- doc/CMakeLists.txt 2014-03-13 15:33:18 +0000
2175+++ doc/CMakeLists.txt 1970-01-01 00:00:00 +0000
2176@@ -1,65 +0,0 @@
2177-# Copyright © 2013 Canonical Ltd.
2178-#
2179-# This program is free software: you can redistribute it and/or modify it
2180-# under the terms of the GNU Lesser General Public License version 3,
2181-# as published by the Free Software Foundation.
2182-#
2183-# This program is distributed in the hope that it will be useful,
2184-# but WITHOUT ANY WARRANTY; without even the implied warranty of
2185-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2186-# GNU Lesser General Public License for more details.
2187-#
2188-# You should have received a copy of the GNU Lesser General Public License
2189-# along with this program. If not, see <http://www.gnu.org/licenses/>.
2190-#
2191-# Authors:
2192-# Antti Kaijanmäki <antti.kaijanmaki@canonical.com>
2193-
2194-string(TOLOWER "${CMAKE_BUILD_TYPE}" typelower)
2195-set(EXTRACT_PRIVATE NO)
2196-set(INTERNAL_DOCS NO)
2197-set(SOURCE_DIRS "${CMAKE_SOURCE_DIR}/include ${CMAKE_CURRENT_SOURCE_DIR}")
2198-
2199-if("${typelower}" STREQUAL "debug")
2200- option(BUILD_DOC "Build documentation by default" FALSE)
2201-else()
2202- option(BUILD_DOC "Build documentation by default" TRUE)
2203-endif()
2204-
2205-option(PRIVATE_DOCS "Build private documentation" FALSE)
2206-
2207-find_package(Doxygen)
2208-
2209-if(${BUILD_DOC})
2210- set(IS_ALL ALL)
2211-endif()
2212-if(${PRIVATE_DOCS})
2213- set(EXTRACT_PRIVATE YES)
2214- set(INTERNAL_DOCS YES)
2215- set(SOURCE_DIRS "${SOURCE_DIRS} ${CMAKE_SOURCE_DIR}/src ${CMAKE_SOURCE_DIR}/dbus")
2216-endif()
2217-
2218-if (DOXYGEN_FOUND)
2219- configure_file(
2220- ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
2221- ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
2222- add_custom_target(doc ${IS_ALL}
2223- ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
2224- WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
2225- COMMENT "Generating API documentation with Doxygen" VERBATIM)
2226- install(
2227- DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
2228- DESTINATION ${CMAKE_INSTALL_DOCDIR})
2229- install(
2230- DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/xml
2231- DESTINATION ${CMAKE_INSTALL_DOCDIR})
2232-
2233-endif (DOXYGEN_FOUND)
2234-
2235-# list these here to have them visible in Qt Creator
2236-set(DOC_PAGES
2237- pages/mainpage.dox
2238- pages/using.dox
2239- pages/networking-status.dox
2240-)
2241-add_custom_target(QtCreatorDocsHack SOURCES ${DOC_PAGES})
2242
2243=== removed file 'doc/Doxyfile.in'
2244--- doc/Doxyfile.in 2014-03-13 15:33:18 +0000
2245+++ doc/Doxyfile.in 1970-01-01 00:00:00 +0000
2246@@ -1,1869 +0,0 @@
2247-# Doxyfile 1.8.3.1
2248-
2249-# This file describes the settings to be used by the documentation system
2250-# doxygen (www.doxygen.org) for a project.
2251-#
2252-# All text after a hash (#) is considered a comment and will be ignored.
2253-# The format is:
2254-# TAG = value [value, ...]
2255-# For lists items can also be appended using:
2256-# TAG += value [value, ...]
2257-# Values that contain spaces should be placed between quotes (" ").
2258-
2259-#---------------------------------------------------------------------------
2260-# Project related configuration options
2261-#---------------------------------------------------------------------------
2262-
2263-# This tag specifies the encoding used for all characters in the config file
2264-# that follow. The default is UTF-8 which is also the encoding used for all
2265-# text before the first occurrence of this tag. Doxygen uses libiconv (or the
2266-# iconv built into libc) for the transcoding. See
2267-# http://www.gnu.org/software/libiconv for the list of possible encodings.
2268-
2269-DOXYFILE_ENCODING = UTF-8
2270-
2271-# The PROJECT_NAME tag is a single word (or sequence of words) that should
2272-# identify the project. Note that if you do not use Doxywizard you need
2273-# to put quotes around the project name if it contains spaces.
2274-
2275-PROJECT_NAME = @CMAKE_PROJECT_NAME@
2276-
2277-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
2278-# This could be handy for archiving the generated documentation or
2279-# if some version control system is used.
2280-
2281-PROJECT_NUMBER = @CONNECTIVITY_CPP_VERSION_MAJOR@.@CONNECTIVITY_CPP_VERSION_MINOR@.@CONNECTIVITY_CPP_VERSION_PATCH@
2282-
2283-# Using the PROJECT_BRIEF tag one can provide an optional one line description
2284-# for a project that appears at the top of each page and should give viewer
2285-# a quick idea about the purpose of the project. Keep the description short.
2286-
2287-PROJECT_BRIEF =
2288-
2289-# With the PROJECT_LOGO tag one can specify an logo or icon that is
2290-# included in the documentation. The maximum height of the logo should not
2291-# exceed 55 pixels and the maximum width should not exceed 200 pixels.
2292-# Doxygen will copy the logo to the output directory.
2293-
2294-PROJECT_LOGO =
2295-
2296-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
2297-# base path where the generated documentation will be put.
2298-# If a relative path is entered, it will be relative to the location
2299-# where doxygen was started. If left blank the current directory will be used.
2300-
2301-OUTPUT_DIRECTORY =
2302-
2303-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
2304-# 4096 sub-directories (in 2 levels) under the output directory of each output
2305-# format and will distribute the generated files over these directories.
2306-# Enabling this option can be useful when feeding doxygen a huge amount of
2307-# source files, where putting all generated files in the same directory would
2308-# otherwise cause performance problems for the file system.
2309-
2310-CREATE_SUBDIRS = NO
2311-
2312-# The OUTPUT_LANGUAGE tag is used to specify the language in which all
2313-# documentation generated by doxygen is written. Doxygen will use this
2314-# information to generate all constant output in the proper language.
2315-# The default language is English, other supported languages are:
2316-# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
2317-# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
2318-# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
2319-# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
2320-# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
2321-# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
2322-
2323-OUTPUT_LANGUAGE = English
2324-
2325-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
2326-# include brief member descriptions after the members that are listed in
2327-# the file and class documentation (similar to JavaDoc).
2328-# Set to NO to disable this.
2329-
2330-BRIEF_MEMBER_DESC = YES
2331-
2332-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
2333-# the brief description of a member or function before the detailed description.
2334-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
2335-# brief descriptions will be completely suppressed.
2336-
2337-REPEAT_BRIEF = YES
2338-
2339-# This tag implements a quasi-intelligent brief description abbreviator
2340-# that is used to form the text in various listings. Each string
2341-# in this list, if found as the leading text of the brief description, will be
2342-# stripped from the text and the result after processing the whole list, is
2343-# used as the annotated text. Otherwise, the brief description is used as-is.
2344-# If left blank, the following values are used ("$name" is automatically
2345-# replaced with the name of the entity): "The $name class" "The $name widget"
2346-# "The $name file" "is" "provides" "specifies" "contains"
2347-# "represents" "a" "an" "the"
2348-
2349-ABBREVIATE_BRIEF =
2350-
2351-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
2352-# Doxygen will generate a detailed section even if there is only a brief
2353-# description.
2354-
2355-ALWAYS_DETAILED_SEC = NO
2356-
2357-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
2358-# inherited members of a class in the documentation of that class as if those
2359-# members were ordinary class members. Constructors, destructors and assignment
2360-# operators of the base classes will not be shown.
2361-
2362-INLINE_INHERITED_MEMB = NO
2363-
2364-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
2365-# path before files name in the file list and in the header files. If set
2366-# to NO the shortest path that makes the file name unique will be used.
2367-
2368-FULL_PATH_NAMES = No
2369-
2370-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
2371-# can be used to strip a user-defined part of the path. Stripping is
2372-# only done if one of the specified strings matches the left-hand part of
2373-# the path. The tag can be used to show relative paths in the file list.
2374-# If left blank the directory from which doxygen is run is used as the
2375-# path to strip. Note that you specify absolute paths here, but also
2376-# relative paths, which will be relative from the directory where doxygen is
2377-# started.
2378-
2379-STRIP_FROM_PATH =
2380-
2381-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
2382-# the path mentioned in the documentation of a class, which tells
2383-# the reader which header file to include in order to use a class.
2384-# If left blank only the name of the header file containing the class
2385-# definition is used. Otherwise one should specify the include paths that
2386-# are normally passed to the compiler using the -I flag.
2387-
2388-STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include
2389-
2390-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
2391-# (but less readable) file names. This can be useful if your file system
2392-# doesn't support long names like on DOS, Mac, or CD-ROM.
2393-
2394-SHORT_NAMES = NO
2395-
2396-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
2397-# will interpret the first line (until the first dot) of a JavaDoc-style
2398-# comment as the brief description. If set to NO, the JavaDoc
2399-# comments will behave just like regular Qt-style comments
2400-# (thus requiring an explicit @brief command for a brief description.)
2401-
2402-JAVADOC_AUTOBRIEF = NO
2403-
2404-# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
2405-# interpret the first line (until the first dot) of a Qt-style
2406-# comment as the brief description. If set to NO, the comments
2407-# will behave just like regular Qt-style comments (thus requiring
2408-# an explicit \brief command for a brief description.)
2409-
2410-QT_AUTOBRIEF = NO
2411-
2412-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
2413-# treat a multi-line C++ special comment block (i.e. a block of //! or ///
2414-# comments) as a brief description. This used to be the default behaviour.
2415-# The new default is to treat a multi-line C++ comment block as a detailed
2416-# description. Set this tag to YES if you prefer the old behaviour instead.
2417-
2418-MULTILINE_CPP_IS_BRIEF = NO
2419-
2420-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
2421-# member inherits the documentation from any documented member that it
2422-# re-implements.
2423-
2424-INHERIT_DOCS = YES
2425-
2426-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
2427-# a new page for each member. If set to NO, the documentation of a member will
2428-# be part of the file/class/namespace that contains it.
2429-
2430-SEPARATE_MEMBER_PAGES = NO
2431-
2432-# The TAB_SIZE tag can be used to set the number of spaces in a tab.
2433-# Doxygen uses this value to replace tabs by spaces in code fragments.
2434-
2435-TAB_SIZE = 4
2436-
2437-# This tag can be used to specify a number of aliases that acts
2438-# as commands in the documentation. An alias has the form "name=value".
2439-# For example adding "sideeffect=\par Side Effects:\n" will allow you to
2440-# put the command \sideeffect (or @sideeffect) in the documentation, which
2441-# will result in a user-defined paragraph with heading "Side Effects:".
2442-# You can put \n's in the value part of an alias to insert newlines.
2443-
2444-ALIASES =
2445-
2446-# This tag can be used to specify a number of word-keyword mappings (TCL only).
2447-# A mapping has the form "name=value". For example adding
2448-# "class=itcl::class" will allow you to use the command class in the
2449-# itcl::class meaning.
2450-
2451-TCL_SUBST =
2452-
2453-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
2454-# sources only. Doxygen will then generate output that is more tailored for C.
2455-# For instance, some of the names that are used will be different. The list
2456-# of all members will be omitted, etc.
2457-
2458-OPTIMIZE_OUTPUT_FOR_C = NO
2459-
2460-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
2461-# sources only. Doxygen will then generate output that is more tailored for
2462-# Java. For instance, namespaces will be presented as packages, qualified
2463-# scopes will look different, etc.
2464-
2465-OPTIMIZE_OUTPUT_JAVA = NO
2466-
2467-# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
2468-# sources only. Doxygen will then generate output that is more tailored for
2469-# Fortran.
2470-
2471-OPTIMIZE_FOR_FORTRAN = NO
2472-
2473-# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
2474-# sources. Doxygen will then generate output that is tailored for
2475-# VHDL.
2476-
2477-OPTIMIZE_OUTPUT_VHDL = NO
2478-
2479-# Doxygen selects the parser to use depending on the extension of the files it
2480-# parses. With this tag you can assign which parser to use for a given
2481-# extension. Doxygen has a built-in mapping, but you can override or extend it
2482-# using this tag. The format is ext=language, where ext is a file extension,
2483-# and language is one of the parsers supported by doxygen: IDL, Java,
2484-# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
2485-# C++. For instance to make doxygen treat .inc files as Fortran files (default
2486-# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
2487-# that for custom extensions you also need to set FILE_PATTERNS otherwise the
2488-# files are not read by doxygen.
2489-
2490-EXTENSION_MAPPING =
2491-
2492-# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
2493-# comments according to the Markdown format, which allows for more readable
2494-# documentation. See http://daringfireball.net/projects/markdown/ for details.
2495-# The output of markdown processing is further processed by doxygen, so you
2496-# can mix doxygen, HTML, and XML commands with Markdown formatting.
2497-# Disable only in case of backward compatibilities issues.
2498-
2499-MARKDOWN_SUPPORT = YES
2500-
2501-# When enabled doxygen tries to link words that correspond to documented classes,
2502-# or namespaces to their corresponding documentation. Such a link can be
2503-# prevented in individual cases by by putting a % sign in front of the word or
2504-# globally by setting AUTOLINK_SUPPORT to NO.
2505-
2506-AUTOLINK_SUPPORT = YES
2507-
2508-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
2509-# to include (a tag file for) the STL sources as input, then you should
2510-# set this tag to YES in order to let doxygen match functions declarations and
2511-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
2512-# func(std::string) {}). This also makes the inheritance and collaboration
2513-# diagrams that involve STL classes more complete and accurate.
2514-
2515-BUILTIN_STL_SUPPORT = YES
2516-
2517-# If you use Microsoft's C++/CLI language, you should set this option to YES to
2518-# enable parsing support.
2519-
2520-CPP_CLI_SUPPORT = NO
2521-
2522-# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
2523-# Doxygen will parse them like normal C++ but will assume all classes use public
2524-# instead of private inheritance when no explicit protection keyword is present.
2525-
2526-SIP_SUPPORT = NO
2527-
2528-# For Microsoft's IDL there are propget and propput attributes to indicate
2529-# getter and setter methods for a property. Setting this option to YES (the
2530-# default) will make doxygen replace the get and set methods by a property in
2531-# the documentation. This will only work if the methods are indeed getting or
2532-# setting a simple type. If this is not the case, or you want to show the
2533-# methods anyway, you should set this option to NO.
2534-
2535-IDL_PROPERTY_SUPPORT = YES
2536-
2537-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
2538-# tag is set to YES, then doxygen will reuse the documentation of the first
2539-# member in the group (if any) for the other members of the group. By default
2540-# all members of a group must be documented explicitly.
2541-
2542-DISTRIBUTE_GROUP_DOC = NO
2543-
2544-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
2545-# the same type (for instance a group of public functions) to be put as a
2546-# subgroup of that type (e.g. under the Public Functions section). Set it to
2547-# NO to prevent subgrouping. Alternatively, this can be done per class using
2548-# the \nosubgrouping command.
2549-
2550-SUBGROUPING = YES
2551-
2552-# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
2553-# unions are shown inside the group in which they are included (e.g. using
2554-# @ingroup) instead of on a separate page (for HTML and Man pages) or
2555-# section (for LaTeX and RTF).
2556-
2557-INLINE_GROUPED_CLASSES = NO
2558-
2559-# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
2560-# unions with only public data fields will be shown inline in the documentation
2561-# of the scope in which they are defined (i.e. file, namespace, or group
2562-# documentation), provided this scope is documented. If set to NO (the default),
2563-# structs, classes, and unions are shown on a separate page (for HTML and Man
2564-# pages) or section (for LaTeX and RTF).
2565-
2566-INLINE_SIMPLE_STRUCTS = NO
2567-
2568-# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
2569-# is documented as struct, union, or enum with the name of the typedef. So
2570-# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
2571-# with name TypeT. When disabled the typedef will appear as a member of a file,
2572-# namespace, or class. And the struct will be named TypeS. This can typically
2573-# be useful for C code in case the coding convention dictates that all compound
2574-# types are typedef'ed and only the typedef is referenced, never the tag name.
2575-
2576-TYPEDEF_HIDES_STRUCT = NO
2577-
2578-# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
2579-# determine which symbols to keep in memory and which to flush to disk.
2580-# When the cache is full, less often used symbols will be written to disk.
2581-# For small to medium size projects (<1000 input files) the default value is
2582-# probably good enough. For larger projects a too small cache size can cause
2583-# doxygen to be busy swapping symbols to and from disk most of the time
2584-# causing a significant performance penalty.
2585-# If the system has enough physical memory increasing the cache will improve the
2586-# performance by keeping more symbols in memory. Note that the value works on
2587-# a logarithmic scale so increasing the size by one will roughly double the
2588-# memory usage. The cache size is given by this formula:
2589-# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
2590-# corresponding to a cache size of 2^16 = 65536 symbols.
2591-
2592-SYMBOL_CACHE_SIZE = 0
2593-
2594-# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
2595-# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
2596-# their name and scope. Since this can be an expensive process and often the
2597-# same symbol appear multiple times in the code, doxygen keeps a cache of
2598-# pre-resolved symbols. If the cache is too small doxygen will become slower.
2599-# If the cache is too large, memory is wasted. The cache size is given by this
2600-# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
2601-# corresponding to a cache size of 2^16 = 65536 symbols.
2602-
2603-LOOKUP_CACHE_SIZE = 0
2604-
2605-#---------------------------------------------------------------------------
2606-# Build related configuration options
2607-#---------------------------------------------------------------------------
2608-
2609-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
2610-# documentation are documented, even if no documentation was available.
2611-# Private class members and static file members will be hidden unless
2612-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
2613-
2614-EXTRACT_ALL = YES
2615-
2616-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
2617-# will be included in the documentation.
2618-
2619-EXTRACT_PRIVATE = @EXTRACT_PRIVATE@
2620-
2621-# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
2622-# scope will be included in the documentation.
2623-
2624-EXTRACT_PACKAGE = NO
2625-
2626-# If the EXTRACT_STATIC tag is set to YES all static members of a file
2627-# will be included in the documentation.
2628-
2629-EXTRACT_STATIC = YES
2630-
2631-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
2632-# defined locally in source files will be included in the documentation.
2633-# If set to NO only classes defined in header files are included.
2634-
2635-EXTRACT_LOCAL_CLASSES = YES
2636-
2637-# This flag is only useful for Objective-C code. When set to YES local
2638-# methods, which are defined in the implementation section but not in
2639-# the interface are included in the documentation.
2640-# If set to NO (the default) only methods in the interface are included.
2641-
2642-EXTRACT_LOCAL_METHODS = NO
2643-
2644-# If this flag is set to YES, the members of anonymous namespaces will be
2645-# extracted and appear in the documentation as a namespace called
2646-# 'anonymous_namespace{file}', where file will be replaced with the base
2647-# name of the file that contains the anonymous namespace. By default
2648-# anonymous namespaces are hidden.
2649-
2650-EXTRACT_ANON_NSPACES = NO
2651-
2652-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
2653-# undocumented members of documented classes, files or namespaces.
2654-# If set to NO (the default) these members will be included in the
2655-# various overviews, but no documentation section is generated.
2656-# This option has no effect if EXTRACT_ALL is enabled.
2657-
2658-HIDE_UNDOC_MEMBERS = NO
2659-
2660-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
2661-# undocumented classes that are normally visible in the class hierarchy.
2662-# If set to NO (the default) these classes will be included in the various
2663-# overviews. This option has no effect if EXTRACT_ALL is enabled.
2664-
2665-HIDE_UNDOC_CLASSES = NO
2666-
2667-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
2668-# friend (class|struct|union) declarations.
2669-# If set to NO (the default) these declarations will be included in the
2670-# documentation.
2671-
2672-HIDE_FRIEND_COMPOUNDS = YES
2673-
2674-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
2675-# documentation blocks found inside the body of a function.
2676-# If set to NO (the default) these blocks will be appended to the
2677-# function's detailed documentation block.
2678-
2679-HIDE_IN_BODY_DOCS = NO
2680-
2681-# The INTERNAL_DOCS tag determines if documentation
2682-# that is typed after a \internal command is included. If the tag is set
2683-# to NO (the default) then the documentation will be excluded.
2684-# Set it to YES to include the internal documentation.
2685-
2686-INTERNAL_DOCS = @INTERNAL_DOCS@
2687-
2688-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
2689-# file names in lower-case letters. If set to YES upper-case letters are also
2690-# allowed. This is useful if you have classes or files whose names only differ
2691-# in case and if your file system supports case sensitive file names. Windows
2692-# and Mac users are advised to set this option to NO.
2693-
2694-CASE_SENSE_NAMES = YES
2695-
2696-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
2697-# will show members with their full class and namespace scopes in the
2698-# documentation. If set to YES the scope will be hidden.
2699-
2700-HIDE_SCOPE_NAMES = NO
2701-
2702-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
2703-# will put a list of the files that are included by a file in the documentation
2704-# of that file.
2705-
2706-SHOW_INCLUDE_FILES = YES
2707-
2708-# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
2709-# will list include files with double quotes in the documentation
2710-# rather than with sharp brackets.
2711-
2712-FORCE_LOCAL_INCLUDES = NO
2713-
2714-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
2715-# is inserted in the documentation for inline members.
2716-
2717-INLINE_INFO = YES
2718-
2719-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
2720-# will sort the (detailed) documentation of file and class members
2721-# alphabetically by member name. If set to NO the members will appear in
2722-# declaration order.
2723-
2724-SORT_MEMBER_DOCS = YES
2725-
2726-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
2727-# brief documentation of file, namespace and class members alphabetically
2728-# by member name. If set to NO (the default) the members will appear in
2729-# declaration order.
2730-
2731-SORT_BRIEF_DOCS = NO
2732-
2733-# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
2734-# will sort the (brief and detailed) documentation of class members so that
2735-# constructors and destructors are listed first. If set to NO (the default)
2736-# the constructors will appear in the respective orders defined by
2737-# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
2738-# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
2739-# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
2740-
2741-SORT_MEMBERS_CTORS_1ST = NO
2742-
2743-# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
2744-# hierarchy of group names into alphabetical order. If set to NO (the default)
2745-# the group names will appear in their defined order.
2746-
2747-SORT_GROUP_NAMES = NO
2748-
2749-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
2750-# sorted by fully-qualified names, including namespaces. If set to
2751-# NO (the default), the class list will be sorted only by class name,
2752-# not including the namespace part.
2753-# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
2754-# Note: This option applies only to the class list, not to the
2755-# alphabetical list.
2756-
2757-SORT_BY_SCOPE_NAME = NO
2758-
2759-# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
2760-# do proper type resolution of all parameters of a function it will reject a
2761-# match between the prototype and the implementation of a member function even
2762-# if there is only one candidate or it is obvious which candidate to choose
2763-# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
2764-# will still accept a match between prototype and implementation in such cases.
2765-
2766-STRICT_PROTO_MATCHING = NO
2767-
2768-# The GENERATE_TODOLIST tag can be used to enable (YES) or
2769-# disable (NO) the todo list. This list is created by putting \todo
2770-# commands in the documentation.
2771-
2772-GENERATE_TODOLIST = YES
2773-
2774-# The GENERATE_TESTLIST tag can be used to enable (YES) or
2775-# disable (NO) the test list. This list is created by putting \test
2776-# commands in the documentation.
2777-
2778-GENERATE_TESTLIST = YES
2779-
2780-# The GENERATE_BUGLIST tag can be used to enable (YES) or
2781-# disable (NO) the bug list. This list is created by putting \bug
2782-# commands in the documentation.
2783-
2784-GENERATE_BUGLIST = YES
2785-
2786-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
2787-# disable (NO) the deprecated list. This list is created by putting
2788-# \deprecated commands in the documentation.
2789-
2790-GENERATE_DEPRECATEDLIST= YES
2791-
2792-# The ENABLED_SECTIONS tag can be used to enable conditional
2793-# documentation sections, marked by \if section-label ... \endif
2794-# and \cond section-label ... \endcond blocks.
2795-
2796-ENABLED_SECTIONS =
2797-
2798-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
2799-# the initial value of a variable or macro consists of for it to appear in
2800-# the documentation. If the initializer consists of more lines than specified
2801-# here it will be hidden. Use a value of 0 to hide initializers completely.
2802-# The appearance of the initializer of individual variables and macros in the
2803-# documentation can be controlled using \showinitializer or \hideinitializer
2804-# command in the documentation regardless of this setting.
2805-
2806-MAX_INITIALIZER_LINES = 30
2807-
2808-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
2809-# at the bottom of the documentation of classes and structs. If set to YES the
2810-# list will mention the files that were used to generate the documentation.
2811-
2812-SHOW_USED_FILES = YES
2813-
2814-# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
2815-# This will remove the Files entry from the Quick Index and from the
2816-# Folder Tree View (if specified). The default is YES.
2817-
2818-SHOW_FILES = YES
2819-
2820-# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
2821-# Namespaces page.
2822-# This will remove the Namespaces entry from the Quick Index
2823-# and from the Folder Tree View (if specified). The default is YES.
2824-
2825-SHOW_NAMESPACES = YES
2826-
2827-# The FILE_VERSION_FILTER tag can be used to specify a program or script that
2828-# doxygen should invoke to get the current version for each file (typically from
2829-# the version control system). Doxygen will invoke the program by executing (via
2830-# popen()) the command <command> <input-file>, where <command> is the value of
2831-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
2832-# provided by doxygen. Whatever the program writes to standard output
2833-# is used as the file version. See the manual for examples.
2834-
2835-FILE_VERSION_FILTER =
2836-
2837-# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
2838-# by doxygen. The layout file controls the global structure of the generated
2839-# output files in an output format independent way. To create the layout file
2840-# that represents doxygen's defaults, run doxygen with the -l option.
2841-# You can optionally specify a file name after the option, if omitted
2842-# DoxygenLayout.xml will be used as the name of the layout file.
2843-
2844-LAYOUT_FILE =
2845-
2846-# The CITE_BIB_FILES tag can be used to specify one or more bib files
2847-# containing the references data. This must be a list of .bib files. The
2848-# .bib extension is automatically appended if omitted. Using this command
2849-# requires the bibtex tool to be installed. See also
2850-# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
2851-# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
2852-# feature you need bibtex and perl available in the search path. Do not use
2853-# file names with spaces, bibtex cannot handle them.
2854-
2855-CITE_BIB_FILES =
2856-
2857-#---------------------------------------------------------------------------
2858-# configuration options related to warning and progress messages
2859-#---------------------------------------------------------------------------
2860-
2861-# The QUIET tag can be used to turn on/off the messages that are generated
2862-# by doxygen. Possible values are YES and NO. If left blank NO is used.
2863-
2864-QUIET = NO
2865-
2866-# The WARNINGS tag can be used to turn on/off the warning messages that are
2867-# generated by doxygen. Possible values are YES and NO. If left blank
2868-# NO is used.
2869-
2870-WARNINGS = YES
2871-
2872-# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
2873-# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
2874-# automatically be disabled.
2875-
2876-WARN_IF_UNDOCUMENTED = YES
2877-
2878-# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
2879-# potential errors in the documentation, such as not documenting some
2880-# parameters in a documented function, or documenting parameters that
2881-# don't exist or using markup commands wrongly.
2882-
2883-WARN_IF_DOC_ERROR = YES
2884-
2885-# The WARN_NO_PARAMDOC option can be enabled to get warnings for
2886-# functions that are documented, but have no documentation for their parameters
2887-# or return value. If set to NO (the default) doxygen will only warn about
2888-# wrong or incomplete parameter documentation, but not about the absence of
2889-# documentation.
2890-
2891-WARN_NO_PARAMDOC = YES
2892-
2893-# The WARN_FORMAT tag determines the format of the warning messages that
2894-# doxygen can produce. The string should contain the $file, $line, and $text
2895-# tags, which will be replaced by the file and line number from which the
2896-# warning originated and the warning text. Optionally the format may contain
2897-# $version, which will be replaced by the version of the file (if it could
2898-# be obtained via FILE_VERSION_FILTER)
2899-
2900-WARN_FORMAT = "$file:$line: $text"
2901-
2902-# The WARN_LOGFILE tag can be used to specify a file to which warning
2903-# and error messages should be written. If left blank the output is written
2904-# to stderr.
2905-
2906-WARN_LOGFILE =
2907-
2908-#---------------------------------------------------------------------------
2909-# configuration options related to the input files
2910-#---------------------------------------------------------------------------
2911-
2912-# The INPUT tag can be used to specify the files and/or directories that contain
2913-# documented source files. You may enter file names like "myfile.cpp" or
2914-# directories like "/usr/src/myproject". Separate the files or directories
2915-# with spaces.
2916-
2917-INPUT = ${SOURCE_DIRS}
2918-
2919-# This tag can be used to specify the character encoding of the source files
2920-# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
2921-# also the default input encoding. Doxygen uses libiconv (or the iconv built
2922-# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
2923-# the list of possible encodings.
2924-
2925-INPUT_ENCODING = UTF-8
2926-
2927-# If the value of the INPUT tag contains directories, you can use the
2928-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
2929-# and *.h) to filter out the source-files in the directories. If left
2930-# blank the following patterns are tested:
2931-# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
2932-# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
2933-# *.f90 *.f *.for *.vhd *.vhdl
2934-
2935-FILE_PATTERNS =
2936-
2937-# The RECURSIVE tag can be used to turn specify whether or not subdirectories
2938-# should be searched for input files as well. Possible values are YES and NO.
2939-# If left blank NO is used.
2940-
2941-RECURSIVE = YES
2942-
2943-# The EXCLUDE tag can be used to specify files and/or directories that should be
2944-# excluded from the INPUT source files. This way you can easily exclude a
2945-# subdirectory from a directory tree whose root is specified with the INPUT tag.
2946-# Note that relative paths are relative to the directory from which doxygen is
2947-# run.
2948-
2949-EXCLUDE =
2950-
2951-# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
2952-# directories that are symbolic links (a Unix file system feature) are excluded
2953-# from the input.
2954-
2955-EXCLUDE_SYMLINKS = NO
2956-
2957-# If the value of the INPUT tag contains directories, you can use the
2958-# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
2959-# certain files from those directories. Note that the wildcards are matched
2960-# against the file with absolute path, so to exclude all test directories
2961-# for example use the pattern */test/*
2962-
2963-EXCLUDE_PATTERNS =
2964-
2965-# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
2966-# (namespaces, classes, functions, etc.) that should be excluded from the
2967-# output. The symbol name can be a fully qualified name, a word, or if the
2968-# wildcard * is used, a substring. Examples: ANamespace, AClass,
2969-# AClass::ANamespace, ANamespace::*Test
2970-
2971-EXCLUDE_SYMBOLS =
2972-
2973-# The EXAMPLE_PATH tag can be used to specify one or more files or
2974-# directories that contain example code fragments that are included (see
2975-# the \include command).
2976-
2977-EXAMPLE_PATH = @CMAKE_SOURCE_DIR@/examples
2978-
2979-# If the value of the EXAMPLE_PATH tag contains directories, you can use the
2980-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
2981-# and *.h) to filter out the source-files in the directories. If left
2982-# blank all files are included.
2983-
2984-EXAMPLE_PATTERNS =
2985-
2986-# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
2987-# searched for input files to be used with the \include or \dontinclude
2988-# commands irrespective of the value of the RECURSIVE tag.
2989-# Possible values are YES and NO. If left blank NO is used.
2990-
2991-EXAMPLE_RECURSIVE = YES
2992-
2993-# The IMAGE_PATH tag can be used to specify one or more files or
2994-# directories that contain image that are included in the documentation (see
2995-# the \image command).
2996-
2997-IMAGE_PATH =
2998-
2999-# The INPUT_FILTER tag can be used to specify a program that doxygen should
3000-# invoke to filter for each input file. Doxygen will invoke the filter program
3001-# by executing (via popen()) the command <filter> <input-file>, where <filter>
3002-# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
3003-# input file. Doxygen will then use the output that the filter program writes
3004-# to standard output.
3005-# If FILTER_PATTERNS is specified, this tag will be
3006-# ignored.
3007-
3008-INPUT_FILTER =
3009-
3010-# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
3011-# basis.
3012-# Doxygen will compare the file name with each pattern and apply the
3013-# filter if there is a match.
3014-# The filters are a list of the form:
3015-# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
3016-# info on how filters are used. If FILTER_PATTERNS is empty or if
3017-# non of the patterns match the file name, INPUT_FILTER is applied.
3018-
3019-FILTER_PATTERNS =
3020-
3021-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
3022-# INPUT_FILTER) will be used to filter the input files when producing source
3023-# files to browse (i.e. when SOURCE_BROWSER is set to YES).
3024-
3025-FILTER_SOURCE_FILES = NO
3026-
3027-# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
3028-# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
3029-# and it is also possible to disable source filtering for a specific pattern
3030-# using *.ext= (so without naming a filter). This option only has effect when
3031-# FILTER_SOURCE_FILES is enabled.
3032-
3033-FILTER_SOURCE_PATTERNS =
3034-
3035-# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
3036-# is part of the input, its contents will be placed on the main page (index.html).
3037-# This can be useful if you have a project on for instance GitHub and want reuse
3038-# the introduction page also for the doxygen output.
3039-
3040-USE_MDFILE_AS_MAINPAGE =
3041-
3042-#---------------------------------------------------------------------------
3043-# configuration options related to source browsing
3044-#---------------------------------------------------------------------------
3045-
3046-# If the SOURCE_BROWSER tag is set to YES then a list of source files will
3047-# be generated. Documented entities will be cross-referenced with these sources.
3048-# Note: To get rid of all source code in the generated output, make sure also
3049-# VERBATIM_HEADERS is set to NO.
3050-
3051-SOURCE_BROWSER = YES
3052-
3053-# Setting the INLINE_SOURCES tag to YES will include the body
3054-# of functions and classes directly in the documentation.
3055-
3056-INLINE_SOURCES = NO
3057-
3058-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
3059-# doxygen to hide any special comment blocks from generated source code
3060-# fragments. Normal C, C++ and Fortran comments will always remain visible.
3061-
3062-STRIP_CODE_COMMENTS = YES
3063-
3064-# If the REFERENCED_BY_RELATION tag is set to YES
3065-# then for each documented function all documented
3066-# functions referencing it will be listed.
3067-
3068-REFERENCED_BY_RELATION = YES
3069-
3070-# If the REFERENCES_RELATION tag is set to YES
3071-# then for each documented function all documented entities
3072-# called/used by that function will be listed.
3073-
3074-REFERENCES_RELATION = YES
3075-
3076-# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
3077-# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
3078-# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
3079-# link to the source code.
3080-# Otherwise they will link to the documentation.
3081-
3082-REFERENCES_LINK_SOURCE = YES
3083-
3084-# If the USE_HTAGS tag is set to YES then the references to source code
3085-# will point to the HTML generated by the htags(1) tool instead of doxygen
3086-# built-in source browser. The htags tool is part of GNU's global source
3087-# tagging system (see http://www.gnu.org/software/global/global.html). You
3088-# will need version 4.8.6 or higher.
3089-
3090-USE_HTAGS = NO
3091-
3092-# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
3093-# will generate a verbatim copy of the header file for each class for
3094-# which an include is specified. Set to NO to disable this.
3095-
3096-VERBATIM_HEADERS = YES
3097-
3098-#---------------------------------------------------------------------------
3099-# configuration options related to the alphabetical class index
3100-#---------------------------------------------------------------------------
3101-
3102-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
3103-# of all compounds will be generated. Enable this if the project
3104-# contains a lot of classes, structs, unions or interfaces.
3105-
3106-ALPHABETICAL_INDEX = YES
3107-
3108-# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
3109-# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
3110-# in which this list will be split (can be a number in the range [1..20])
3111-
3112-COLS_IN_ALPHA_INDEX = 5
3113-
3114-# In case all classes in a project start with a common prefix, all
3115-# classes will be put under the same header in the alphabetical index.
3116-# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
3117-# should be ignored while generating the index headers.
3118-
3119-IGNORE_PREFIX =
3120-
3121-#---------------------------------------------------------------------------
3122-# configuration options related to the HTML output
3123-#---------------------------------------------------------------------------
3124-
3125-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
3126-# generate HTML output.
3127-
3128-GENERATE_HTML = YES
3129-
3130-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
3131-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3132-# put in front of it. If left blank `html' will be used as the default path.
3133-
3134-HTML_OUTPUT = html
3135-
3136-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
3137-# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
3138-# doxygen will generate files with .html extension.
3139-
3140-HTML_FILE_EXTENSION = .html
3141-
3142-# The HTML_HEADER tag can be used to specify a personal HTML header for
3143-# each generated HTML page. If it is left blank doxygen will generate a
3144-# standard header. Note that when using a custom header you are responsible
3145-# for the proper inclusion of any scripts and style sheets that doxygen
3146-# needs, which is dependent on the configuration options used.
3147-# It is advised to generate a default header using "doxygen -w html
3148-# header.html footer.html stylesheet.css YourConfigFile" and then modify
3149-# that header. Note that the header is subject to change so you typically
3150-# have to redo this when upgrading to a newer version of doxygen or when
3151-# changing the value of configuration settings such as GENERATE_TREEVIEW!
3152-
3153-HTML_HEADER =
3154-
3155-# The HTML_FOOTER tag can be used to specify a personal HTML footer for
3156-# each generated HTML page. If it is left blank doxygen will generate a
3157-# standard footer.
3158-
3159-HTML_FOOTER =
3160-
3161-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
3162-# style sheet that is used by each HTML page. It can be used to
3163-# fine-tune the look of the HTML output. If left blank doxygen will
3164-# generate a default style sheet. Note that it is recommended to use
3165-# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
3166-# tag will in the future become obsolete.
3167-
3168-HTML_STYLESHEET =
3169-
3170-# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
3171-# user-defined cascading style sheet that is included after the standard
3172-# style sheets created by doxygen. Using this option one can overrule
3173-# certain style aspects. This is preferred over using HTML_STYLESHEET
3174-# since it does not replace the standard style sheet and is therefor more
3175-# robust against future updates. Doxygen will copy the style sheet file to
3176-# the output directory.
3177-
3178-HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/extra.css
3179-
3180-# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
3181-# other source files which should be copied to the HTML output directory. Note
3182-# that these files will be copied to the base HTML output directory. Use the
3183-# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
3184-# files. In the HTML_STYLESHEET file, use the file name only. Also note that
3185-# the files will be copied as-is; there are no commands or markers available.
3186-
3187-HTML_EXTRA_FILES =
3188-
3189-# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
3190-# Doxygen will adjust the colors in the style sheet and background images
3191-# according to this color. Hue is specified as an angle on a colorwheel,
3192-# see http://en.wikipedia.org/wiki/Hue for more information.
3193-# For instance the value 0 represents red, 60 is yellow, 120 is green,
3194-# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
3195-# The allowed range is 0 to 359.
3196-
3197-HTML_COLORSTYLE_HUE = 220
3198-
3199-# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
3200-# the colors in the HTML output. For a value of 0 the output will use
3201-# grayscales only. A value of 255 will produce the most vivid colors.
3202-
3203-HTML_COLORSTYLE_SAT = 100
3204-
3205-# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
3206-# the luminance component of the colors in the HTML output. Values below
3207-# 100 gradually make the output lighter, whereas values above 100 make
3208-# the output darker. The value divided by 100 is the actual gamma applied,
3209-# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
3210-# and 100 does not change the gamma.
3211-
3212-HTML_COLORSTYLE_GAMMA = 80
3213-
3214-# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
3215-# page will contain the date and time when the page was generated. Setting
3216-# this to NO can help when comparing the output of multiple runs.
3217-
3218-HTML_TIMESTAMP = YES
3219-
3220-# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
3221-# documentation will contain sections that can be hidden and shown after the
3222-# page has loaded.
3223-
3224-HTML_DYNAMIC_SECTIONS = YES
3225-
3226-# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
3227-# entries shown in the various tree structured indices initially; the user
3228-# can expand and collapse entries dynamically later on. Doxygen will expand
3229-# the tree to such a level that at most the specified number of entries are
3230-# visible (unless a fully collapsed tree already exceeds this amount).
3231-# So setting the number of entries 1 will produce a full collapsed tree by
3232-# default. 0 is a special value representing an infinite number of entries
3233-# and will result in a full expanded tree by default.
3234-
3235-HTML_INDEX_NUM_ENTRIES = 100
3236-
3237-# If the GENERATE_DOCSET tag is set to YES, additional index files
3238-# will be generated that can be used as input for Apple's Xcode 3
3239-# integrated development environment, introduced with OSX 10.5 (Leopard).
3240-# To create a documentation set, doxygen will generate a Makefile in the
3241-# HTML output directory. Running make will produce the docset in that
3242-# directory and running "make install" will install the docset in
3243-# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
3244-# it at startup.
3245-# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
3246-# for more information.
3247-
3248-GENERATE_DOCSET = NO
3249-
3250-# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
3251-# feed. A documentation feed provides an umbrella under which multiple
3252-# documentation sets from a single provider (such as a company or product suite)
3253-# can be grouped.
3254-
3255-DOCSET_FEEDNAME = "Doxygen generated docs"
3256-
3257-# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
3258-# should uniquely identify the documentation set bundle. This should be a
3259-# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
3260-# will append .docset to the name.
3261-
3262-DOCSET_BUNDLE_ID = org.doxygen.Project
3263-
3264-# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
3265-# identify the documentation publisher. This should be a reverse domain-name
3266-# style string, e.g. com.mycompany.MyDocSet.documentation.
3267-
3268-DOCSET_PUBLISHER_ID = org.doxygen.Publisher
3269-
3270-# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
3271-
3272-DOCSET_PUBLISHER_NAME = Publisher
3273-
3274-# If the GENERATE_HTMLHELP tag is set to YES, additional index files
3275-# will be generated that can be used as input for tools like the
3276-# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
3277-# of the generated HTML documentation.
3278-
3279-GENERATE_HTMLHELP = NO
3280-
3281-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
3282-# be used to specify the file name of the resulting .chm file. You
3283-# can add a path in front of the file if the result should not be
3284-# written to the html output directory.
3285-
3286-CHM_FILE =
3287-
3288-# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
3289-# be used to specify the location (absolute path including file name) of
3290-# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
3291-# the HTML help compiler on the generated index.hhp.
3292-
3293-HHC_LOCATION =
3294-
3295-# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
3296-# controls if a separate .chi index file is generated (YES) or that
3297-# it should be included in the master .chm file (NO).
3298-
3299-GENERATE_CHI = NO
3300-
3301-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
3302-# is used to encode HtmlHelp index (hhk), content (hhc) and project file
3303-# content.
3304-
3305-CHM_INDEX_ENCODING =
3306-
3307-# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
3308-# controls whether a binary table of contents is generated (YES) or a
3309-# normal table of contents (NO) in the .chm file.
3310-
3311-BINARY_TOC = NO
3312-
3313-# The TOC_EXPAND flag can be set to YES to add extra items for group members
3314-# to the contents of the HTML help documentation and to the tree view.
3315-
3316-TOC_EXPAND = NO
3317-
3318-# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
3319-# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
3320-# that can be used as input for Qt's qhelpgenerator to generate a
3321-# Qt Compressed Help (.qch) of the generated HTML documentation.
3322-
3323-GENERATE_QHP = NO
3324-
3325-# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
3326-# be used to specify the file name of the resulting .qch file.
3327-# The path specified is relative to the HTML output folder.
3328-
3329-QCH_FILE =
3330-
3331-# The QHP_NAMESPACE tag specifies the namespace to use when generating
3332-# Qt Help Project output. For more information please see
3333-# http://doc.trolltech.com/qthelpproject.html#namespace
3334-
3335-QHP_NAMESPACE = org.doxygen.Project
3336-
3337-# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
3338-# Qt Help Project output. For more information please see
3339-# http://doc.trolltech.com/qthelpproject.html#virtual-folders
3340-
3341-QHP_VIRTUAL_FOLDER = doc
3342-
3343-# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
3344-# add. For more information please see
3345-# http://doc.trolltech.com/qthelpproject.html#custom-filters
3346-
3347-QHP_CUST_FILTER_NAME =
3348-
3349-# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
3350-# custom filter to add. For more information please see
3351-# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
3352-# Qt Help Project / Custom Filters</a>.
3353-
3354-QHP_CUST_FILTER_ATTRS =
3355-
3356-# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
3357-# project's
3358-# filter section matches.
3359-# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
3360-# Qt Help Project / Filter Attributes</a>.
3361-
3362-QHP_SECT_FILTER_ATTRS =
3363-
3364-# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
3365-# be used to specify the location of Qt's qhelpgenerator.
3366-# If non-empty doxygen will try to run qhelpgenerator on the generated
3367-# .qhp file.
3368-
3369-QHG_LOCATION =
3370-
3371-# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
3372-# will be generated, which together with the HTML files, form an Eclipse help
3373-# plugin. To install this plugin and make it available under the help contents
3374-# menu in Eclipse, the contents of the directory containing the HTML and XML
3375-# files needs to be copied into the plugins directory of eclipse. The name of
3376-# the directory within the plugins directory should be the same as
3377-# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
3378-# the help appears.
3379-
3380-GENERATE_ECLIPSEHELP = NO
3381-
3382-# A unique identifier for the eclipse help plugin. When installing the plugin
3383-# the directory name containing the HTML and XML files should also have
3384-# this name.
3385-
3386-ECLIPSE_DOC_ID = org.doxygen.Project
3387-
3388-# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
3389-# at top of each HTML page. The value NO (the default) enables the index and
3390-# the value YES disables it. Since the tabs have the same information as the
3391-# navigation tree you can set this option to NO if you already set
3392-# GENERATE_TREEVIEW to YES.
3393-
3394-DISABLE_INDEX = YES
3395-
3396-# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
3397-# structure should be generated to display hierarchical information.
3398-# If the tag value is set to YES, a side panel will be generated
3399-# containing a tree-like index structure (just like the one that
3400-# is generated for HTML Help). For this to work a browser that supports
3401-# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
3402-# Windows users are probably better off using the HTML help feature.
3403-# Since the tree basically has the same information as the tab index you
3404-# could consider to set DISABLE_INDEX to NO when enabling this option.
3405-
3406-GENERATE_TREEVIEW = YES
3407-
3408-# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
3409-# (range [0,1..20]) that doxygen will group on one line in the generated HTML
3410-# documentation. Note that a value of 0 will completely suppress the enum
3411-# values from appearing in the overview section.
3412-
3413-ENUM_VALUES_PER_LINE = 1
3414-
3415-# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
3416-# used to set the initial width (in pixels) of the frame in which the tree
3417-# is shown.
3418-
3419-TREEVIEW_WIDTH = 250
3420-
3421-# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
3422-# links to external symbols imported via tag files in a separate window.
3423-
3424-EXT_LINKS_IN_WINDOW = NO
3425-
3426-# Use this tag to change the font size of Latex formulas included
3427-# as images in the HTML documentation. The default is 10. Note that
3428-# when you change the font size after a successful doxygen run you need
3429-# to manually remove any form_*.png images from the HTML output directory
3430-# to force them to be regenerated.
3431-
3432-FORMULA_FONTSIZE = 10
3433-
3434-# Use the FORMULA_TRANPARENT tag to determine whether or not the images
3435-# generated for formulas are transparent PNGs. Transparent PNGs are
3436-# not supported properly for IE 6.0, but are supported on all modern browsers.
3437-# Note that when changing this option you need to delete any form_*.png files
3438-# in the HTML output before the changes have effect.
3439-
3440-FORMULA_TRANSPARENT = YES
3441-
3442-# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
3443-# (see http://www.mathjax.org) which uses client side Javascript for the
3444-# rendering instead of using prerendered bitmaps. Use this if you do not
3445-# have LaTeX installed or if you want to formulas look prettier in the HTML
3446-# output. When enabled you may also need to install MathJax separately and
3447-# configure the path to it using the MATHJAX_RELPATH option.
3448-
3449-USE_MATHJAX = NO
3450-
3451-# When MathJax is enabled you can set the default output format to be used for
3452-# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
3453-# SVG. The default value is HTML-CSS, which is slower, but has the best
3454-# compatibility.
3455-
3456-MATHJAX_FORMAT = HTML-CSS
3457-
3458-# When MathJax is enabled you need to specify the location relative to the
3459-# HTML output directory using the MATHJAX_RELPATH option. The destination
3460-# directory should contain the MathJax.js script. For instance, if the mathjax
3461-# directory is located at the same level as the HTML output directory, then
3462-# MATHJAX_RELPATH should be ../mathjax. The default value points to
3463-# the MathJax Content Delivery Network so you can quickly see the result without
3464-# installing MathJax.
3465-# However, it is strongly recommended to install a local
3466-# copy of MathJax from http://www.mathjax.org before deployment.
3467-
3468-MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
3469-
3470-# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
3471-# names that should be enabled during MathJax rendering.
3472-
3473-MATHJAX_EXTENSIONS =
3474-
3475-# When the SEARCHENGINE tag is enabled doxygen will generate a search box
3476-# for the HTML output. The underlying search engine uses javascript
3477-# and DHTML and should work on any modern browser. Note that when using
3478-# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
3479-# (GENERATE_DOCSET) there is already a search function so this one should
3480-# typically be disabled. For large projects the javascript based search engine
3481-# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
3482-
3483-SEARCHENGINE = NO
3484-
3485-# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
3486-# implemented using a web server instead of a web client using Javascript.
3487-# There are two flavours of web server based search depending on the
3488-# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
3489-# searching and an index file used by the script. When EXTERNAL_SEARCH is
3490-# enabled the indexing and searching needs to be provided by external tools.
3491-# See the manual for details.
3492-
3493-SERVER_BASED_SEARCH = NO
3494-
3495-# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
3496-# script for searching. Instead the search results are written to an XML file
3497-# which needs to be processed by an external indexer. Doxygen will invoke an
3498-# external search engine pointed to by the SEARCHENGINE_URL option to obtain
3499-# the search results. Doxygen ships with an example indexer (doxyindexer) and
3500-# search engine (doxysearch.cgi) which are based on the open source search engine
3501-# library Xapian. See the manual for configuration details.
3502-
3503-EXTERNAL_SEARCH = NO
3504-
3505-# The SEARCHENGINE_URL should point to a search engine hosted by a web server
3506-# which will returned the search results when EXTERNAL_SEARCH is enabled.
3507-# Doxygen ships with an example search engine (doxysearch) which is based on
3508-# the open source search engine library Xapian. See the manual for configuration
3509-# details.
3510-
3511-SEARCHENGINE_URL =
3512-
3513-# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
3514-# search data is written to a file for indexing by an external tool. With the
3515-# SEARCHDATA_FILE tag the name of this file can be specified.
3516-
3517-SEARCHDATA_FILE = searchdata.xml
3518-
3519-# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
3520-# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
3521-# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
3522-# projects and redirect the results back to the right project.
3523-
3524-EXTERNAL_SEARCH_ID =
3525-
3526-# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
3527-# projects other than the one defined by this configuration file, but that are
3528-# all added to the same external search index. Each project needs to have a
3529-# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
3530-# of to a relative location where the documentation can be found.
3531-# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
3532-
3533-EXTRA_SEARCH_MAPPINGS =
3534-
3535-#---------------------------------------------------------------------------
3536-# configuration options related to the LaTeX output
3537-#---------------------------------------------------------------------------
3538-
3539-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
3540-# generate Latex output.
3541-
3542-GENERATE_LATEX = NO
3543-
3544-# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
3545-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3546-# put in front of it. If left blank `latex' will be used as the default path.
3547-
3548-LATEX_OUTPUT = latex
3549-
3550-# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
3551-# invoked. If left blank `latex' will be used as the default command name.
3552-# Note that when enabling USE_PDFLATEX this option is only used for
3553-# generating bitmaps for formulas in the HTML output, but not in the
3554-# Makefile that is written to the output directory.
3555-
3556-LATEX_CMD_NAME = latex
3557-
3558-# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
3559-# generate index for LaTeX. If left blank `makeindex' will be used as the
3560-# default command name.
3561-
3562-MAKEINDEX_CMD_NAME = makeindex
3563-
3564-# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
3565-# LaTeX documents. This may be useful for small projects and may help to
3566-# save some trees in general.
3567-
3568-COMPACT_LATEX = YES
3569-
3570-# The PAPER_TYPE tag can be used to set the paper type that is used
3571-# by the printer. Possible values are: a4, letter, legal and
3572-# executive. If left blank a4wide will be used.
3573-
3574-PAPER_TYPE = a4
3575-
3576-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
3577-# packages that should be included in the LaTeX output.
3578-
3579-EXTRA_PACKAGES =
3580-
3581-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
3582-# the generated latex document. The header should contain everything until
3583-# the first chapter. If it is left blank doxygen will generate a
3584-# standard header. Notice: only use this tag if you know what you are doing!
3585-
3586-LATEX_HEADER =
3587-
3588-# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
3589-# the generated latex document. The footer should contain everything after
3590-# the last chapter. If it is left blank doxygen will generate a
3591-# standard footer. Notice: only use this tag if you know what you are doing!
3592-
3593-LATEX_FOOTER =
3594-
3595-# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
3596-# is prepared for conversion to pdf (using ps2pdf). The pdf file will
3597-# contain links (just like the HTML output) instead of page references
3598-# This makes the output suitable for online browsing using a pdf viewer.
3599-
3600-PDF_HYPERLINKS = YES
3601-
3602-# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
3603-# plain latex in the generated Makefile. Set this option to YES to get a
3604-# higher quality PDF documentation.
3605-
3606-USE_PDFLATEX = YES
3607-
3608-# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
3609-# command to the generated LaTeX files. This will instruct LaTeX to keep
3610-# running if errors occur, instead of asking the user for help.
3611-# This option is also used when generating formulas in HTML.
3612-
3613-LATEX_BATCHMODE = NO
3614-
3615-# If LATEX_HIDE_INDICES is set to YES then doxygen will not
3616-# include the index chapters (such as File Index, Compound Index, etc.)
3617-# in the output.
3618-
3619-LATEX_HIDE_INDICES = NO
3620-
3621-# If LATEX_SOURCE_CODE is set to YES then doxygen will include
3622-# source code with syntax highlighting in the LaTeX output.
3623-# Note that which sources are shown also depends on other settings
3624-# such as SOURCE_BROWSER.
3625-
3626-LATEX_SOURCE_CODE = NO
3627-
3628-# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
3629-# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
3630-# http://en.wikipedia.org/wiki/BibTeX for more info.
3631-
3632-LATEX_BIB_STYLE = plain
3633-
3634-#---------------------------------------------------------------------------
3635-# configuration options related to the RTF output
3636-#---------------------------------------------------------------------------
3637-
3638-# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
3639-# The RTF output is optimized for Word 97 and may not look very pretty with
3640-# other RTF readers or editors.
3641-
3642-GENERATE_RTF = NO
3643-
3644-# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
3645-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3646-# put in front of it. If left blank `rtf' will be used as the default path.
3647-
3648-RTF_OUTPUT = rtf
3649-
3650-# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
3651-# RTF documents. This may be useful for small projects and may help to
3652-# save some trees in general.
3653-
3654-COMPACT_RTF = NO
3655-
3656-# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
3657-# will contain hyperlink fields. The RTF file will
3658-# contain links (just like the HTML output) instead of page references.
3659-# This makes the output suitable for online browsing using WORD or other
3660-# programs which support those fields.
3661-# Note: wordpad (write) and others do not support links.
3662-
3663-RTF_HYPERLINKS = NO
3664-
3665-# Load style sheet definitions from file. Syntax is similar to doxygen's
3666-# config file, i.e. a series of assignments. You only have to provide
3667-# replacements, missing definitions are set to their default value.
3668-
3669-RTF_STYLESHEET_FILE =
3670-
3671-# Set optional variables used in the generation of an rtf document.
3672-# Syntax is similar to doxygen's config file.
3673-
3674-RTF_EXTENSIONS_FILE =
3675-
3676-#---------------------------------------------------------------------------
3677-# configuration options related to the man page output
3678-#---------------------------------------------------------------------------
3679-
3680-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
3681-# generate man pages
3682-
3683-GENERATE_MAN = NO
3684-
3685-# The MAN_OUTPUT tag is used to specify where the man pages will be put.
3686-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3687-# put in front of it. If left blank `man' will be used as the default path.
3688-
3689-MAN_OUTPUT = man
3690-
3691-# The MAN_EXTENSION tag determines the extension that is added to
3692-# the generated man pages (default is the subroutine's section .3)
3693-
3694-MAN_EXTENSION = .3
3695-
3696-# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
3697-# then it will generate one additional man file for each entity
3698-# documented in the real man page(s). These additional files
3699-# only source the real man page, but without them the man command
3700-# would be unable to find the correct page. The default is NO.
3701-
3702-MAN_LINKS = NO
3703-
3704-#---------------------------------------------------------------------------
3705-# configuration options related to the XML output
3706-#---------------------------------------------------------------------------
3707-
3708-# If the GENERATE_XML tag is set to YES Doxygen will
3709-# generate an XML file that captures the structure of
3710-# the code including all documentation.
3711-
3712-GENERATE_XML = YES
3713-
3714-# The XML_OUTPUT tag is used to specify where the XML pages will be put.
3715-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3716-# put in front of it. If left blank `xml' will be used as the default path.
3717-
3718-XML_OUTPUT = xml
3719-
3720-# The XML_SCHEMA tag can be used to specify an XML schema,
3721-# which can be used by a validating XML parser to check the
3722-# syntax of the XML files.
3723-
3724-XML_SCHEMA =
3725-
3726-# The XML_DTD tag can be used to specify an XML DTD,
3727-# which can be used by a validating XML parser to check the
3728-# syntax of the XML files.
3729-
3730-XML_DTD =
3731-
3732-# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
3733-# dump the program listings (including syntax highlighting
3734-# and cross-referencing information) to the XML output. Note that
3735-# enabling this will significantly increase the size of the XML output.
3736-
3737-XML_PROGRAMLISTING = YES
3738-
3739-#---------------------------------------------------------------------------
3740-# configuration options for the AutoGen Definitions output
3741-#---------------------------------------------------------------------------
3742-
3743-# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
3744-# generate an AutoGen Definitions (see autogen.sf.net) file
3745-# that captures the structure of the code including all
3746-# documentation. Note that this feature is still experimental
3747-# and incomplete at the moment.
3748-
3749-GENERATE_AUTOGEN_DEF = NO
3750-
3751-#---------------------------------------------------------------------------
3752-# configuration options related to the Perl module output
3753-#---------------------------------------------------------------------------
3754-
3755-# If the GENERATE_PERLMOD tag is set to YES Doxygen will
3756-# generate a Perl module file that captures the structure of
3757-# the code including all documentation. Note that this
3758-# feature is still experimental and incomplete at the
3759-# moment.
3760-
3761-GENERATE_PERLMOD = NO
3762-
3763-# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
3764-# the necessary Makefile rules, Perl scripts and LaTeX code to be able
3765-# to generate PDF and DVI output from the Perl module output.
3766-
3767-PERLMOD_LATEX = NO
3768-
3769-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
3770-# nicely formatted so it can be parsed by a human reader.
3771-# This is useful
3772-# if you want to understand what is going on.
3773-# On the other hand, if this
3774-# tag is set to NO the size of the Perl module output will be much smaller
3775-# and Perl will parse it just the same.
3776-
3777-PERLMOD_PRETTY = YES
3778-
3779-# The names of the make variables in the generated doxyrules.make file
3780-# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
3781-# This is useful so different doxyrules.make files included by the same
3782-# Makefile don't overwrite each other's variables.
3783-
3784-PERLMOD_MAKEVAR_PREFIX =
3785-
3786-#---------------------------------------------------------------------------
3787-# Configuration options related to the preprocessor
3788-#---------------------------------------------------------------------------
3789-
3790-# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
3791-# evaluate all C-preprocessor directives found in the sources and include
3792-# files.
3793-
3794-ENABLE_PREPROCESSING = YES
3795-
3796-# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
3797-# names in the source code. If set to NO (the default) only conditional
3798-# compilation will be performed. Macro expansion can be done in a controlled
3799-# way by setting EXPAND_ONLY_PREDEF to YES.
3800-
3801-MACRO_EXPANSION = NO
3802-
3803-# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
3804-# then the macro expansion is limited to the macros specified with the
3805-# PREDEFINED and EXPAND_AS_DEFINED tags.
3806-
3807-EXPAND_ONLY_PREDEF = NO
3808-
3809-# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
3810-# pointed to by INCLUDE_PATH will be searched when a #include is found.
3811-
3812-SEARCH_INCLUDES = YES
3813-
3814-# The INCLUDE_PATH tag can be used to specify one or more directories that
3815-# contain include files that are not input files but should be processed by
3816-# the preprocessor.
3817-
3818-INCLUDE_PATH =
3819-
3820-# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
3821-# patterns (like *.h and *.hpp) to filter out the header-files in the
3822-# directories. If left blank, the patterns specified with FILE_PATTERNS will
3823-# be used.
3824-
3825-INCLUDE_FILE_PATTERNS =
3826-
3827-# The PREDEFINED tag can be used to specify one or more macro names that
3828-# are defined before the preprocessor is started (similar to the -D option of
3829-# gcc). The argument of the tag is a list of macros of the form: name
3830-# or name=definition (no spaces). If the definition and the = are
3831-# omitted =1 is assumed. To prevent a macro definition from being
3832-# undefined via #undef or recursively expanded use the := operator
3833-# instead of the = operator.
3834-
3835-PREDEFINED =
3836-
3837-# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
3838-# this tag can be used to specify a list of macro names that should be expanded.
3839-# The macro definition that is found in the sources will be used.
3840-# Use the PREDEFINED tag if you want to use a different macro definition that
3841-# overrules the definition found in the source code.
3842-
3843-EXPAND_AS_DEFINED =
3844-
3845-# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
3846-# doxygen's preprocessor will remove all references to function-like macros
3847-# that are alone on a line, have an all uppercase name, and do not end with a
3848-# semicolon, because these will confuse the parser if not removed.
3849-
3850-SKIP_FUNCTION_MACROS = YES
3851-
3852-#---------------------------------------------------------------------------
3853-# Configuration::additions related to external references
3854-#---------------------------------------------------------------------------
3855-
3856-# The TAGFILES option can be used to specify one or more tagfiles. For each
3857-# tag file the location of the external documentation should be added. The
3858-# format of a tag file without this location is as follows:
3859-#
3860-# TAGFILES = file1 file2 ...
3861-# Adding location for the tag files is done as follows:
3862-#
3863-# TAGFILES = file1=loc1 "file2 = loc2" ...
3864-# where "loc1" and "loc2" can be relative or absolute paths
3865-# or URLs. Note that each tag file must have a unique name (where the name does
3866-# NOT include the path). If a tag file is not located in the directory in which
3867-# doxygen is run, you must also specify the path to the tagfile here.
3868-
3869-TAGFILES =
3870-
3871-# When a file name is specified after GENERATE_TAGFILE, doxygen will create
3872-# a tag file that is based on the input files it reads.
3873-
3874-GENERATE_TAGFILE =
3875-
3876-# If the ALLEXTERNALS tag is set to YES all external classes will be listed
3877-# in the class index. If set to NO only the inherited external classes
3878-# will be listed.
3879-
3880-ALLEXTERNALS = NO
3881-
3882-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
3883-# in the modules index. If set to NO, only the current project's groups will
3884-# be listed.
3885-
3886-EXTERNAL_GROUPS = YES
3887-
3888-# The PERL_PATH should be the absolute path and name of the perl script
3889-# interpreter (i.e. the result of `which perl').
3890-
3891-PERL_PATH = /usr/bin/perl
3892-
3893-#---------------------------------------------------------------------------
3894-# Configuration options related to the dot tool
3895-#---------------------------------------------------------------------------
3896-
3897-# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
3898-# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
3899-# or super classes. Setting the tag to NO turns the diagrams off. Note that
3900-# this option also works with HAVE_DOT disabled, but it is recommended to
3901-# install and use dot, since it yields more powerful graphs.
3902-
3903-CLASS_DIAGRAMS = YES
3904-
3905-# You can define message sequence charts within doxygen comments using the \msc
3906-# command. Doxygen will then run the mscgen tool (see
3907-# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
3908-# documentation. The MSCGEN_PATH tag allows you to specify the directory where
3909-# the mscgen tool resides. If left empty the tool is assumed to be found in the
3910-# default search path.
3911-
3912-MSCGEN_PATH =
3913-
3914-# If set to YES, the inheritance and collaboration graphs will hide
3915-# inheritance and usage relations if the target is undocumented
3916-# or is not a class.
3917-
3918-HIDE_UNDOC_RELATIONS = NO
3919-
3920-# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
3921-# available from the path. This tool is part of Graphviz, a graph visualization
3922-# toolkit from AT&T and Lucent Bell Labs. The other options in this section
3923-# have no effect if this option is set to NO (the default)
3924-
3925-HAVE_DOT = YES
3926-
3927-# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
3928-# allowed to run in parallel. When set to 0 (the default) doxygen will
3929-# base this on the number of processors available in the system. You can set it
3930-# explicitly to a value larger than 0 to get control over the balance
3931-# between CPU load and processing speed.
3932-
3933-DOT_NUM_THREADS = 0
3934-
3935-# By default doxygen will use the Helvetica font for all dot files that
3936-# doxygen generates. When you want a differently looking font you can specify
3937-# the font name using DOT_FONTNAME. You need to make sure dot is able to find
3938-# the font, which can be done by putting it in a standard location or by setting
3939-# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
3940-# directory containing the font.
3941-
3942-DOT_FONTNAME = Helvetica
3943-
3944-# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
3945-# The default size is 10pt.
3946-
3947-DOT_FONTSIZE = 10
3948-
3949-# By default doxygen will tell dot to use the Helvetica font.
3950-# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
3951-# set the path where dot can find it.
3952-
3953-DOT_FONTPATH =
3954-
3955-# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
3956-# will generate a graph for each documented class showing the direct and
3957-# indirect inheritance relations. Setting this tag to YES will force the
3958-# CLASS_DIAGRAMS tag to NO.
3959-
3960-CLASS_GRAPH = YES
3961-
3962-# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
3963-# will generate a graph for each documented class showing the direct and
3964-# indirect implementation dependencies (inheritance, containment, and
3965-# class references variables) of the class with other documented classes.
3966-
3967-COLLABORATION_GRAPH = YES
3968-
3969-# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
3970-# will generate a graph for groups, showing the direct groups dependencies
3971-
3972-GROUP_GRAPHS = YES
3973-
3974-# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
3975-# collaboration diagrams in a style similar to the OMG's Unified Modeling
3976-# Language.
3977-
3978-UML_LOOK = YES
3979-
3980-# If the UML_LOOK tag is enabled, the fields and methods are shown inside
3981-# the class node. If there are many fields or methods and many nodes the
3982-# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
3983-# threshold limits the number of items for each type to make the size more
3984-# managable. Set this to 0 for no limit. Note that the threshold may be
3985-# exceeded by 50% before the limit is enforced.
3986-
3987-UML_LIMIT_NUM_FIELDS = 10
3988-
3989-# If set to YES, the inheritance and collaboration graphs will show the
3990-# relations between templates and their instances.
3991-
3992-TEMPLATE_RELATIONS = NO
3993-
3994-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
3995-# tags are set to YES then doxygen will generate a graph for each documented
3996-# file showing the direct and indirect include dependencies of the file with
3997-# other documented files.
3998-
3999-INCLUDE_GRAPH = YES
4000-
4001-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
4002-# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
4003-# documented header file showing the documented files that directly or
4004-# indirectly include this file.
4005-
4006-INCLUDED_BY_GRAPH = YES
4007-
4008-# If the CALL_GRAPH and HAVE_DOT options are set to YES then
4009-# doxygen will generate a call dependency graph for every global function
4010-# or class method. Note that enabling this option will significantly increase
4011-# the time of a run. So in most cases it will be better to enable call graphs
4012-# for selected functions only using the \callgraph command.
4013-
4014-CALL_GRAPH = YES
4015-
4016-# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
4017-# doxygen will generate a caller dependency graph for every global function
4018-# or class method. Note that enabling this option will significantly increase
4019-# the time of a run. So in most cases it will be better to enable caller
4020-# graphs for selected functions only using the \callergraph command.
4021-
4022-CALLER_GRAPH = NO
4023-
4024-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
4025-# will generate a graphical hierarchy of all classes instead of a textual one.
4026-
4027-GRAPHICAL_HIERARCHY = YES
4028-
4029-# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
4030-# then doxygen will show the dependencies a directory has on other directories
4031-# in a graphical way. The dependency relations are determined by the #include
4032-# relations between the files in the directories.
4033-
4034-DIRECTORY_GRAPH = YES
4035-
4036-# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
4037-# generated by dot. Possible values are svg, png, jpg, or gif.
4038-# If left blank png will be used. If you choose svg you need to set
4039-# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
4040-# visible in IE 9+ (other browsers do not have this requirement).
4041-
4042-DOT_IMAGE_FORMAT = png
4043-
4044-# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
4045-# enable generation of interactive SVG images that allow zooming and panning.
4046-# Note that this requires a modern browser other than Internet Explorer.
4047-# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
4048-# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
4049-# visible. Older versions of IE do not have SVG support.
4050-
4051-INTERACTIVE_SVG = YES
4052-
4053-# The tag DOT_PATH can be used to specify the path where the dot tool can be
4054-# found. If left blank, it is assumed the dot tool can be found in the path.
4055-
4056-DOT_PATH =
4057-
4058-# The DOTFILE_DIRS tag can be used to specify one or more directories that
4059-# contain dot files that are included in the documentation (see the
4060-# \dotfile command).
4061-
4062-DOTFILE_DIRS =
4063-
4064-# The MSCFILE_DIRS tag can be used to specify one or more directories that
4065-# contain msc files that are included in the documentation (see the
4066-# \mscfile command).
4067-
4068-MSCFILE_DIRS =
4069-
4070-# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
4071-# nodes that will be shown in the graph. If the number of nodes in a graph
4072-# becomes larger than this value, doxygen will truncate the graph, which is
4073-# visualized by representing a node as a red box. Note that doxygen if the
4074-# number of direct children of the root node in a graph is already larger than
4075-# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
4076-# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
4077-
4078-DOT_GRAPH_MAX_NODES = 50
4079-
4080-# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
4081-# graphs generated by dot. A depth value of 3 means that only nodes reachable
4082-# from the root by following a path via at most 3 edges will be shown. Nodes
4083-# that lay further from the root node will be omitted. Note that setting this
4084-# option to 1 or 2 may greatly reduce the computation time needed for large
4085-# code bases. Also note that the size of a graph can be further restricted by
4086-# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
4087-
4088-MAX_DOT_GRAPH_DEPTH = 0
4089-
4090-# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
4091-# background. This is disabled by default, because dot on Windows does not
4092-# seem to support this out of the box. Warning: Depending on the platform used,
4093-# enabling this option may lead to badly anti-aliased labels on the edges of
4094-# a graph (i.e. they become hard to read).
4095-
4096-DOT_TRANSPARENT = YES
4097-
4098-# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
4099-# files in one run (i.e. multiple -o and -T options on the command line). This
4100-# makes dot run faster, but since only newer versions of dot (>1.8.10)
4101-# support this, this feature is disabled by default.
4102-
4103-DOT_MULTI_TARGETS = YES
4104-
4105-# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
4106-# generate a legend page explaining the meaning of the various boxes and
4107-# arrows in the dot generated graphs.
4108-
4109-GENERATE_LEGEND = YES
4110-
4111-# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
4112-# remove the intermediate dot files that are used to generate
4113-# the various graphs.
4114-
4115-DOT_CLEANUP = YES
4116
4117=== added directory 'doc/dbus'
4118=== added file 'doc/dbus/connectivity-api.txt'
4119--- doc/dbus/connectivity-api.txt 1970-01-01 00:00:00 +0000
4120+++ doc/dbus/connectivity-api.txt 2014-08-21 18:21:03 +0000
4121@@ -0,0 +1,26 @@
4122+Service com.ubuntu.connectivity1
4123+Interface com.ubuntu.connectivity1.NetworkingStatus
4124+Object path /com/ubuntu/connectivity1/NetworkingStatus
4125+Policy group connectivity
4126+Supports org.freedesktop.DBus.Introspectable
4127+ org.freedesktop.DBus.Properties
4128+
4129+Properties array{string} Limitations [readonly]
4130+
4131+ String array representing the possible limitations
4132+ on networking.
4133+
4134+ Currently available limitations are:
4135+ "bandwith"
4136+
4137+ "bandwith" - indicates that the bandwith of the
4138+ Internet connection has limitations.
4139+ Applications should minimize their bandwith
4140+ usage if possible.
4141+
4142+ string Status [readonly]
4143+
4144+ Status of the Internet connectivity.
4145+
4146+ Possible values:
4147+ "offline", "connecting", "online"
4148
4149=== removed directory 'doc/pages'
4150=== removed file 'doc/pages/mainpage.dox'
4151--- doc/pages/mainpage.dox 2014-03-11 12:20:55 +0000
4152+++ doc/pages/mainpage.dox 1970-01-01 00:00:00 +0000
4153@@ -1,23 +0,0 @@
4154-/*!
4155-\mainpage Ubuntu Connectivity API
4156-
4157-\tableofcontents
4158-
4159-\section sec_introduction Introduction
4160-
4161-Ubuntu API offers a way to access the connectivity related information of the system.
4162-
4163-\subsection sec_thread_safety Note on thread safety
4164-
4165-The API implementation uses a worker thread. The property changes may be dispatched from this thread and thus the
4166-user of this API must make sure to handle necessary threading issues.
4167-
4168-\section sec_general General Topics
4169-
4170- - \ref using-cpp "Using this C++ API"
4171- - \ref networking-status "Getting the networking status."
4172-
4173-\section sec_bug_reports Reporting Bugs
4174-If you find any problems with the or this documentation,
4175-please file a bug in Connectivity API [Launchpad page](https://bugs.launchpad.net/connectivity-api).
4176-*/
4177
4178=== removed file 'doc/pages/networking-status.dox'
4179--- doc/pages/networking-status.dox 2014-03-11 14:19:31 +0000
4180+++ doc/pages/networking-status.dox 1970-01-01 00:00:00 +0000
4181@@ -1,31 +0,0 @@
4182-/*!
4183-\page networking-status Networking Status
4184-
4185-Applications needing to access the overall system networking status can access the
4186-top level com::ubuntu::connectivity::networking::Manager class. The class has properties
4187-for the networking status and connection characteristics of the system networking.
4188-
4189-\section Setup
4190-
4191-Manager is accessed by including the appropriate header:
4192-\snippet example_networking_status.cpp include
4193-
4194-and then creating an instance of the manager:
4195-\snippet example_networking_status.cpp create manager
4196-
4197-\section sec_networking_status Networking Status
4198-
4199-The status of the system networking can be accessed through the Manager::status property:
4200-\snippet example_networking_status.cpp subscribe networking status changes
4201-
4202-\section sec_characteristics Networking Characteristics
4203-
4204-The characteristics can be accessed through the Manager::characteristics property
4205-as a bitfield:
4206-\snippet example_networking_status.cpp subscribe characteristics changes
4207-
4208----
4209-The complete example (found in <i>examples/example_networking_status.cpp</i>):
4210-\include example_networking_status.cpp
4211-
4212-*/
4213
4214=== removed file 'doc/pages/using.dox'
4215--- doc/pages/using.dox 2014-03-11 12:20:55 +0000
4216+++ doc/pages/using.dox 1970-01-01 00:00:00 +0000
4217@@ -1,23 +0,0 @@
4218-/*!
4219-\page using-cpp Using the C++ API
4220-
4221-Install the development headers:
4222-
4223-\code{.txt}
4224-sudo apt-get install libconnectivity-cpp-dev
4225-\endcode
4226-
4227-Enable c++11 and use pkg-config to get the necessary compilation flags:
4228-
4229-\code{.txt}
4230-$ g++ myapp.cpp -std=c++11 `pkg-config --cflags --libs connectivity-cpp` -o myapp
4231-\endcode
4232-
4233-The headers can then be included as:
4234-
4235-\code{.cpp}
4236-// includes the com::ubuntu::networking::connectivity::Manager class
4237-#include <com/ubuntu/connectivity/networking/manager.h>
4238-\endcode
4239-
4240-*/
4241
4242=== added directory 'doc/qt'
4243=== added file 'doc/qt/CMakeLists.txt'
4244--- doc/qt/CMakeLists.txt 1970-01-01 00:00:00 +0000
4245+++ doc/qt/CMakeLists.txt 2014-08-21 18:21:03 +0000
4246@@ -0,0 +1,3 @@
4247+add_subdirectory(cpp)
4248+add_subdirectory(qml)
4249+
4250
4251=== added directory 'doc/qt/cpp'
4252=== added file 'doc/qt/cpp/CMakeLists.txt'
4253--- doc/qt/cpp/CMakeLists.txt 1970-01-01 00:00:00 +0000
4254+++ doc/qt/cpp/CMakeLists.txt 2014-08-21 18:21:03 +0000
4255@@ -0,0 +1,40 @@
4256+add_subdirectory(examples)
4257+
4258+set(EXTRACT_PRIVATE NO)
4259+set(INTERNAL_DOCS NO)
4260+set(SOURCE_DIRS "${CMAKE_SOURCE_DIR}/src/qt/include ${CMAKE_CURRENT_SOURCE_DIR}")
4261+
4262+if(${PRIVATE_DOCS})
4263+ set(EXTRACT_PRIVATE YES)
4264+ set(INTERNAL_DOCS YES)
4265+ set(SOURCE_DIRS "${SOURCE_DIRS} ${CMAKE_SOURCE_DIR}/src")
4266+endif()
4267+
4268+set(DOC_FILES
4269+ Doxyfile.in
4270+ pages/mainpage.dox
4271+ pages/using.dox
4272+ pages/networking-status.dox
4273+)
4274+
4275+find_package(Doxygen)
4276+if(DOXYGEN_FOUND)
4277+ configure_file(
4278+ ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
4279+ ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY
4280+ )
4281+ add_custom_target(cppdoc
4282+ ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
4283+ WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
4284+ COMMENT "Generating API documentation with Doxygen" VERBATIM
4285+ SOURCES ${DOC_FILES}
4286+ )
4287+ install(
4288+ DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
4289+ DESTINATION ${INSTALL_DOCDIR}/cpp/
4290+ )
4291+ install(
4292+ DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/xml
4293+ DESTINATION ${INSTALL_DOCDIR}/cpp/
4294+ )
4295+endif(DOXYGEN_FOUND)
4296
4297=== added file 'doc/qt/cpp/Doxyfile.in'
4298--- doc/qt/cpp/Doxyfile.in 1970-01-01 00:00:00 +0000
4299+++ doc/qt/cpp/Doxyfile.in 2014-08-21 18:21:03 +0000
4300@@ -0,0 +1,2316 @@
4301+# Doxyfile 1.8.7
4302+
4303+# This file describes the settings to be used by the documentation system
4304+# doxygen (www.doxygen.org) for a project.
4305+#
4306+# All text after a double hash (##) is considered a comment and is placed in
4307+# front of the TAG it is preceding.
4308+#
4309+# All text after a single hash (#) is considered a comment and will be ignored.
4310+# The format is:
4311+# TAG = value [value, ...]
4312+# For lists, items can also be appended using:
4313+# TAG += value [value, ...]
4314+# Values that contain spaces should be placed between quotes (\" \").
4315+
4316+#---------------------------------------------------------------------------
4317+# Project related configuration options
4318+#---------------------------------------------------------------------------
4319+
4320+# This tag specifies the encoding used for all characters in the config file
4321+# that follow. The default is UTF-8 which is also the encoding used for all text
4322+# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
4323+# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
4324+# for the list of possible encodings.
4325+# The default value is: UTF-8.
4326+
4327+DOXYFILE_ENCODING = UTF-8
4328+
4329+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
4330+# double-quotes, unless you are using Doxywizard) that should identify the
4331+# project for which the documentation is generated. This name is used in the
4332+# title of most generated pages and in a few other places.
4333+# The default value is: My Project.
4334+
4335+PROJECT_NAME = "Ubuntu Connectivity Qt API"
4336+
4337+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
4338+# could be handy for archiving the generated documentation or if some version
4339+# control system is used.
4340+
4341+PROJECT_NUMBER = @CONNECTIVITY_QT_VERSION_MAJOR@.@CONNECTIVITY_QT_VERSION_MINOR@
4342+
4343+# Using the PROJECT_BRIEF tag one can provide an optional one line description
4344+# for a project that appears at the top of each page and should give viewer a
4345+# quick idea about the purpose of the project. Keep the description short.
4346+
4347+PROJECT_BRIEF =
4348+
4349+# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
4350+# the documentation. The maximum height of the logo should not exceed 55 pixels
4351+# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
4352+# to the output directory.
4353+
4354+PROJECT_LOGO =
4355+
4356+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
4357+# into which the generated documentation will be written. If a relative path is
4358+# entered, it will be relative to the location where doxygen was started. If
4359+# left blank the current directory will be used.
4360+
4361+OUTPUT_DIRECTORY =
4362+
4363+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
4364+# directories (in 2 levels) under the output directory of each output format and
4365+# will distribute the generated files over these directories. Enabling this
4366+# option can be useful when feeding doxygen a huge amount of source files, where
4367+# putting all generated files in the same directory would otherwise causes
4368+# performance problems for the file system.
4369+# The default value is: NO.
4370+
4371+CREATE_SUBDIRS = NO
4372+
4373+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
4374+# characters to appear in the names of generated files. If set to NO, non-ASCII
4375+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
4376+# U+3044.
4377+# The default value is: NO.
4378+
4379+ALLOW_UNICODE_NAMES = NO
4380+
4381+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
4382+# documentation generated by doxygen is written. Doxygen will use this
4383+# information to generate all constant output in the proper language.
4384+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
4385+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
4386+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
4387+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
4388+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
4389+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
4390+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
4391+# Ukrainian and Vietnamese.
4392+# The default value is: English.
4393+
4394+OUTPUT_LANGUAGE = English
4395+
4396+# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
4397+# descriptions after the members that are listed in the file and class
4398+# documentation (similar to Javadoc). Set to NO to disable this.
4399+# The default value is: YES.
4400+
4401+BRIEF_MEMBER_DESC = YES
4402+
4403+# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
4404+# description of a member or function before the detailed description
4405+#
4406+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
4407+# brief descriptions will be completely suppressed.
4408+# The default value is: YES.
4409+
4410+REPEAT_BRIEF = YES
4411+
4412+# This tag implements a quasi-intelligent brief description abbreviator that is
4413+# used to form the text in various listings. Each string in this list, if found
4414+# as the leading text of the brief description, will be stripped from the text
4415+# and the result, after processing the whole list, is used as the annotated
4416+# text. Otherwise, the brief description is used as-is. If left blank, the
4417+# following values are used ($name is automatically replaced with the name of
4418+# the entity):The $name class, The $name widget, The $name file, is, provides,
4419+# specifies, contains, represents, a, an and the.
4420+
4421+ABBREVIATE_BRIEF =
4422+
4423+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
4424+# doxygen will generate a detailed section even if there is only a brief
4425+# description.
4426+# The default value is: NO.
4427+
4428+ALWAYS_DETAILED_SEC = NO
4429+
4430+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
4431+# inherited members of a class in the documentation of that class as if those
4432+# members were ordinary class members. Constructors, destructors and assignment
4433+# operators of the base classes will not be shown.
4434+# The default value is: NO.
4435+
4436+INLINE_INHERITED_MEMB = NO
4437+
4438+# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
4439+# before files name in the file list and in the header files. If set to NO the
4440+# shortest path that makes the file name unique will be used
4441+# The default value is: YES.
4442+
4443+FULL_PATH_NAMES = NO
4444+
4445+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
4446+# Stripping is only done if one of the specified strings matches the left-hand
4447+# part of the path. The tag can be used to show relative paths in the file list.
4448+# If left blank the directory from which doxygen is run is used as the path to
4449+# strip.
4450+#
4451+# Note that you can specify absolute paths here, but also relative paths, which
4452+# will be relative from the directory where doxygen is started.
4453+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
4454+
4455+STRIP_FROM_PATH =
4456+
4457+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
4458+# path mentioned in the documentation of a class, which tells the reader which
4459+# header file to include in order to use a class. If left blank only the name of
4460+# the header file containing the class definition is used. Otherwise one should
4461+# specify the list of include paths that are normally passed to the compiler
4462+# using the -I flag.
4463+
4464+STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/src/qt/include
4465+
4466+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
4467+# less readable) file names. This can be useful is your file systems doesn't
4468+# support long names like on DOS, Mac, or CD-ROM.
4469+# The default value is: NO.
4470+
4471+SHORT_NAMES = NO
4472+
4473+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
4474+# first line (until the first dot) of a Javadoc-style comment as the brief
4475+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
4476+# style comments (thus requiring an explicit @brief command for a brief
4477+# description.)
4478+# The default value is: NO.
4479+
4480+JAVADOC_AUTOBRIEF = NO
4481+
4482+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
4483+# line (until the first dot) of a Qt-style comment as the brief description. If
4484+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
4485+# requiring an explicit \brief command for a brief description.)
4486+# The default value is: NO.
4487+
4488+QT_AUTOBRIEF = NO
4489+
4490+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
4491+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
4492+# a brief description. This used to be the default behavior. The new default is
4493+# to treat a multi-line C++ comment block as a detailed description. Set this
4494+# tag to YES if you prefer the old behavior instead.
4495+#
4496+# Note that setting this tag to YES also means that rational rose comments are
4497+# not recognized any more.
4498+# The default value is: NO.
4499+
4500+MULTILINE_CPP_IS_BRIEF = NO
4501+
4502+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
4503+# documentation from any documented member that it re-implements.
4504+# The default value is: YES.
4505+
4506+INHERIT_DOCS = YES
4507+
4508+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
4509+# new page for each member. If set to NO, the documentation of a member will be
4510+# part of the file/class/namespace that contains it.
4511+# The default value is: NO.
4512+
4513+SEPARATE_MEMBER_PAGES = NO
4514+
4515+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
4516+# uses this value to replace tabs by spaces in code fragments.
4517+# Minimum value: 1, maximum value: 16, default value: 4.
4518+
4519+TAB_SIZE = 4
4520+
4521+# This tag can be used to specify a number of aliases that act as commands in
4522+# the documentation. An alias has the form:
4523+# name=value
4524+# For example adding
4525+# "sideeffect=@par Side Effects:\n"
4526+# will allow you to put the command \sideeffect (or @sideeffect) in the
4527+# documentation, which will result in a user-defined paragraph with heading
4528+# "Side Effects:". You can put \n's in the value part of an alias to insert
4529+# newlines.
4530+
4531+ALIASES = "accessors=\par Accessors:\n" \
4532+ "initvalue=\par Initial Value:\n" \
4533+ "notify=\par Notify:\n"
4534+
4535+# This tag can be used to specify a number of word-keyword mappings (TCL only).
4536+# A mapping has the form "name=value". For example adding "class=itcl::class"
4537+# will allow you to use the command class in the itcl::class meaning.
4538+
4539+TCL_SUBST =
4540+
4541+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
4542+# only. Doxygen will then generate output that is more tailored for C. For
4543+# instance, some of the names that are used will be different. The list of all
4544+# members will be omitted, etc.
4545+# The default value is: NO.
4546+
4547+OPTIMIZE_OUTPUT_FOR_C = NO
4548+
4549+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
4550+# Python sources only. Doxygen will then generate output that is more tailored
4551+# for that language. For instance, namespaces will be presented as packages,
4552+# qualified scopes will look different, etc.
4553+# The default value is: NO.
4554+
4555+OPTIMIZE_OUTPUT_JAVA = NO
4556+
4557+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
4558+# sources. Doxygen will then generate output that is tailored for Fortran.
4559+# The default value is: NO.
4560+
4561+OPTIMIZE_FOR_FORTRAN = NO
4562+
4563+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
4564+# sources. Doxygen will then generate output that is tailored for VHDL.
4565+# The default value is: NO.
4566+
4567+OPTIMIZE_OUTPUT_VHDL = NO
4568+
4569+# Doxygen selects the parser to use depending on the extension of the files it
4570+# parses. With this tag you can assign which parser to use for a given
4571+# extension. Doxygen has a built-in mapping, but you can override or extend it
4572+# using this tag. The format is ext=language, where ext is a file extension, and
4573+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
4574+# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
4575+# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
4576+# Fortran. In the later case the parser tries to guess whether the code is fixed
4577+# or free formatted code, this is the default for Fortran type files), VHDL. For
4578+# instance to make doxygen treat .inc files as Fortran files (default is PHP),
4579+# and .f files as C (default is Fortran), use: inc=Fortran f=C.
4580+#
4581+# Note For files without extension you can use no_extension as a placeholder.
4582+#
4583+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
4584+# the files are not read by doxygen.
4585+
4586+EXTENSION_MAPPING =
4587+
4588+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
4589+# according to the Markdown format, which allows for more readable
4590+# documentation. See http://daringfireball.net/projects/markdown/ for details.
4591+# The output of markdown processing is further processed by doxygen, so you can
4592+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
4593+# case of backward compatibilities issues.
4594+# The default value is: YES.
4595+
4596+MARKDOWN_SUPPORT = YES
4597+
4598+# When enabled doxygen tries to link words that correspond to documented
4599+# classes, or namespaces to their corresponding documentation. Such a link can
4600+# be prevented in individual cases by by putting a % sign in front of the word
4601+# or globally by setting AUTOLINK_SUPPORT to NO.
4602+# The default value is: YES.
4603+
4604+AUTOLINK_SUPPORT = YES
4605+
4606+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
4607+# to include (a tag file for) the STL sources as input, then you should set this
4608+# tag to YES in order to let doxygen match functions declarations and
4609+# definitions whose arguments contain STL classes (e.g. func(std::string);
4610+# versus func(std::string) {}). This also make the inheritance and collaboration
4611+# diagrams that involve STL classes more complete and accurate.
4612+# The default value is: NO.
4613+
4614+BUILTIN_STL_SUPPORT = YES
4615+
4616+# If you use Microsoft's C++/CLI language, you should set this option to YES to
4617+# enable parsing support.
4618+# The default value is: NO.
4619+
4620+CPP_CLI_SUPPORT = NO
4621+
4622+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
4623+# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
4624+# will parse them like normal C++ but will assume all classes use public instead
4625+# of private inheritance when no explicit protection keyword is present.
4626+# The default value is: NO.
4627+
4628+SIP_SUPPORT = NO
4629+
4630+# For Microsoft's IDL there are propget and propput attributes to indicate
4631+# getter and setter methods for a property. Setting this option to YES will make
4632+# doxygen to replace the get and set methods by a property in the documentation.
4633+# This will only work if the methods are indeed getting or setting a simple
4634+# type. If this is not the case, or you want to show the methods anyway, you
4635+# should set this option to NO.
4636+# The default value is: YES.
4637+
4638+IDL_PROPERTY_SUPPORT = YES
4639+
4640+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
4641+# tag is set to YES, then doxygen will reuse the documentation of the first
4642+# member in the group (if any) for the other members of the group. By default
4643+# all members of a group must be documented explicitly.
4644+# The default value is: NO.
4645+
4646+DISTRIBUTE_GROUP_DOC = NO
4647+
4648+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
4649+# (for instance a group of public functions) to be put as a subgroup of that
4650+# type (e.g. under the Public Functions section). Set it to NO to prevent
4651+# subgrouping. Alternatively, this can be done per class using the
4652+# \nosubgrouping command.
4653+# The default value is: YES.
4654+
4655+SUBGROUPING = YES
4656+
4657+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
4658+# are shown inside the group in which they are included (e.g. using \ingroup)
4659+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
4660+# and RTF).
4661+#
4662+# Note that this feature does not work in combination with
4663+# SEPARATE_MEMBER_PAGES.
4664+# The default value is: NO.
4665+
4666+INLINE_GROUPED_CLASSES = NO
4667+
4668+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
4669+# with only public data fields or simple typedef fields will be shown inline in
4670+# the documentation of the scope in which they are defined (i.e. file,
4671+# namespace, or group documentation), provided this scope is documented. If set
4672+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
4673+# Man pages) or section (for LaTeX and RTF).
4674+# The default value is: NO.
4675+
4676+INLINE_SIMPLE_STRUCTS = NO
4677+
4678+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
4679+# enum is documented as struct, union, or enum with the name of the typedef. So
4680+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
4681+# with name TypeT. When disabled the typedef will appear as a member of a file,
4682+# namespace, or class. And the struct will be named TypeS. This can typically be
4683+# useful for C code in case the coding convention dictates that all compound
4684+# types are typedef'ed and only the typedef is referenced, never the tag name.
4685+# The default value is: NO.
4686+
4687+TYPEDEF_HIDES_STRUCT = NO
4688+
4689+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
4690+# cache is used to resolve symbols given their name and scope. Since this can be
4691+# an expensive process and often the same symbol appears multiple times in the
4692+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
4693+# doxygen will become slower. If the cache is too large, memory is wasted. The
4694+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
4695+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
4696+# symbols. At the end of a run doxygen will report the cache usage and suggest
4697+# the optimal cache size from a speed point of view.
4698+# Minimum value: 0, maximum value: 9, default value: 0.
4699+
4700+LOOKUP_CACHE_SIZE = 0
4701+
4702+#---------------------------------------------------------------------------
4703+# Build related configuration options
4704+#---------------------------------------------------------------------------
4705+
4706+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
4707+# documentation are documented, even if no documentation was available. Private
4708+# class members and static file members will be hidden unless the
4709+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
4710+# Note: This will also disable the warnings about undocumented members that are
4711+# normally produced when WARNINGS is set to YES.
4712+# The default value is: NO.
4713+
4714+EXTRACT_ALL = YES
4715+
4716+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
4717+# be included in the documentation.
4718+# The default value is: NO.
4719+
4720+EXTRACT_PRIVATE = @EXTRACT_PRIVATE@
4721+
4722+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
4723+# scope will be included in the documentation.
4724+# The default value is: NO.
4725+
4726+EXTRACT_PACKAGE = NO
4727+
4728+# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
4729+# included in the documentation.
4730+# The default value is: NO.
4731+
4732+EXTRACT_STATIC = YES
4733+
4734+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
4735+# locally in source files will be included in the documentation. If set to NO
4736+# only classes defined in header files are included. Does not have any effect
4737+# for Java sources.
4738+# The default value is: YES.
4739+
4740+EXTRACT_LOCAL_CLASSES = YES
4741+
4742+# This flag is only useful for Objective-C code. When set to YES local methods,
4743+# which are defined in the implementation section but not in the interface are
4744+# included in the documentation. If set to NO only methods in the interface are
4745+# included.
4746+# The default value is: NO.
4747+
4748+EXTRACT_LOCAL_METHODS = NO
4749+
4750+# If this flag is set to YES, the members of anonymous namespaces will be
4751+# extracted and appear in the documentation as a namespace called
4752+# 'anonymous_namespace{file}', where file will be replaced with the base name of
4753+# the file that contains the anonymous namespace. By default anonymous namespace
4754+# are hidden.
4755+# The default value is: NO.
4756+
4757+EXTRACT_ANON_NSPACES = NO
4758+
4759+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
4760+# undocumented members inside documented classes or files. If set to NO these
4761+# members will be included in the various overviews, but no documentation
4762+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
4763+# The default value is: NO.
4764+
4765+HIDE_UNDOC_MEMBERS = NO
4766+
4767+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
4768+# undocumented classes that are normally visible in the class hierarchy. If set
4769+# to NO these classes will be included in the various overviews. This option has
4770+# no effect if EXTRACT_ALL is enabled.
4771+# The default value is: NO.
4772+
4773+HIDE_UNDOC_CLASSES = NO
4774+
4775+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
4776+# (class|struct|union) declarations. If set to NO these declarations will be
4777+# included in the documentation.
4778+# The default value is: NO.
4779+
4780+HIDE_FRIEND_COMPOUNDS = YES
4781+
4782+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
4783+# documentation blocks found inside the body of a function. If set to NO these
4784+# blocks will be appended to the function's detailed documentation block.
4785+# The default value is: NO.
4786+
4787+HIDE_IN_BODY_DOCS = NO
4788+
4789+# The INTERNAL_DOCS tag determines if documentation that is typed after a
4790+# \internal command is included. If the tag is set to NO then the documentation
4791+# will be excluded. Set it to YES to include the internal documentation.
4792+# The default value is: NO.
4793+
4794+INTERNAL_DOCS = @INTERNAL_DOCS@
4795+
4796+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
4797+# names in lower-case letters. If set to YES upper-case letters are also
4798+# allowed. This is useful if you have classes or files whose names only differ
4799+# in case and if your file system supports case sensitive file names. Windows
4800+# and Mac users are advised to set this option to NO.
4801+# The default value is: system dependent.
4802+
4803+CASE_SENSE_NAMES = YES
4804+
4805+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
4806+# their full class and namespace scopes in the documentation. If set to YES the
4807+# scope will be hidden.
4808+# The default value is: NO.
4809+
4810+HIDE_SCOPE_NAMES = NO
4811+
4812+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
4813+# the files that are included by a file in the documentation of that file.
4814+# The default value is: YES.
4815+
4816+SHOW_INCLUDE_FILES = YES
4817+
4818+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
4819+# grouped member an include statement to the documentation, telling the reader
4820+# which file to include in order to use the member.
4821+# The default value is: NO.
4822+
4823+SHOW_GROUPED_MEMB_INC = NO
4824+
4825+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
4826+# files with double quotes in the documentation rather than with sharp brackets.
4827+# The default value is: NO.
4828+
4829+FORCE_LOCAL_INCLUDES = NO
4830+
4831+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
4832+# documentation for inline members.
4833+# The default value is: YES.
4834+
4835+INLINE_INFO = YES
4836+
4837+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
4838+# (detailed) documentation of file and class members alphabetically by member
4839+# name. If set to NO the members will appear in declaration order.
4840+# The default value is: YES.
4841+
4842+SORT_MEMBER_DOCS = YES
4843+
4844+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
4845+# descriptions of file, namespace and class members alphabetically by member
4846+# name. If set to NO the members will appear in declaration order. Note that
4847+# this will also influence the order of the classes in the class list.
4848+# The default value is: NO.
4849+
4850+SORT_BRIEF_DOCS = YES
4851+
4852+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
4853+# (brief and detailed) documentation of class members so that constructors and
4854+# destructors are listed first. If set to NO the constructors will appear in the
4855+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
4856+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
4857+# member documentation.
4858+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
4859+# detailed member documentation.
4860+# The default value is: NO.
4861+
4862+SORT_MEMBERS_CTORS_1ST = YES
4863+
4864+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
4865+# of group names into alphabetical order. If set to NO the group names will
4866+# appear in their defined order.
4867+# The default value is: NO.
4868+
4869+SORT_GROUP_NAMES = NO
4870+
4871+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
4872+# fully-qualified names, including namespaces. If set to NO, the class list will
4873+# be sorted only by class name, not including the namespace part.
4874+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
4875+# Note: This option applies only to the class list, not to the alphabetical
4876+# list.
4877+# The default value is: NO.
4878+
4879+SORT_BY_SCOPE_NAME = NO
4880+
4881+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
4882+# type resolution of all parameters of a function it will reject a match between
4883+# the prototype and the implementation of a member function even if there is
4884+# only one candidate or it is obvious which candidate to choose by doing a
4885+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
4886+# accept a match between prototype and implementation in such cases.
4887+# The default value is: NO.
4888+
4889+STRICT_PROTO_MATCHING = NO
4890+
4891+# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
4892+# todo list. This list is created by putting \todo commands in the
4893+# documentation.
4894+# The default value is: YES.
4895+
4896+GENERATE_TODOLIST = YES
4897+
4898+# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
4899+# test list. This list is created by putting \test commands in the
4900+# documentation.
4901+# The default value is: YES.
4902+
4903+GENERATE_TESTLIST = YES
4904+
4905+# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
4906+# list. This list is created by putting \bug commands in the documentation.
4907+# The default value is: YES.
4908+
4909+GENERATE_BUGLIST = YES
4910+
4911+# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
4912+# the deprecated list. This list is created by putting \deprecated commands in
4913+# the documentation.
4914+# The default value is: YES.
4915+
4916+GENERATE_DEPRECATEDLIST= YES
4917+
4918+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
4919+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
4920+# ... \endcond blocks.
4921+
4922+ENABLED_SECTIONS =
4923+
4924+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
4925+# initial value of a variable or macro / define can have for it to appear in the
4926+# documentation. If the initializer consists of more lines than specified here
4927+# it will be hidden. Use a value of 0 to hide initializers completely. The
4928+# appearance of the value of individual variables and macros / defines can be
4929+# controlled using \showinitializer or \hideinitializer command in the
4930+# documentation regardless of this setting.
4931+# Minimum value: 0, maximum value: 10000, default value: 30.
4932+
4933+MAX_INITIALIZER_LINES = 30
4934+
4935+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
4936+# the bottom of the documentation of classes and structs. If set to YES the list
4937+# will mention the files that were used to generate the documentation.
4938+# The default value is: YES.
4939+
4940+SHOW_USED_FILES = YES
4941+
4942+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
4943+# will remove the Files entry from the Quick Index and from the Folder Tree View
4944+# (if specified).
4945+# The default value is: YES.
4946+
4947+SHOW_FILES = YES
4948+
4949+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
4950+# page. This will remove the Namespaces entry from the Quick Index and from the
4951+# Folder Tree View (if specified).
4952+# The default value is: YES.
4953+
4954+SHOW_NAMESPACES = YES
4955+
4956+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
4957+# doxygen should invoke to get the current version for each file (typically from
4958+# the version control system). Doxygen will invoke the program by executing (via
4959+# popen()) the command command input-file, where command is the value of the
4960+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
4961+# by doxygen. Whatever the program writes to standard output is used as the file
4962+# version. For an example see the documentation.
4963+
4964+FILE_VERSION_FILTER =
4965+
4966+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
4967+# by doxygen. The layout file controls the global structure of the generated
4968+# output files in an output format independent way. To create the layout file
4969+# that represents doxygen's defaults, run doxygen with the -l option. You can
4970+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
4971+# will be used as the name of the layout file.
4972+#
4973+# Note that if you run doxygen from a directory containing a file called
4974+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
4975+# tag is left empty.
4976+
4977+LAYOUT_FILE =
4978+
4979+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
4980+# the reference definitions. This must be a list of .bib files. The .bib
4981+# extension is automatically appended if omitted. This requires the bibtex tool
4982+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
4983+# For LaTeX the style of the bibliography can be controlled using
4984+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
4985+# search path. Do not use file names with spaces, bibtex cannot handle them. See
4986+# also \cite for info how to create references.
4987+
4988+CITE_BIB_FILES =
4989+
4990+#---------------------------------------------------------------------------
4991+# Configuration options related to warning and progress messages
4992+#---------------------------------------------------------------------------
4993+
4994+# The QUIET tag can be used to turn on/off the messages that are generated to
4995+# standard output by doxygen. If QUIET is set to YES this implies that the
4996+# messages are off.
4997+# The default value is: NO.
4998+
4999+QUIET = NO
5000+
The diff has been truncated for viewing.

Subscribers

People subscribed via source and target branches

to all changes: