Merge lp:~unity-api-team/indicator-network/connectivity-service-bindings-docs into lp:indicator-network/14.10

Proposed by Antti Kaijanmäki
Status: Merged
Approved by: Charles Kerr
Approved revision: 406
Merged at revision: 406
Proposed branch: lp:~unity-api-team/indicator-network/connectivity-service-bindings-docs
Merge into: lp:indicator-network/14.10
Prerequisite: lp:~unity-api-team/indicator-network/connectivity-service-bindings
Diff against target: 7239 lines (+6310/-334)
61 files modified
CMakeLists.txt (+5/-4)
debian/connectivity-doc.install (+1/-1)
debian/control (+12/-10)
debian/copyright (+41/-36)
doc/CMakeLists.txt (+27/-0)
doc/dbus/connectivity-api.txt (+26/-0)
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 (+6/-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)
src/indicator/sim-unlock-dialog.cpp (+18/-0)
src/menumodel-cpp/action-group-exporter.h (+11/-12)
src/menumodel-cpp/action-group-merger.h (+11/-11)
src/menumodel-cpp/action-group.h (+11/-11)
src/menumodel-cpp/action.cpp (+11/-11)
src/menumodel-cpp/action.h (+11/-11)
src/menumodel-cpp/gio-helpers/util.cpp (+11/-11)
src/menumodel-cpp/gio-helpers/util.h (+11/-11)
src/menumodel-cpp/gio-helpers/variant.h (+11/-11)
src/menumodel-cpp/menu-exporter.h (+11/-11)
src/menumodel-cpp/menu-item.h (+11/-11)
src/menumodel-cpp/menu-merger.h (+11/-11)
src/menumodel-cpp/menu-model.h (+11/-12)
src/menumodel-cpp/menu.h (+11/-11)
src/notify-cpp/notification.cpp (+11/-11)
src/notify-cpp/notification.h (+11/-11)
src/notify-cpp/snapdecision/sim-unlock.cpp (+11/-11)
src/notify-cpp/snapdecision/sim-unlock.h (+11/-11)
src/qt/include/ubuntu/connectivity/NetworkingStatus (+0/-1)
src/qt/include/ubuntu/connectivity/networking-status.h (+54/-4)
src/qt/qml/Ubuntu/Connectivity/networking-status.h (+1/-1)
src/qt/src/CMakeLists.txt (+1/-2)
src/qt/src/networking-status.cpp (+1/-1)
src/url-dispatcher-cpp/url-dispatcher.cpp (+11/-11)
src/url-dispatcher-cpp/url-dispatcher.h (+11/-11)
tests/integration/qt/cpp/main.cpp (+10/-7)
tests/integration/qt/cpp/tst_networking.cpp (+1/-1)
tests/integration/qt/cpp/tst_networking.h (+0/-3)
tests/unit/menumodel-cpp/test-menu-exporter.cpp (+14/-13)
tests/utils/action-utils.cpp (+14/-13)
tests/utils/action-utils.h (+14/-13)
tests/utils/main.cpp (+14/-13)
To merge this branch: bzr merge lp:~unity-api-team/indicator-network/connectivity-service-bindings-docs
Reviewer Review Type Date Requested Status
Charles Kerr (community) Approve
PS Jenkins bot (community) continuous-integration Approve
Review via email: mp+230918@code.launchpad.net

Commit message

Documentation for the connectivity Qt C++ and QML API
Also fix licensing information.

To post a comment you must log in.
Revision history for this message
Antti Kaijanmäki (kaijanmaki) wrote :

This is a mere documentation branch. No actual code changes involded.
To test this branch, please check the contents of the produced .deb files and verify they are all populated and contain sane files.
Especially the connectivity-doc package is of interest.

Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)
Revision history for this message
Charles Kerr (charlesk) wrote :

I compared .debs using:

meld \
 <(dpkg -c build-area-trunk/indicator-network_0.5.1+14.10.20140808.2-0ubuntu1_i386.deb) \
 <(dpkg -c build-area-bindings-docs/indicator-network_0.5.1+14.10.20140808.2-0ubuntu1_i386.deb)

and all looks the same. LGTM

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'CMakeLists.txt'
--- CMakeLists.txt 2014-08-19 17:36:21 +0000
+++ CMakeLists.txt 2014-08-19 17:36:21 +0000
@@ -1,6 +1,8 @@
1project(indicator-network C CXX)1project(indicator-network C CXX)
2cmake_minimum_required(VERSION 2.8.9)2cmake_minimum_required(VERSION 2.8.9)
33
4string(TOLOWER "${CMAKE_BUILD_TYPE}" build_type_lower)
5
4set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake" "${CMAKE_MODULE_PATH}")6set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake" "${CMAKE_MODULE_PATH}")
57
6find_package(PkgConfig REQUIRED)8find_package(PkgConfig REQUIRED)
@@ -89,8 +91,7 @@
89include_directories(${CMAKE_BINARY_DIR})91include_directories(${CMAKE_BINARY_DIR})
9092
91set(COMMON_FLAGS "-Wall -Wextra -Wpedantic -fno-permissive")93set(COMMON_FLAGS "-Wall -Wextra -Wpedantic -fno-permissive")
92string(TOLOWER "${CMAKE_BUILD_TYPE}" BUILD_TYPE)94if(NOT build_type_lower MATCHES debug)
93if(NOT BUILD_TYPE MATCHES debug)
94 set(COMMON_FLAGS "${COMMON_FLAGS} -Werror")95 set(COMMON_FLAGS "${COMMON_FLAGS} -Werror")
95endif()96endif()
9697
@@ -112,7 +113,7 @@
112# * Find html report in subdir coveragereport113# * Find html report in subdir coveragereport
113# * Find xml report feasible for jenkins in coverage.xml114# * Find xml report feasible for jenkins in coverage.xml
114#####################################################################115#####################################################################
115IF(BUILD_TYPE MATCHES coverage)116IF(build_type_lower MATCHES coverage)
116 SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -ftest-coverage -fprofile-arcs" )117 SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -ftest-coverage -fprofile-arcs" )
117 SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -ftest-coverage -fprofile-arcs" )118 SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -ftest-coverage -fprofile-arcs" )
118 SET(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -ftest-coverage -fprofile-arcs" )119 SET(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -ftest-coverage -fprofile-arcs" )
@@ -124,9 +125,9 @@
124set(CONNECTIVITY_QT_VERSION_MINOR 0)125set(CONNECTIVITY_QT_VERSION_MINOR 0)
125set(CONNECTIVITY_QT_LIB_TARGET connectivity-qt${CONNECTIVITY_QT_VERSION_MAJOR})126set(CONNECTIVITY_QT_LIB_TARGET connectivity-qt${CONNECTIVITY_QT_VERSION_MAJOR})
126add_subdirectory(data)127add_subdirectory(data)
127#add_subdirectory(doc)
128add_subdirectory(src)128add_subdirectory(src)
129add_subdirectory(po)129add_subdirectory(po)
130add_subdirectory(doc)
130131
131enable_testing()132enable_testing()
132add_subdirectory(tests)133add_subdirectory(tests)
133134
=== modified file 'debian/connectivity-doc.install'
--- debian/connectivity-doc.install 2014-08-19 17:36:21 +0000
+++ debian/connectivity-doc.install 2014-08-19 17:36:21 +0000
@@ -1,1 +1,1 @@
1usr/share/doc/libconnectivity/*1usr/share/doc/connectivity-api/*
22
=== modified file 'debian/control'
--- debian/control 2014-08-19 17:36:21 +0000
+++ debian/control 2014-08-19 17:36:21 +0000
@@ -8,8 +8,10 @@
8# make g++ version explicit for ABI safety, see https://wiki.ubuntu.com/cpp-118# make g++ version explicit for ABI safety, see https://wiki.ubuntu.com/cpp-11
9 g++-4.9,9 g++-4.9,
10 debhelper (>= 9.0.0),10 debhelper (>= 9.0.0),
11 google-mock (>= 1.6.0+svn437),11 google-mock (>= 1.6.0+svn437),
12 doxygen,
12 dbus-test-runner,13 dbus-test-runner,
14 graphviz,
13 libconnectivity-cpp-dev (>=0.0.1+14.10.20140709),15 libconnectivity-cpp-dev (>=0.0.1+14.10.20140709),
14 libdbus-cpp-dev (>= 4.0.0),16 libdbus-cpp-dev (>= 4.0.0),
15 libglib2.0-dev,17 libglib2.0-dev,
@@ -104,12 +106,12 @@
104 .106 .
105 This package contains the qtdeclarative bindings for Ubuntu connectivity API.107 This package contains the qtdeclarative bindings for Ubuntu connectivity API.
106108
107#Package: connectivity-doc109Package: connectivity-doc
108#Section: doc110Section: doc
109#Architecture: all111Architecture: all
110#Depends: ${misc:Depends},112Depends: ${misc:Depends},
111# ${shlibs:Depends},113 ${shlibs:Depends},
112#Description: Unity Action API - documentation114Description: Unity Action API - documentation
113# Ubuntu Connectivity API115 Ubuntu Connectivity API
114# .116 .
115# This package contains developer documentation.117 This package contains developer documentation.
116118
=== modified file 'debian/copyright'
--- debian/copyright 2013-04-08 19:10:46 +0000
+++ debian/copyright 2014-08-19 17:36:21 +0000
@@ -1,42 +1,47 @@
1Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/1Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
22
3Files: *3Files: *
4Copyright: 2013 Canonical Ltd.4Copyright: 2014 Canonical Ltd.
5License: GPL-35License: GPL-3
66
7Files: secret-agent/*7Files: src/dbus-cpp/*
8Copyright: 2013 Canonical Ltd.8Copyright: 2014 Canonical Ltd.
9License: LGPL-39License: LGPL-3
1010
11License: GPL-311Files: src/notify-cpp/*
12 This program is free software: you can redistribute it and/or modify12Copyright: 2014 Canonical Ltd.
13 it under the terms of the GNU General Public License version 3, as13License: LGPL-3
14 published by the Free Software Foundation.14
15 .15Files: src/url-dispatcher-cpp/*
16 This program is distributed in the hope that it will be useful,16Copyright: 2014 Canonical Ltd.
17 but WITHOUT ANY WARRANTY; without even the implied warranty of17License: LGPL-3
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the18
19 GNU General Public License for more details.19Files: src/menumodel-cpp/*
20 .20Copyright: 2014 Canonical Ltd.
21 You should have received a copy of the GNU General Public License21License: LGPL-3
22 along with this program. If not, see <http://www.gnu.org/licenses/>22
23 .23Files: src/qt/*
24 On Debian systems, the complete text of the GNU General24Copyright: 2014 Canonical Ltd.
25 Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".25License: LGPL-3
2626
27License: LGPL-327Files: tests/integration/qt*
28 This package is free software; you can redistribute it and/or modify28Copyright: 2014 Canonical Ltd.
29 it under the terms of the GNU Lesser General Public License version 3,29License: LGPL-3
30 as published by the Free Software Foundation.30
31 .31Files: tests/menumodel-cpp/*
32 This package is distributed in the hope that it will be useful, but32Copyright: 2014 Canonical Ltd.
33 WITHOUT ANY WARRANTY; without even the implied warranty of33License: LGPL-3
34 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU34
35 Lesser General Public License for more details.35Files: tests/utils/*
36 .36Copyright: 2014 Canonical Ltd.
37 You should have received a copy of the GNU General Public License37License: LGPL-3
38 along with this program. If not, see <http://www.gnu.org/licenses/>38
39 .39License: GPL-3
40 On Debian systems the full text of the GNU General Public
41 License, version 3 can be found in the file
42 '/usr/share/common-licenses/GPL-3'.
43
44License: LGPL-3
40 On Debian systems the full text of the GNU Lesser General Public45 On Debian systems the full text of the GNU Lesser General Public
41 License, version 3 can be found in the file46 License, version 3 can be found in the file
42 '/usr/share/common-licenses/LGPL-3'.47 '/usr/share/common-licenses/LGPL-3'.
4348
=== added directory 'doc'
=== added file 'doc/CMakeLists.txt'
--- doc/CMakeLists.txt 1970-01-01 00:00:00 +0000
+++ doc/CMakeLists.txt 2014-08-19 17:36:21 +0000
@@ -0,0 +1,27 @@
1set(INSTALL_DOCDIR ${CMAKE_INSTALL_DATAROOTDIR}/doc/connectivity-api)
2
3if(build_type_lower MATCHES debug)
4 option(BUILD_DOC "Build documentation by default" FALSE)
5else()
6 option(BUILD_DOC "Build documentation by default" TRUE)
7endif()
8option(PRIVATE_DOCS "Build private documentation" FALSE)
9
10if(${BUILD_DOC})
11 set(IS_ALL ALL)
12endif()
13
14add_subdirectory(qt)
15set(DBUS_FILES
16 dbus/connectivity-api.txt
17)
18
19add_custom_target(doc ${IS_ALL}
20 SOURCES ${DBUS_FILES}
21)
22add_dependencies(doc cppdoc qmldoc)
23
24install(
25 DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/dbus/
26 DESTINATION ${INSTALL_DOCDIR}/dbus/
27)
028
=== added directory 'doc/dbus'
=== added file 'doc/dbus/connectivity-api.txt'
--- doc/dbus/connectivity-api.txt 1970-01-01 00:00:00 +0000
+++ doc/dbus/connectivity-api.txt 2014-08-19 17:36:21 +0000
@@ -0,0 +1,26 @@
1Service com.ubuntu.connectivity1
2Interface com.ubuntu.connectivity1.NetworkingStatus
3Object path /com/ubuntu/connectivity1/NetworkingStatus
4Policy group connectivity
5Supports org.freedesktop.DBus.Introspectable
6 org.freedesktop.DBus.Properties
7
8Properties array{string} Limitations [readonly]
9
10 String array representing the possible limitations
11 on networking.
12
13 Currently available limitations are:
14 "bandwith"
15
16 "bandwith" - indicates that the bandwith of the
17 Internet connection has limitations.
18 Applications should minimize their bandwith
19 usage if possible.
20
21 string Status [readonly]
22
23 Status of the Internet connectivity.
24
25 Possible values:
26 "offline", "connecting", "online"
027
=== added directory 'doc/qt'
=== added file 'doc/qt/CMakeLists.txt'
--- doc/qt/CMakeLists.txt 1970-01-01 00:00:00 +0000
+++ doc/qt/CMakeLists.txt 2014-08-19 17:36:21 +0000
@@ -0,0 +1,3 @@
1add_subdirectory(cpp)
2add_subdirectory(qml)
3
04
=== added directory 'doc/qt/cpp'
=== added file 'doc/qt/cpp/CMakeLists.txt'
--- doc/qt/cpp/CMakeLists.txt 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/CMakeLists.txt 2014-08-19 17:36:21 +0000
@@ -0,0 +1,40 @@
1add_subdirectory(examples)
2
3set(EXTRACT_PRIVATE NO)
4set(INTERNAL_DOCS NO)
5set(SOURCE_DIRS "${CMAKE_SOURCE_DIR}/src/qt/include ${CMAKE_CURRENT_SOURCE_DIR}")
6
7if(${PRIVATE_DOCS})
8 set(EXTRACT_PRIVATE YES)
9 set(INTERNAL_DOCS YES)
10 set(SOURCE_DIRS "${SOURCE_DIRS} ${CMAKE_SOURCE_DIR}/src")
11endif()
12
13set(DOC_FILES
14 Doxyfile.in
15 pages/mainpage.dox
16 pages/using.dox
17 pages/networking-status.dox
18)
19
20find_package(Doxygen)
21if(DOXYGEN_FOUND)
22 configure_file(
23 ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
24 ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY
25 )
26 add_custom_target(cppdoc
27 ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
28 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
29 COMMENT "Generating API documentation with Doxygen" VERBATIM
30 SOURCES ${DOC_FILES}
31 )
32 install(
33 DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
34 DESTINATION ${INSTALL_DOCDIR}/cpp/
35 )
36 install(
37 DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/xml
38 DESTINATION ${INSTALL_DOCDIR}/cpp/
39 )
40endif(DOXYGEN_FOUND)
041
=== added file 'doc/qt/cpp/Doxyfile.in'
--- doc/qt/cpp/Doxyfile.in 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/Doxyfile.in 2014-08-19 17:36:21 +0000
@@ -0,0 +1,2316 @@
1# Doxyfile 1.8.7
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
5#
6# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
10# The format is:
11# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
15
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
20# This tag specifies the encoding used for all characters in the config file
21# that follow. The default is UTF-8 which is also the encoding used for all text
22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24# for the list of possible encodings.
25# The default value is: UTF-8.
26
27DOXYFILE_ENCODING = UTF-8
28
29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
34
35PROJECT_NAME = "Ubuntu Connectivity Qt API"
36
37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38# could be handy for archiving the generated documentation or if some version
39# control system is used.
40
41PROJECT_NUMBER = @CONNECTIVITY_QT_VERSION_MAJOR@.@CONNECTIVITY_QT_VERSION_MINOR@
42
43# Using the PROJECT_BRIEF tag one can provide an optional one line description
44# for a project that appears at the top of each page and should give viewer a
45# quick idea about the purpose of the project. Keep the description short.
46
47PROJECT_BRIEF =
48
49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50# the documentation. The maximum height of the logo should not exceed 55 pixels
51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52# to the output directory.
53
54PROJECT_LOGO =
55
56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57# into which the generated documentation will be written. If a relative path is
58# entered, it will be relative to the location where doxygen was started. If
59# left blank the current directory will be used.
60
61OUTPUT_DIRECTORY =
62
63# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64# directories (in 2 levels) under the output directory of each output format and
65# will distribute the generated files over these directories. Enabling this
66# option can be useful when feeding doxygen a huge amount of source files, where
67# putting all generated files in the same directory would otherwise causes
68# performance problems for the file system.
69# The default value is: NO.
70
71CREATE_SUBDIRS = NO
72
73# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74# characters to appear in the names of generated files. If set to NO, non-ASCII
75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76# U+3044.
77# The default value is: NO.
78
79ALLOW_UNICODE_NAMES = NO
80
81# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82# documentation generated by doxygen is written. Doxygen will use this
83# information to generate all constant output in the proper language.
84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91# Ukrainian and Vietnamese.
92# The default value is: English.
93
94OUTPUT_LANGUAGE = English
95
96# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
97# descriptions after the members that are listed in the file and class
98# documentation (similar to Javadoc). Set to NO to disable this.
99# The default value is: YES.
100
101BRIEF_MEMBER_DESC = YES
102
103# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
104# description of a member or function before the detailed description
105#
106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107# brief descriptions will be completely suppressed.
108# The default value is: YES.
109
110REPEAT_BRIEF = YES
111
112# This tag implements a quasi-intelligent brief description abbreviator that is
113# used to form the text in various listings. Each string in this list, if found
114# as the leading text of the brief description, will be stripped from the text
115# and the result, after processing the whole list, is used as the annotated
116# text. Otherwise, the brief description is used as-is. If left blank, the
117# following values are used ($name is automatically replaced with the name of
118# the entity):The $name class, The $name widget, The $name file, is, provides,
119# specifies, contains, represents, a, an and the.
120
121ABBREVIATE_BRIEF =
122
123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124# doxygen will generate a detailed section even if there is only a brief
125# description.
126# The default value is: NO.
127
128ALWAYS_DETAILED_SEC = NO
129
130# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131# inherited members of a class in the documentation of that class as if those
132# members were ordinary class members. Constructors, destructors and assignment
133# operators of the base classes will not be shown.
134# The default value is: NO.
135
136INLINE_INHERITED_MEMB = NO
137
138# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
139# before files name in the file list and in the header files. If set to NO the
140# shortest path that makes the file name unique will be used
141# The default value is: YES.
142
143FULL_PATH_NAMES = NO
144
145# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146# Stripping is only done if one of the specified strings matches the left-hand
147# part of the path. The tag can be used to show relative paths in the file list.
148# If left blank the directory from which doxygen is run is used as the path to
149# strip.
150#
151# Note that you can specify absolute paths here, but also relative paths, which
152# will be relative from the directory where doxygen is started.
153# This tag requires that the tag FULL_PATH_NAMES is set to YES.
154
155STRIP_FROM_PATH =
156
157# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158# path mentioned in the documentation of a class, which tells the reader which
159# header file to include in order to use a class. If left blank only the name of
160# the header file containing the class definition is used. Otherwise one should
161# specify the list of include paths that are normally passed to the compiler
162# using the -I flag.
163
164STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/src/qt/include
165
166# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167# less readable) file names. This can be useful is your file systems doesn't
168# support long names like on DOS, Mac, or CD-ROM.
169# The default value is: NO.
170
171SHORT_NAMES = NO
172
173# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174# first line (until the first dot) of a Javadoc-style comment as the brief
175# description. If set to NO, the Javadoc-style will behave just like regular Qt-
176# style comments (thus requiring an explicit @brief command for a brief
177# description.)
178# The default value is: NO.
179
180JAVADOC_AUTOBRIEF = NO
181
182# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183# line (until the first dot) of a Qt-style comment as the brief description. If
184# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185# requiring an explicit \brief command for a brief description.)
186# The default value is: NO.
187
188QT_AUTOBRIEF = NO
189
190# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192# a brief description. This used to be the default behavior. The new default is
193# to treat a multi-line C++ comment block as a detailed description. Set this
194# tag to YES if you prefer the old behavior instead.
195#
196# Note that setting this tag to YES also means that rational rose comments are
197# not recognized any more.
198# The default value is: NO.
199
200MULTILINE_CPP_IS_BRIEF = NO
201
202# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203# documentation from any documented member that it re-implements.
204# The default value is: YES.
205
206INHERIT_DOCS = YES
207
208# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
209# new page for each member. If set to NO, the documentation of a member will be
210# part of the file/class/namespace that contains it.
211# The default value is: NO.
212
213SEPARATE_MEMBER_PAGES = NO
214
215# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216# uses this value to replace tabs by spaces in code fragments.
217# Minimum value: 1, maximum value: 16, default value: 4.
218
219TAB_SIZE = 4
220
221# This tag can be used to specify a number of aliases that act as commands in
222# the documentation. An alias has the form:
223# name=value
224# For example adding
225# "sideeffect=@par Side Effects:\n"
226# will allow you to put the command \sideeffect (or @sideeffect) in the
227# documentation, which will result in a user-defined paragraph with heading
228# "Side Effects:". You can put \n's in the value part of an alias to insert
229# newlines.
230
231ALIASES = "accessors=\par Accessors:\n" \
232 "initvalue=\par Initial Value:\n" \
233 "notify=\par Notify:\n"
234
235# This tag can be used to specify a number of word-keyword mappings (TCL only).
236# A mapping has the form "name=value". For example adding "class=itcl::class"
237# will allow you to use the command class in the itcl::class meaning.
238
239TCL_SUBST =
240
241# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
242# only. Doxygen will then generate output that is more tailored for C. For
243# instance, some of the names that are used will be different. The list of all
244# members will be omitted, etc.
245# The default value is: NO.
246
247OPTIMIZE_OUTPUT_FOR_C = NO
248
249# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
250# Python sources only. Doxygen will then generate output that is more tailored
251# for that language. For instance, namespaces will be presented as packages,
252# qualified scopes will look different, etc.
253# The default value is: NO.
254
255OPTIMIZE_OUTPUT_JAVA = NO
256
257# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
258# sources. Doxygen will then generate output that is tailored for Fortran.
259# The default value is: NO.
260
261OPTIMIZE_FOR_FORTRAN = NO
262
263# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
264# sources. Doxygen will then generate output that is tailored for VHDL.
265# The default value is: NO.
266
267OPTIMIZE_OUTPUT_VHDL = NO
268
269# Doxygen selects the parser to use depending on the extension of the files it
270# parses. With this tag you can assign which parser to use for a given
271# extension. Doxygen has a built-in mapping, but you can override or extend it
272# using this tag. The format is ext=language, where ext is a file extension, and
273# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
274# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
275# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
276# Fortran. In the later case the parser tries to guess whether the code is fixed
277# or free formatted code, this is the default for Fortran type files), VHDL. For
278# instance to make doxygen treat .inc files as Fortran files (default is PHP),
279# and .f files as C (default is Fortran), use: inc=Fortran f=C.
280#
281# Note For files without extension you can use no_extension as a placeholder.
282#
283# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
284# the files are not read by doxygen.
285
286EXTENSION_MAPPING =
287
288# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
289# according to the Markdown format, which allows for more readable
290# documentation. See http://daringfireball.net/projects/markdown/ for details.
291# The output of markdown processing is further processed by doxygen, so you can
292# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
293# case of backward compatibilities issues.
294# The default value is: YES.
295
296MARKDOWN_SUPPORT = YES
297
298# When enabled doxygen tries to link words that correspond to documented
299# classes, or namespaces to their corresponding documentation. Such a link can
300# be prevented in individual cases by by putting a % sign in front of the word
301# or globally by setting AUTOLINK_SUPPORT to NO.
302# The default value is: YES.
303
304AUTOLINK_SUPPORT = YES
305
306# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
307# to include (a tag file for) the STL sources as input, then you should set this
308# tag to YES in order to let doxygen match functions declarations and
309# definitions whose arguments contain STL classes (e.g. func(std::string);
310# versus func(std::string) {}). This also make the inheritance and collaboration
311# diagrams that involve STL classes more complete and accurate.
312# The default value is: NO.
313
314BUILTIN_STL_SUPPORT = YES
315
316# If you use Microsoft's C++/CLI language, you should set this option to YES to
317# enable parsing support.
318# The default value is: NO.
319
320CPP_CLI_SUPPORT = NO
321
322# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
323# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
324# will parse them like normal C++ but will assume all classes use public instead
325# of private inheritance when no explicit protection keyword is present.
326# The default value is: NO.
327
328SIP_SUPPORT = NO
329
330# For Microsoft's IDL there are propget and propput attributes to indicate
331# getter and setter methods for a property. Setting this option to YES will make
332# doxygen to replace the get and set methods by a property in the documentation.
333# This will only work if the methods are indeed getting or setting a simple
334# type. If this is not the case, or you want to show the methods anyway, you
335# should set this option to NO.
336# The default value is: YES.
337
338IDL_PROPERTY_SUPPORT = YES
339
340# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
341# tag is set to YES, then doxygen will reuse the documentation of the first
342# member in the group (if any) for the other members of the group. By default
343# all members of a group must be documented explicitly.
344# The default value is: NO.
345
346DISTRIBUTE_GROUP_DOC = NO
347
348# Set the SUBGROUPING tag to YES to allow class member groups of the same type
349# (for instance a group of public functions) to be put as a subgroup of that
350# type (e.g. under the Public Functions section). Set it to NO to prevent
351# subgrouping. Alternatively, this can be done per class using the
352# \nosubgrouping command.
353# The default value is: YES.
354
355SUBGROUPING = YES
356
357# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
358# are shown inside the group in which they are included (e.g. using \ingroup)
359# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
360# and RTF).
361#
362# Note that this feature does not work in combination with
363# SEPARATE_MEMBER_PAGES.
364# The default value is: NO.
365
366INLINE_GROUPED_CLASSES = NO
367
368# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
369# with only public data fields or simple typedef fields will be shown inline in
370# the documentation of the scope in which they are defined (i.e. file,
371# namespace, or group documentation), provided this scope is documented. If set
372# to NO, structs, classes, and unions are shown on a separate page (for HTML and
373# Man pages) or section (for LaTeX and RTF).
374# The default value is: NO.
375
376INLINE_SIMPLE_STRUCTS = NO
377
378# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
379# enum is documented as struct, union, or enum with the name of the typedef. So
380# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
381# with name TypeT. When disabled the typedef will appear as a member of a file,
382# namespace, or class. And the struct will be named TypeS. This can typically be
383# useful for C code in case the coding convention dictates that all compound
384# types are typedef'ed and only the typedef is referenced, never the tag name.
385# The default value is: NO.
386
387TYPEDEF_HIDES_STRUCT = NO
388
389# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
390# cache is used to resolve symbols given their name and scope. Since this can be
391# an expensive process and often the same symbol appears multiple times in the
392# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
393# doxygen will become slower. If the cache is too large, memory is wasted. The
394# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
395# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
396# symbols. At the end of a run doxygen will report the cache usage and suggest
397# the optimal cache size from a speed point of view.
398# Minimum value: 0, maximum value: 9, default value: 0.
399
400LOOKUP_CACHE_SIZE = 0
401
402#---------------------------------------------------------------------------
403# Build related configuration options
404#---------------------------------------------------------------------------
405
406# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
407# documentation are documented, even if no documentation was available. Private
408# class members and static file members will be hidden unless the
409# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
410# Note: This will also disable the warnings about undocumented members that are
411# normally produced when WARNINGS is set to YES.
412# The default value is: NO.
413
414EXTRACT_ALL = YES
415
416# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
417# be included in the documentation.
418# The default value is: NO.
419
420EXTRACT_PRIVATE = @EXTRACT_PRIVATE@
421
422# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
423# scope will be included in the documentation.
424# The default value is: NO.
425
426EXTRACT_PACKAGE = NO
427
428# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
429# included in the documentation.
430# The default value is: NO.
431
432EXTRACT_STATIC = YES
433
434# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
435# locally in source files will be included in the documentation. If set to NO
436# only classes defined in header files are included. Does not have any effect
437# for Java sources.
438# The default value is: YES.
439
440EXTRACT_LOCAL_CLASSES = YES
441
442# This flag is only useful for Objective-C code. When set to YES local methods,
443# which are defined in the implementation section but not in the interface are
444# included in the documentation. If set to NO only methods in the interface are
445# included.
446# The default value is: NO.
447
448EXTRACT_LOCAL_METHODS = NO
449
450# If this flag is set to YES, the members of anonymous namespaces will be
451# extracted and appear in the documentation as a namespace called
452# 'anonymous_namespace{file}', where file will be replaced with the base name of
453# the file that contains the anonymous namespace. By default anonymous namespace
454# are hidden.
455# The default value is: NO.
456
457EXTRACT_ANON_NSPACES = NO
458
459# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
460# undocumented members inside documented classes or files. If set to NO these
461# members will be included in the various overviews, but no documentation
462# section is generated. This option has no effect if EXTRACT_ALL is enabled.
463# The default value is: NO.
464
465HIDE_UNDOC_MEMBERS = NO
466
467# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
468# undocumented classes that are normally visible in the class hierarchy. If set
469# to NO these classes will be included in the various overviews. This option has
470# no effect if EXTRACT_ALL is enabled.
471# The default value is: NO.
472
473HIDE_UNDOC_CLASSES = NO
474
475# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
476# (class|struct|union) declarations. If set to NO these declarations will be
477# included in the documentation.
478# The default value is: NO.
479
480HIDE_FRIEND_COMPOUNDS = YES
481
482# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
483# documentation blocks found inside the body of a function. If set to NO these
484# blocks will be appended to the function's detailed documentation block.
485# The default value is: NO.
486
487HIDE_IN_BODY_DOCS = NO
488
489# The INTERNAL_DOCS tag determines if documentation that is typed after a
490# \internal command is included. If the tag is set to NO then the documentation
491# will be excluded. Set it to YES to include the internal documentation.
492# The default value is: NO.
493
494INTERNAL_DOCS = @INTERNAL_DOCS@
495
496# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
497# names in lower-case letters. If set to YES upper-case letters are also
498# allowed. This is useful if you have classes or files whose names only differ
499# in case and if your file system supports case sensitive file names. Windows
500# and Mac users are advised to set this option to NO.
501# The default value is: system dependent.
502
503CASE_SENSE_NAMES = YES
504
505# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
506# their full class and namespace scopes in the documentation. If set to YES the
507# scope will be hidden.
508# The default value is: NO.
509
510HIDE_SCOPE_NAMES = NO
511
512# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
513# the files that are included by a file in the documentation of that file.
514# The default value is: YES.
515
516SHOW_INCLUDE_FILES = YES
517
518# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
519# grouped member an include statement to the documentation, telling the reader
520# which file to include in order to use the member.
521# The default value is: NO.
522
523SHOW_GROUPED_MEMB_INC = NO
524
525# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
526# files with double quotes in the documentation rather than with sharp brackets.
527# The default value is: NO.
528
529FORCE_LOCAL_INCLUDES = NO
530
531# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
532# documentation for inline members.
533# The default value is: YES.
534
535INLINE_INFO = YES
536
537# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
538# (detailed) documentation of file and class members alphabetically by member
539# name. If set to NO the members will appear in declaration order.
540# The default value is: YES.
541
542SORT_MEMBER_DOCS = YES
543
544# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
545# descriptions of file, namespace and class members alphabetically by member
546# name. If set to NO the members will appear in declaration order. Note that
547# this will also influence the order of the classes in the class list.
548# The default value is: NO.
549
550SORT_BRIEF_DOCS = YES
551
552# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
553# (brief and detailed) documentation of class members so that constructors and
554# destructors are listed first. If set to NO the constructors will appear in the
555# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
556# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
557# member documentation.
558# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
559# detailed member documentation.
560# The default value is: NO.
561
562SORT_MEMBERS_CTORS_1ST = YES
563
564# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
565# of group names into alphabetical order. If set to NO the group names will
566# appear in their defined order.
567# The default value is: NO.
568
569SORT_GROUP_NAMES = NO
570
571# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
572# fully-qualified names, including namespaces. If set to NO, the class list will
573# be sorted only by class name, not including the namespace part.
574# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
575# Note: This option applies only to the class list, not to the alphabetical
576# list.
577# The default value is: NO.
578
579SORT_BY_SCOPE_NAME = NO
580
581# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
582# type resolution of all parameters of a function it will reject a match between
583# the prototype and the implementation of a member function even if there is
584# only one candidate or it is obvious which candidate to choose by doing a
585# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
586# accept a match between prototype and implementation in such cases.
587# The default value is: NO.
588
589STRICT_PROTO_MATCHING = NO
590
591# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
592# todo list. This list is created by putting \todo commands in the
593# documentation.
594# The default value is: YES.
595
596GENERATE_TODOLIST = YES
597
598# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
599# test list. This list is created by putting \test commands in the
600# documentation.
601# The default value is: YES.
602
603GENERATE_TESTLIST = YES
604
605# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
606# list. This list is created by putting \bug commands in the documentation.
607# The default value is: YES.
608
609GENERATE_BUGLIST = YES
610
611# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
612# the deprecated list. This list is created by putting \deprecated commands in
613# the documentation.
614# The default value is: YES.
615
616GENERATE_DEPRECATEDLIST= YES
617
618# The ENABLED_SECTIONS tag can be used to enable conditional documentation
619# sections, marked by \if <section_label> ... \endif and \cond <section_label>
620# ... \endcond blocks.
621
622ENABLED_SECTIONS =
623
624# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
625# initial value of a variable or macro / define can have for it to appear in the
626# documentation. If the initializer consists of more lines than specified here
627# it will be hidden. Use a value of 0 to hide initializers completely. The
628# appearance of the value of individual variables and macros / defines can be
629# controlled using \showinitializer or \hideinitializer command in the
630# documentation regardless of this setting.
631# Minimum value: 0, maximum value: 10000, default value: 30.
632
633MAX_INITIALIZER_LINES = 30
634
635# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
636# the bottom of the documentation of classes and structs. If set to YES the list
637# will mention the files that were used to generate the documentation.
638# The default value is: YES.
639
640SHOW_USED_FILES = YES
641
642# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
643# will remove the Files entry from the Quick Index and from the Folder Tree View
644# (if specified).
645# The default value is: YES.
646
647SHOW_FILES = YES
648
649# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
650# page. This will remove the Namespaces entry from the Quick Index and from the
651# Folder Tree View (if specified).
652# The default value is: YES.
653
654SHOW_NAMESPACES = YES
655
656# The FILE_VERSION_FILTER tag can be used to specify a program or script that
657# doxygen should invoke to get the current version for each file (typically from
658# the version control system). Doxygen will invoke the program by executing (via
659# popen()) the command command input-file, where command is the value of the
660# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
661# by doxygen. Whatever the program writes to standard output is used as the file
662# version. For an example see the documentation.
663
664FILE_VERSION_FILTER =
665
666# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
667# by doxygen. The layout file controls the global structure of the generated
668# output files in an output format independent way. To create the layout file
669# that represents doxygen's defaults, run doxygen with the -l option. You can
670# optionally specify a file name after the option, if omitted DoxygenLayout.xml
671# will be used as the name of the layout file.
672#
673# Note that if you run doxygen from a directory containing a file called
674# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
675# tag is left empty.
676
677LAYOUT_FILE =
678
679# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
680# the reference definitions. This must be a list of .bib files. The .bib
681# extension is automatically appended if omitted. This requires the bibtex tool
682# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
683# For LaTeX the style of the bibliography can be controlled using
684# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
685# search path. Do not use file names with spaces, bibtex cannot handle them. See
686# also \cite for info how to create references.
687
688CITE_BIB_FILES =
689
690#---------------------------------------------------------------------------
691# Configuration options related to warning and progress messages
692#---------------------------------------------------------------------------
693
694# The QUIET tag can be used to turn on/off the messages that are generated to
695# standard output by doxygen. If QUIET is set to YES this implies that the
696# messages are off.
697# The default value is: NO.
698
699QUIET = NO
700
701# The WARNINGS tag can be used to turn on/off the warning messages that are
702# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
703# this implies that the warnings are on.
704#
705# Tip: Turn warnings on while writing the documentation.
706# The default value is: YES.
707
708WARNINGS = YES
709
710# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
711# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
712# will automatically be disabled.
713# The default value is: YES.
714
715WARN_IF_UNDOCUMENTED = YES
716
717# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
718# potential errors in the documentation, such as not documenting some parameters
719# in a documented function, or documenting parameters that don't exist or using
720# markup commands wrongly.
721# The default value is: YES.
722
723WARN_IF_DOC_ERROR = YES
724
725# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
726# are documented, but have no documentation for their parameters or return
727# value. If set to NO doxygen will only warn about wrong or incomplete parameter
728# documentation, but not about the absence of documentation.
729# The default value is: NO.
730
731WARN_NO_PARAMDOC = YES
732
733# The WARN_FORMAT tag determines the format of the warning messages that doxygen
734# can produce. The string should contain the $file, $line, and $text tags, which
735# will be replaced by the file and line number from which the warning originated
736# and the warning text. Optionally the format may contain $version, which will
737# be replaced by the version of the file (if it could be obtained via
738# FILE_VERSION_FILTER)
739# The default value is: $file:$line: $text.
740
741WARN_FORMAT = "$file:$line: $text"
742
743# The WARN_LOGFILE tag can be used to specify a file to which warning and error
744# messages should be written. If left blank the output is written to standard
745# error (stderr).
746
747WARN_LOGFILE =
748
749#---------------------------------------------------------------------------
750# Configuration options related to the input files
751#---------------------------------------------------------------------------
752
753# The INPUT tag is used to specify the files and/or directories that contain
754# documented source files. You may enter file names like myfile.cpp or
755# directories like /usr/src/myproject. Separate the files or directories with
756# spaces.
757# Note: If this tag is empty the current directory is searched.
758
759INPUT = @CMAKE_SOURCE_DIR@/src/qt/include \
760 @CMAKE_CURRENT_SOURCE_DIR@/pages
761
762# This tag can be used to specify the character encoding of the source files
763# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
764# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
765# documentation (see: http://www.gnu.org/software/libiconv) for the list of
766# possible encodings.
767# The default value is: UTF-8.
768
769INPUT_ENCODING = UTF-8
770
771# If the value of the INPUT tag contains directories, you can use the
772# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
773# *.h) to filter out the source-files in the directories. If left blank the
774# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
775# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
776# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
777# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
778# *.qsf, *.as and *.js.
779
780FILE_PATTERNS =
781
782# The RECURSIVE tag can be used to specify whether or not subdirectories should
783# be searched for input files as well.
784# The default value is: NO.
785
786RECURSIVE = YES
787
788# The EXCLUDE tag can be used to specify files and/or directories that should be
789# excluded from the INPUT source files. This way you can easily exclude a
790# subdirectory from a directory tree whose root is specified with the INPUT tag.
791#
792# Note that relative paths are relative to the directory from which doxygen is
793# run.
794
795EXCLUDE =
796
797# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
798# directories that are symbolic links (a Unix file system feature) are excluded
799# from the input.
800# The default value is: NO.
801
802EXCLUDE_SYMLINKS = NO
803
804# If the value of the INPUT tag contains directories, you can use the
805# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
806# certain files from those directories.
807#
808# Note that the wildcards are matched against the file with absolute path, so to
809# exclude all test directories for example use the pattern */test/*
810
811EXCLUDE_PATTERNS =
812
813# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
814# (namespaces, classes, functions, etc.) that should be excluded from the
815# output. The symbol name can be a fully qualified name, a word, or if the
816# wildcard * is used, a substring. Examples: ANamespace, AClass,
817# AClass::ANamespace, ANamespace::*Test
818#
819# Note that the wildcards are matched against the file with absolute path, so to
820# exclude all test directories use the pattern */test/*
821
822EXCLUDE_SYMBOLS =
823
824# The EXAMPLE_PATH tag can be used to specify one or more files or directories
825# that contain example code fragments that are included (see the \include
826# command).
827
828EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples
829
830# If the value of the EXAMPLE_PATH tag contains directories, you can use the
831# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
832# *.h) to filter out the source-files in the directories. If left blank all
833# files are included.
834
835EXAMPLE_PATTERNS =
836
837# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
838# searched for input files to be used with the \include or \dontinclude commands
839# irrespective of the value of the RECURSIVE tag.
840# The default value is: NO.
841
842EXAMPLE_RECURSIVE = YES
843
844# The IMAGE_PATH tag can be used to specify one or more files or directories
845# that contain images that are to be included in the documentation (see the
846# \image command).
847
848IMAGE_PATH =
849
850# The INPUT_FILTER tag can be used to specify a program that doxygen should
851# invoke to filter for each input file. Doxygen will invoke the filter program
852# by executing (via popen()) the command:
853#
854# <filter> <input-file>
855#
856# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
857# name of an input file. Doxygen will then use the output that the filter
858# program writes to standard output. If FILTER_PATTERNS is specified, this tag
859# will be ignored.
860#
861# Note that the filter must not add or remove lines; it is applied before the
862# code is scanned, but not when the output code is generated. If lines are added
863# or removed, the anchors will not be placed correctly.
864
865INPUT_FILTER =
866
867# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
868# basis. Doxygen will compare the file name with each pattern and apply the
869# filter if there is a match. The filters are a list of the form: pattern=filter
870# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
871# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
872# patterns match the file name, INPUT_FILTER is applied.
873
874FILTER_PATTERNS =
875
876# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
877# INPUT_FILTER ) will also be used to filter the input files that are used for
878# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
879# The default value is: NO.
880
881FILTER_SOURCE_FILES = NO
882
883# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
884# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
885# it is also possible to disable source filtering for a specific pattern using
886# *.ext= (so without naming a filter).
887# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
888
889FILTER_SOURCE_PATTERNS =
890
891# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
892# is part of the input, its contents will be placed on the main page
893# (index.html). This can be useful if you have a project on for instance GitHub
894# and want to reuse the introduction page also for the doxygen output.
895
896USE_MDFILE_AS_MAINPAGE =
897
898#---------------------------------------------------------------------------
899# Configuration options related to source browsing
900#---------------------------------------------------------------------------
901
902# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
903# generated. Documented entities will be cross-referenced with these sources.
904#
905# Note: To get rid of all source code in the generated output, make sure that
906# also VERBATIM_HEADERS is set to NO.
907# The default value is: NO.
908
909SOURCE_BROWSER = YES
910
911# Setting the INLINE_SOURCES tag to YES will include the body of functions,
912# classes and enums directly into the documentation.
913# The default value is: NO.
914
915INLINE_SOURCES = NO
916
917# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
918# special comment blocks from generated source code fragments. Normal C, C++ and
919# Fortran comments will always remain visible.
920# The default value is: YES.
921
922STRIP_CODE_COMMENTS = YES
923
924# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
925# function all documented functions referencing it will be listed.
926# The default value is: NO.
927
928REFERENCED_BY_RELATION = YES
929
930# If the REFERENCES_RELATION tag is set to YES then for each documented function
931# all documented entities called/used by that function will be listed.
932# The default value is: NO.
933
934REFERENCES_RELATION = YES
935
936# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
937# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
938# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
939# link to the documentation.
940# The default value is: YES.
941
942REFERENCES_LINK_SOURCE = YES
943
944# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
945# source code will show a tooltip with additional information such as prototype,
946# brief description and links to the definition and documentation. Since this
947# will make the HTML file larger and loading of large files a bit slower, you
948# can opt to disable this feature.
949# The default value is: YES.
950# This tag requires that the tag SOURCE_BROWSER is set to YES.
951
952SOURCE_TOOLTIPS = YES
953
954# If the USE_HTAGS tag is set to YES then the references to source code will
955# point to the HTML generated by the htags(1) tool instead of doxygen built-in
956# source browser. The htags tool is part of GNU's global source tagging system
957# (see http://www.gnu.org/software/global/global.html). You will need version
958# 4.8.6 or higher.
959#
960# To use it do the following:
961# - Install the latest version of global
962# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
963# - Make sure the INPUT points to the root of the source tree
964# - Run doxygen as normal
965#
966# Doxygen will invoke htags (and that will in turn invoke gtags), so these
967# tools must be available from the command line (i.e. in the search path).
968#
969# The result: instead of the source browser generated by doxygen, the links to
970# source code will now point to the output of htags.
971# The default value is: NO.
972# This tag requires that the tag SOURCE_BROWSER is set to YES.
973
974USE_HTAGS = NO
975
976# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
977# verbatim copy of the header file for each class for which an include is
978# specified. Set to NO to disable this.
979# See also: Section \class.
980# The default value is: YES.
981
982VERBATIM_HEADERS = YES
983
984#---------------------------------------------------------------------------
985# Configuration options related to the alphabetical class index
986#---------------------------------------------------------------------------
987
988# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
989# compounds will be generated. Enable this if the project contains a lot of
990# classes, structs, unions or interfaces.
991# The default value is: YES.
992
993ALPHABETICAL_INDEX = YES
994
995# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
996# which the alphabetical index list will be split.
997# Minimum value: 1, maximum value: 20, default value: 5.
998# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
999
1000COLS_IN_ALPHA_INDEX = 5
1001
1002# In case all classes in a project start with a common prefix, all classes will
1003# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1004# can be used to specify a prefix (or a list of prefixes) that should be ignored
1005# while generating the index headers.
1006# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1007
1008IGNORE_PREFIX =
1009
1010#---------------------------------------------------------------------------
1011# Configuration options related to the HTML output
1012#---------------------------------------------------------------------------
1013
1014# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1015# The default value is: YES.
1016
1017GENERATE_HTML = YES
1018
1019# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1020# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1021# it.
1022# The default directory is: html.
1023# This tag requires that the tag GENERATE_HTML is set to YES.
1024
1025HTML_OUTPUT = html
1026
1027# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1028# generated HTML page (for example: .htm, .php, .asp).
1029# The default value is: .html.
1030# This tag requires that the tag GENERATE_HTML is set to YES.
1031
1032HTML_FILE_EXTENSION = .html
1033
1034# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1035# each generated HTML page. If the tag is left blank doxygen will generate a
1036# standard header.
1037#
1038# To get valid HTML the header file that includes any scripts and style sheets
1039# that doxygen needs, which is dependent on the configuration options used (e.g.
1040# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1041# default header using
1042# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1043# YourConfigFile
1044# and then modify the file new_header.html. See also section "Doxygen usage"
1045# for information on how to generate the default header that doxygen normally
1046# uses.
1047# Note: The header is subject to change so you typically have to regenerate the
1048# default header when upgrading to a newer version of doxygen. For a description
1049# of the possible markers and block names see the documentation.
1050# This tag requires that the tag GENERATE_HTML is set to YES.
1051
1052HTML_HEADER =
1053
1054# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1055# generated HTML page. If the tag is left blank doxygen will generate a standard
1056# footer. See HTML_HEADER for more information on how to generate a default
1057# footer and what special commands can be used inside the footer. See also
1058# section "Doxygen usage" for information on how to generate the default footer
1059# that doxygen normally uses.
1060# This tag requires that the tag GENERATE_HTML is set to YES.
1061
1062HTML_FOOTER =
1063
1064# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1065# sheet that is used by each HTML page. It can be used to fine-tune the look of
1066# the HTML output. If left blank doxygen will generate a default style sheet.
1067# See also section "Doxygen usage" for information on how to generate the style
1068# sheet that doxygen normally uses.
1069# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1070# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1071# obsolete.
1072# This tag requires that the tag GENERATE_HTML is set to YES.
1073
1074HTML_STYLESHEET =
1075
1076# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1077# defined cascading style sheet that is included after the standard style sheets
1078# created by doxygen. Using this option one can overrule certain style aspects.
1079# This is preferred over using HTML_STYLESHEET since it does not replace the
1080# standard style sheet and is therefor more robust against future updates.
1081# Doxygen will copy the style sheet file to the output directory. For an example
1082# see the documentation.
1083# This tag requires that the tag GENERATE_HTML is set to YES.
1084
1085HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/extra.css
1086
1087# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1088# other source files which should be copied to the HTML output directory. Note
1089# that these files will be copied to the base HTML output directory. Use the
1090# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1091# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1092# files will be copied as-is; there are no commands or markers available.
1093# This tag requires that the tag GENERATE_HTML is set to YES.
1094
1095HTML_EXTRA_FILES =
1096
1097# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1098# will adjust the colors in the stylesheet and background images according to
1099# this color. Hue is specified as an angle on a colorwheel, see
1100# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1101# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1102# purple, and 360 is red again.
1103# Minimum value: 0, maximum value: 359, default value: 220.
1104# This tag requires that the tag GENERATE_HTML is set to YES.
1105
1106HTML_COLORSTYLE_HUE = 220
1107
1108# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1109# in the HTML output. For a value of 0 the output will use grayscales only. A
1110# value of 255 will produce the most vivid colors.
1111# Minimum value: 0, maximum value: 255, default value: 100.
1112# This tag requires that the tag GENERATE_HTML is set to YES.
1113
1114HTML_COLORSTYLE_SAT = 100
1115
1116# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1117# luminance component of the colors in the HTML output. Values below 100
1118# gradually make the output lighter, whereas values above 100 make the output
1119# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1120# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1121# change the gamma.
1122# Minimum value: 40, maximum value: 240, default value: 80.
1123# This tag requires that the tag GENERATE_HTML is set to YES.
1124
1125HTML_COLORSTYLE_GAMMA = 80
1126
1127# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1128# page will contain the date and time when the page was generated. Setting this
1129# to NO can help when comparing the output of multiple runs.
1130# The default value is: YES.
1131# This tag requires that the tag GENERATE_HTML is set to YES.
1132
1133HTML_TIMESTAMP = YES
1134
1135# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1136# documentation will contain sections that can be hidden and shown after the
1137# page has loaded.
1138# The default value is: NO.
1139# This tag requires that the tag GENERATE_HTML is set to YES.
1140
1141HTML_DYNAMIC_SECTIONS = YES
1142
1143# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1144# shown in the various tree structured indices initially; the user can expand
1145# and collapse entries dynamically later on. Doxygen will expand the tree to
1146# such a level that at most the specified number of entries are visible (unless
1147# a fully collapsed tree already exceeds this amount). So setting the number of
1148# entries 1 will produce a full collapsed tree by default. 0 is a special value
1149# representing an infinite number of entries and will result in a full expanded
1150# tree by default.
1151# Minimum value: 0, maximum value: 9999, default value: 100.
1152# This tag requires that the tag GENERATE_HTML is set to YES.
1153
1154HTML_INDEX_NUM_ENTRIES = 100
1155
1156# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1157# generated that can be used as input for Apple's Xcode 3 integrated development
1158# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1159# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1160# Makefile in the HTML output directory. Running make will produce the docset in
1161# that directory and running make install will install the docset in
1162# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1163# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1164# for more information.
1165# The default value is: NO.
1166# This tag requires that the tag GENERATE_HTML is set to YES.
1167
1168GENERATE_DOCSET = NO
1169
1170# This tag determines the name of the docset feed. A documentation feed provides
1171# an umbrella under which multiple documentation sets from a single provider
1172# (such as a company or product suite) can be grouped.
1173# The default value is: Doxygen generated docs.
1174# This tag requires that the tag GENERATE_DOCSET is set to YES.
1175
1176DOCSET_FEEDNAME = "Doxygen generated docs"
1177
1178# This tag specifies a string that should uniquely identify the documentation
1179# set bundle. This should be a reverse domain-name style string, e.g.
1180# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1181# The default value is: org.doxygen.Project.
1182# This tag requires that the tag GENERATE_DOCSET is set to YES.
1183
1184DOCSET_BUNDLE_ID = org.doxygen.Project
1185
1186# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1187# the documentation publisher. This should be a reverse domain-name style
1188# string, e.g. com.mycompany.MyDocSet.documentation.
1189# The default value is: org.doxygen.Publisher.
1190# This tag requires that the tag GENERATE_DOCSET is set to YES.
1191
1192DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1193
1194# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1195# The default value is: Publisher.
1196# This tag requires that the tag GENERATE_DOCSET is set to YES.
1197
1198DOCSET_PUBLISHER_NAME = Publisher
1199
1200# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1201# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1202# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1203# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1204# Windows.
1205#
1206# The HTML Help Workshop contains a compiler that can convert all HTML output
1207# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1208# files are now used as the Windows 98 help format, and will replace the old
1209# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1210# HTML files also contain an index, a table of contents, and you can search for
1211# words in the documentation. The HTML workshop also contains a viewer for
1212# compressed HTML files.
1213# The default value is: NO.
1214# This tag requires that the tag GENERATE_HTML is set to YES.
1215
1216GENERATE_HTMLHELP = NO
1217
1218# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1219# file. You can add a path in front of the file if the result should not be
1220# written to the html output directory.
1221# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1222
1223CHM_FILE =
1224
1225# The HHC_LOCATION tag can be used to specify the location (absolute path
1226# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1227# doxygen will try to run the HTML help compiler on the generated index.hhp.
1228# The file has to be specified with full path.
1229# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1230
1231HHC_LOCATION =
1232
1233# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1234# YES) or that it should be included in the master .chm file ( NO).
1235# The default value is: NO.
1236# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1237
1238GENERATE_CHI = NO
1239
1240# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1241# and project file content.
1242# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1243
1244CHM_INDEX_ENCODING =
1245
1246# The BINARY_TOC flag controls whether a binary table of contents is generated (
1247# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
1248# enables the Previous and Next buttons.
1249# The default value is: NO.
1250# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1251
1252BINARY_TOC = NO
1253
1254# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1255# the table of contents of the HTML help documentation and to the tree view.
1256# The default value is: NO.
1257# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1258
1259TOC_EXPAND = NO
1260
1261# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1262# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1263# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1264# (.qch) of the generated HTML documentation.
1265# The default value is: NO.
1266# This tag requires that the tag GENERATE_HTML is set to YES.
1267
1268GENERATE_QHP = NO
1269
1270# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1271# the file name of the resulting .qch file. The path specified is relative to
1272# the HTML output folder.
1273# This tag requires that the tag GENERATE_QHP is set to YES.
1274
1275QCH_FILE =
1276
1277# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1278# Project output. For more information please see Qt Help Project / Namespace
1279# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1280# The default value is: org.doxygen.Project.
1281# This tag requires that the tag GENERATE_QHP is set to YES.
1282
1283QHP_NAMESPACE = org.doxygen.Project
1284
1285# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1286# Help Project output. For more information please see Qt Help Project / Virtual
1287# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1288# folders).
1289# The default value is: doc.
1290# This tag requires that the tag GENERATE_QHP is set to YES.
1291
1292QHP_VIRTUAL_FOLDER = doc
1293
1294# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1295# filter to add. For more information please see Qt Help Project / Custom
1296# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1297# filters).
1298# This tag requires that the tag GENERATE_QHP is set to YES.
1299
1300QHP_CUST_FILTER_NAME =
1301
1302# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1303# custom filter to add. For more information please see Qt Help Project / Custom
1304# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1305# filters).
1306# This tag requires that the tag GENERATE_QHP is set to YES.
1307
1308QHP_CUST_FILTER_ATTRS =
1309
1310# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1311# project's filter section matches. Qt Help Project / Filter Attributes (see:
1312# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1313# This tag requires that the tag GENERATE_QHP is set to YES.
1314
1315QHP_SECT_FILTER_ATTRS =
1316
1317# The QHG_LOCATION tag can be used to specify the location of Qt's
1318# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1319# generated .qhp file.
1320# This tag requires that the tag GENERATE_QHP is set to YES.
1321
1322QHG_LOCATION =
1323
1324# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1325# generated, together with the HTML files, they form an Eclipse help plugin. To
1326# install this plugin and make it available under the help contents menu in
1327# Eclipse, the contents of the directory containing the HTML and XML files needs
1328# to be copied into the plugins directory of eclipse. The name of the directory
1329# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1330# After copying Eclipse needs to be restarted before the help appears.
1331# The default value is: NO.
1332# This tag requires that the tag GENERATE_HTML is set to YES.
1333
1334GENERATE_ECLIPSEHELP = NO
1335
1336# A unique identifier for the Eclipse help plugin. When installing the plugin
1337# the directory name containing the HTML and XML files should also have this
1338# name. Each documentation set should have its own identifier.
1339# The default value is: org.doxygen.Project.
1340# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1341
1342ECLIPSE_DOC_ID = org.doxygen.Project
1343
1344# If you want full control over the layout of the generated HTML pages it might
1345# be necessary to disable the index and replace it with your own. The
1346# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1347# of each HTML page. A value of NO enables the index and the value YES disables
1348# it. Since the tabs in the index contain the same information as the navigation
1349# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1350# The default value is: NO.
1351# This tag requires that the tag GENERATE_HTML is set to YES.
1352
1353DISABLE_INDEX = YES
1354
1355# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1356# structure should be generated to display hierarchical information. If the tag
1357# value is set to YES, a side panel will be generated containing a tree-like
1358# index structure (just like the one that is generated for HTML Help). For this
1359# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1360# (i.e. any modern browser). Windows users are probably better off using the
1361# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1362# further fine-tune the look of the index. As an example, the default style
1363# sheet generated by doxygen has an example that shows how to put an image at
1364# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1365# the same information as the tab index, you could consider setting
1366# DISABLE_INDEX to YES when enabling this option.
1367# The default value is: NO.
1368# This tag requires that the tag GENERATE_HTML is set to YES.
1369
1370GENERATE_TREEVIEW = YES
1371
1372# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1373# doxygen will group on one line in the generated HTML documentation.
1374#
1375# Note that a value of 0 will completely suppress the enum values from appearing
1376# in the overview section.
1377# Minimum value: 0, maximum value: 20, default value: 4.
1378# This tag requires that the tag GENERATE_HTML is set to YES.
1379
1380ENUM_VALUES_PER_LINE = 1
1381
1382# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1383# to set the initial width (in pixels) of the frame in which the tree is shown.
1384# Minimum value: 0, maximum value: 1500, default value: 250.
1385# This tag requires that the tag GENERATE_HTML is set to YES.
1386
1387TREEVIEW_WIDTH = 250
1388
1389# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1390# external symbols imported via tag files in a separate window.
1391# The default value is: NO.
1392# This tag requires that the tag GENERATE_HTML is set to YES.
1393
1394EXT_LINKS_IN_WINDOW = NO
1395
1396# Use this tag to change the font size of LaTeX formulas included as images in
1397# the HTML documentation. When you change the font size after a successful
1398# doxygen run you need to manually remove any form_*.png images from the HTML
1399# output directory to force them to be regenerated.
1400# Minimum value: 8, maximum value: 50, default value: 10.
1401# This tag requires that the tag GENERATE_HTML is set to YES.
1402
1403FORMULA_FONTSIZE = 10
1404
1405# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1406# generated for formulas are transparent PNGs. Transparent PNGs are not
1407# supported properly for IE 6.0, but are supported on all modern browsers.
1408#
1409# Note that when changing this option you need to delete any form_*.png files in
1410# the HTML output directory before the changes have effect.
1411# The default value is: YES.
1412# This tag requires that the tag GENERATE_HTML is set to YES.
1413
1414FORMULA_TRANSPARENT = YES
1415
1416# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1417# http://www.mathjax.org) which uses client side Javascript for the rendering
1418# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1419# installed or if you want to formulas look prettier in the HTML output. When
1420# enabled you may also need to install MathJax separately and configure the path
1421# to it using the MATHJAX_RELPATH option.
1422# The default value is: NO.
1423# This tag requires that the tag GENERATE_HTML is set to YES.
1424
1425USE_MATHJAX = NO
1426
1427# When MathJax is enabled you can set the default output format to be used for
1428# the MathJax output. See the MathJax site (see:
1429# http://docs.mathjax.org/en/latest/output.html) for more details.
1430# Possible values are: HTML-CSS (which is slower, but has the best
1431# compatibility), NativeMML (i.e. MathML) and SVG.
1432# The default value is: HTML-CSS.
1433# This tag requires that the tag USE_MATHJAX is set to YES.
1434
1435MATHJAX_FORMAT = HTML-CSS
1436
1437# When MathJax is enabled you need to specify the location relative to the HTML
1438# output directory using the MATHJAX_RELPATH option. The destination directory
1439# should contain the MathJax.js script. For instance, if the mathjax directory
1440# is located at the same level as the HTML output directory, then
1441# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1442# Content Delivery Network so you can quickly see the result without installing
1443# MathJax. However, it is strongly recommended to install a local copy of
1444# MathJax from http://www.mathjax.org before deployment.
1445# The default value is: http://cdn.mathjax.org/mathjax/latest.
1446# This tag requires that the tag USE_MATHJAX is set to YES.
1447
1448MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1449
1450# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1451# extension names that should be enabled during MathJax rendering. For example
1452# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1453# This tag requires that the tag USE_MATHJAX is set to YES.
1454
1455MATHJAX_EXTENSIONS =
1456
1457# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1458# of code that will be used on startup of the MathJax code. See the MathJax site
1459# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1460# example see the documentation.
1461# This tag requires that the tag USE_MATHJAX is set to YES.
1462
1463MATHJAX_CODEFILE =
1464
1465# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1466# the HTML output. The underlying search engine uses javascript and DHTML and
1467# should work on any modern browser. Note that when using HTML help
1468# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1469# there is already a search function so this one should typically be disabled.
1470# For large projects the javascript based search engine can be slow, then
1471# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1472# search using the keyboard; to jump to the search box use <access key> + S
1473# (what the <access key> is depends on the OS and browser, but it is typically
1474# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1475# key> to jump into the search results window, the results can be navigated
1476# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1477# the search. The filter options can be selected when the cursor is inside the
1478# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1479# to select a filter and <Enter> or <escape> to activate or cancel the filter
1480# option.
1481# The default value is: YES.
1482# This tag requires that the tag GENERATE_HTML is set to YES.
1483
1484SEARCHENGINE = NO
1485
1486# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1487# implemented using a web server instead of a web client using Javascript. There
1488# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1489# setting. When disabled, doxygen will generate a PHP script for searching and
1490# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1491# and searching needs to be provided by external tools. See the section
1492# "External Indexing and Searching" for details.
1493# The default value is: NO.
1494# This tag requires that the tag SEARCHENGINE is set to YES.
1495
1496SERVER_BASED_SEARCH = NO
1497
1498# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1499# script for searching. Instead the search results are written to an XML file
1500# which needs to be processed by an external indexer. Doxygen will invoke an
1501# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1502# search results.
1503#
1504# Doxygen ships with an example indexer ( doxyindexer) and search engine
1505# (doxysearch.cgi) which are based on the open source search engine library
1506# Xapian (see: http://xapian.org/).
1507#
1508# See the section "External Indexing and Searching" for details.
1509# The default value is: NO.
1510# This tag requires that the tag SEARCHENGINE is set to YES.
1511
1512EXTERNAL_SEARCH = NO
1513
1514# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1515# which will return the search results when EXTERNAL_SEARCH is enabled.
1516#
1517# Doxygen ships with an example indexer ( doxyindexer) and search engine
1518# (doxysearch.cgi) which are based on the open source search engine library
1519# Xapian (see: http://xapian.org/). See the section "External Indexing and
1520# Searching" for details.
1521# This tag requires that the tag SEARCHENGINE is set to YES.
1522
1523SEARCHENGINE_URL =
1524
1525# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1526# search data is written to a file for indexing by an external tool. With the
1527# SEARCHDATA_FILE tag the name of this file can be specified.
1528# The default file is: searchdata.xml.
1529# This tag requires that the tag SEARCHENGINE is set to YES.
1530
1531SEARCHDATA_FILE = searchdata.xml
1532
1533# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1534# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1535# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1536# projects and redirect the results back to the right project.
1537# This tag requires that the tag SEARCHENGINE is set to YES.
1538
1539EXTERNAL_SEARCH_ID =
1540
1541# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1542# projects other than the one defined by this configuration file, but that are
1543# all added to the same external search index. Each project needs to have a
1544# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1545# to a relative location where the documentation can be found. The format is:
1546# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1547# This tag requires that the tag SEARCHENGINE is set to YES.
1548
1549EXTRA_SEARCH_MAPPINGS =
1550
1551#---------------------------------------------------------------------------
1552# Configuration options related to the LaTeX output
1553#---------------------------------------------------------------------------
1554
1555# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1556# The default value is: YES.
1557
1558GENERATE_LATEX = NO
1559
1560# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1561# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1562# it.
1563# The default directory is: latex.
1564# This tag requires that the tag GENERATE_LATEX is set to YES.
1565
1566LATEX_OUTPUT = latex
1567
1568# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1569# invoked.
1570#
1571# Note that when enabling USE_PDFLATEX this option is only used for generating
1572# bitmaps for formulas in the HTML output, but not in the Makefile that is
1573# written to the output directory.
1574# The default file is: latex.
1575# This tag requires that the tag GENERATE_LATEX is set to YES.
1576
1577LATEX_CMD_NAME = latex
1578
1579# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1580# index for LaTeX.
1581# The default file is: makeindex.
1582# This tag requires that the tag GENERATE_LATEX is set to YES.
1583
1584MAKEINDEX_CMD_NAME = makeindex
1585
1586# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1587# documents. This may be useful for small projects and may help to save some
1588# trees in general.
1589# The default value is: NO.
1590# This tag requires that the tag GENERATE_LATEX is set to YES.
1591
1592COMPACT_LATEX = YES
1593
1594# The PAPER_TYPE tag can be used to set the paper type that is used by the
1595# printer.
1596# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1597# 14 inches) and executive (7.25 x 10.5 inches).
1598# The default value is: a4.
1599# This tag requires that the tag GENERATE_LATEX is set to YES.
1600
1601PAPER_TYPE = a4
1602
1603# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1604# that should be included in the LaTeX output. To get the times font for
1605# instance you can specify
1606# EXTRA_PACKAGES=times
1607# If left blank no extra packages will be included.
1608# This tag requires that the tag GENERATE_LATEX is set to YES.
1609
1610EXTRA_PACKAGES =
1611
1612# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1613# generated LaTeX document. The header should contain everything until the first
1614# chapter. If it is left blank doxygen will generate a standard header. See
1615# section "Doxygen usage" for information on how to let doxygen write the
1616# default header to a separate file.
1617#
1618# Note: Only use a user-defined header if you know what you are doing! The
1619# following commands have a special meaning inside the header: $title,
1620# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1621# replace them by respectively the title of the page, the current date and time,
1622# only the current date, the version number of doxygen, the project name (see
1623# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1624# This tag requires that the tag GENERATE_LATEX is set to YES.
1625
1626LATEX_HEADER =
1627
1628# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1629# generated LaTeX document. The footer should contain everything after the last
1630# chapter. If it is left blank doxygen will generate a standard footer.
1631#
1632# Note: Only use a user-defined footer if you know what you are doing!
1633# This tag requires that the tag GENERATE_LATEX is set to YES.
1634
1635LATEX_FOOTER =
1636
1637# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1638# other source files which should be copied to the LATEX_OUTPUT output
1639# directory. Note that the files will be copied as-is; there are no commands or
1640# markers available.
1641# This tag requires that the tag GENERATE_LATEX is set to YES.
1642
1643LATEX_EXTRA_FILES =
1644
1645# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1646# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1647# contain links (just like the HTML output) instead of page references. This
1648# makes the output suitable for online browsing using a PDF viewer.
1649# The default value is: YES.
1650# This tag requires that the tag GENERATE_LATEX is set to YES.
1651
1652PDF_HYPERLINKS = YES
1653
1654# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1655# the PDF file directly from the LaTeX files. Set this option to YES to get a
1656# higher quality PDF documentation.
1657# The default value is: YES.
1658# This tag requires that the tag GENERATE_LATEX is set to YES.
1659
1660USE_PDFLATEX = YES
1661
1662# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1663# command to the generated LaTeX files. This will instruct LaTeX to keep running
1664# if errors occur, instead of asking the user for help. This option is also used
1665# when generating formulas in HTML.
1666# The default value is: NO.
1667# This tag requires that the tag GENERATE_LATEX is set to YES.
1668
1669LATEX_BATCHMODE = NO
1670
1671# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1672# index chapters (such as File Index, Compound Index, etc.) in the output.
1673# The default value is: NO.
1674# This tag requires that the tag GENERATE_LATEX is set to YES.
1675
1676LATEX_HIDE_INDICES = NO
1677
1678# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1679# code with syntax highlighting in the LaTeX output.
1680#
1681# Note that which sources are shown also depends on other settings such as
1682# SOURCE_BROWSER.
1683# The default value is: NO.
1684# This tag requires that the tag GENERATE_LATEX is set to YES.
1685
1686LATEX_SOURCE_CODE = NO
1687
1688# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1689# bibliography, e.g. plainnat, or ieeetr. See
1690# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1691# The default value is: plain.
1692# This tag requires that the tag GENERATE_LATEX is set to YES.
1693
1694LATEX_BIB_STYLE = plain
1695
1696#---------------------------------------------------------------------------
1697# Configuration options related to the RTF output
1698#---------------------------------------------------------------------------
1699
1700# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1701# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1702# readers/editors.
1703# The default value is: NO.
1704
1705GENERATE_RTF = NO
1706
1707# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1708# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1709# it.
1710# The default directory is: rtf.
1711# This tag requires that the tag GENERATE_RTF is set to YES.
1712
1713RTF_OUTPUT = rtf
1714
1715# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1716# documents. This may be useful for small projects and may help to save some
1717# trees in general.
1718# The default value is: NO.
1719# This tag requires that the tag GENERATE_RTF is set to YES.
1720
1721COMPACT_RTF = NO
1722
1723# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1724# contain hyperlink fields. The RTF file will contain links (just like the HTML
1725# output) instead of page references. This makes the output suitable for online
1726# browsing using Word or some other Word compatible readers that support those
1727# fields.
1728#
1729# Note: WordPad (write) and others do not support links.
1730# The default value is: NO.
1731# This tag requires that the tag GENERATE_RTF is set to YES.
1732
1733RTF_HYPERLINKS = NO
1734
1735# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1736# file, i.e. a series of assignments. You only have to provide replacements,
1737# missing definitions are set to their default value.
1738#
1739# See also section "Doxygen usage" for information on how to generate the
1740# default style sheet that doxygen normally uses.
1741# This tag requires that the tag GENERATE_RTF is set to YES.
1742
1743RTF_STYLESHEET_FILE =
1744
1745# Set optional variables used in the generation of an RTF document. Syntax is
1746# similar to doxygen's config file. A template extensions file can be generated
1747# using doxygen -e rtf extensionFile.
1748# This tag requires that the tag GENERATE_RTF is set to YES.
1749
1750RTF_EXTENSIONS_FILE =
1751
1752#---------------------------------------------------------------------------
1753# Configuration options related to the man page output
1754#---------------------------------------------------------------------------
1755
1756# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1757# classes and files.
1758# The default value is: NO.
1759
1760GENERATE_MAN = NO
1761
1762# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1763# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1764# it. A directory man3 will be created inside the directory specified by
1765# MAN_OUTPUT.
1766# The default directory is: man.
1767# This tag requires that the tag GENERATE_MAN is set to YES.
1768
1769MAN_OUTPUT = man
1770
1771# The MAN_EXTENSION tag determines the extension that is added to the generated
1772# man pages. In case the manual section does not start with a number, the number
1773# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1774# optional.
1775# The default value is: .3.
1776# This tag requires that the tag GENERATE_MAN is set to YES.
1777
1778MAN_EXTENSION = .3
1779
1780# The MAN_SUBDIR tag determines the name of the directory created within
1781# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1782# MAN_EXTENSION with the initial . removed.
1783# This tag requires that the tag GENERATE_MAN is set to YES.
1784
1785MAN_SUBDIR =
1786
1787# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1788# will generate one additional man file for each entity documented in the real
1789# man page(s). These additional files only source the real man page, but without
1790# them the man command would be unable to find the correct page.
1791# The default value is: NO.
1792# This tag requires that the tag GENERATE_MAN is set to YES.
1793
1794MAN_LINKS = NO
1795
1796#---------------------------------------------------------------------------
1797# Configuration options related to the XML output
1798#---------------------------------------------------------------------------
1799
1800# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1801# captures the structure of the code including all documentation.
1802# The default value is: NO.
1803
1804GENERATE_XML = YES
1805
1806# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1807# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1808# it.
1809# The default directory is: xml.
1810# This tag requires that the tag GENERATE_XML is set to YES.
1811
1812XML_OUTPUT = xml
1813
1814# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1815# listings (including syntax highlighting and cross-referencing information) to
1816# the XML output. Note that enabling this will significantly increase the size
1817# of the XML output.
1818# The default value is: YES.
1819# This tag requires that the tag GENERATE_XML is set to YES.
1820
1821XML_PROGRAMLISTING = YES
1822
1823#---------------------------------------------------------------------------
1824# Configuration options related to the DOCBOOK output
1825#---------------------------------------------------------------------------
1826
1827# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1828# that can be used to generate PDF.
1829# The default value is: NO.
1830
1831GENERATE_DOCBOOK = NO
1832
1833# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1834# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1835# front of it.
1836# The default directory is: docbook.
1837# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1838
1839DOCBOOK_OUTPUT = docbook
1840
1841#---------------------------------------------------------------------------
1842# Configuration options for the AutoGen Definitions output
1843#---------------------------------------------------------------------------
1844
1845# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1846# Definitions (see http://autogen.sf.net) file that captures the structure of
1847# the code including all documentation. Note that this feature is still
1848# experimental and incomplete at the moment.
1849# The default value is: NO.
1850
1851GENERATE_AUTOGEN_DEF = NO
1852
1853#---------------------------------------------------------------------------
1854# Configuration options related to the Perl module output
1855#---------------------------------------------------------------------------
1856
1857# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1858# file that captures the structure of the code including all documentation.
1859#
1860# Note that this feature is still experimental and incomplete at the moment.
1861# The default value is: NO.
1862
1863GENERATE_PERLMOD = NO
1864
1865# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1866# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1867# output from the Perl module output.
1868# The default value is: NO.
1869# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1870
1871PERLMOD_LATEX = NO
1872
1873# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1874# formatted so it can be parsed by a human reader. This is useful if you want to
1875# understand what is going on. On the other hand, if this tag is set to NO the
1876# size of the Perl module output will be much smaller and Perl will parse it
1877# just the same.
1878# The default value is: YES.
1879# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1880
1881PERLMOD_PRETTY = YES
1882
1883# The names of the make variables in the generated doxyrules.make file are
1884# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1885# so different doxyrules.make files included by the same Makefile don't
1886# overwrite each other's variables.
1887# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1888
1889PERLMOD_MAKEVAR_PREFIX =
1890
1891#---------------------------------------------------------------------------
1892# Configuration options related to the preprocessor
1893#---------------------------------------------------------------------------
1894
1895# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1896# C-preprocessor directives found in the sources and include files.
1897# The default value is: YES.
1898
1899ENABLE_PREPROCESSING = YES
1900
1901# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1902# in the source code. If set to NO only conditional compilation will be
1903# performed. Macro expansion can be done in a controlled way by setting
1904# EXPAND_ONLY_PREDEF to YES.
1905# The default value is: NO.
1906# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1907
1908MACRO_EXPANSION = YES
1909
1910# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1911# the macro expansion is limited to the macros specified with the PREDEFINED and
1912# EXPAND_AS_DEFINED tags.
1913# The default value is: NO.
1914# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1915
1916EXPAND_ONLY_PREDEF = YES
1917
1918# If the SEARCH_INCLUDES tag is set to YES the includes files in the
1919# INCLUDE_PATH will be searched if a #include is found.
1920# The default value is: YES.
1921# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1922
1923SEARCH_INCLUDES = YES
1924
1925# The INCLUDE_PATH tag can be used to specify one or more directories that
1926# contain include files that are not input files but should be processed by the
1927# preprocessor.
1928# This tag requires that the tag SEARCH_INCLUDES is set to YES.
1929
1930INCLUDE_PATH =
1931
1932# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1933# patterns (like *.h and *.hpp) to filter out the header-files in the
1934# directories. If left blank, the patterns specified with FILE_PATTERNS will be
1935# used.
1936# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1937
1938INCLUDE_FILE_PATTERNS =
1939
1940# The PREDEFINED tag can be used to specify one or more macro names that are
1941# defined before the preprocessor is started (similar to the -D option of e.g.
1942# gcc). The argument of the tag is a list of macros of the form: name or
1943# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1944# is assumed. To prevent a macro definition from being undefined via #undef or
1945# recursively expanded use the := operator instead of the = operator.
1946# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1947
1948PREDEFINED = Q_DECL_EXPORT:= \
1949 Q_DECL_PRIVATE:=
1950
1951# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1952# tag can be used to specify a list of macro names that should be expanded. The
1953# macro definition that is found in the sources will be used. Use the PREDEFINED
1954# tag if you want to use a different macro definition that overrules the
1955# definition found in the source code.
1956# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1957
1958EXPAND_AS_DEFINED =
1959
1960# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1961# remove all references to function-like macros that are alone on a line, have
1962# an all uppercase name, and do not end with a semicolon. Such function macros
1963# are typically used for boiler-plate code, and will confuse the parser if not
1964# removed.
1965# The default value is: YES.
1966# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1967
1968SKIP_FUNCTION_MACROS = YES
1969
1970#---------------------------------------------------------------------------
1971# Configuration options related to external references
1972#---------------------------------------------------------------------------
1973
1974# The TAGFILES tag can be used to specify one or more tag files. For each tag
1975# file the location of the external documentation should be added. The format of
1976# a tag file without this location is as follows:
1977# TAGFILES = file1 file2 ...
1978# Adding location for the tag files is done as follows:
1979# TAGFILES = file1=loc1 "file2 = loc2" ...
1980# where loc1 and loc2 can be relative or absolute paths or URLs. See the
1981# section "Linking to external documentation" for more information about the use
1982# of tag files.
1983# Note: Each tag file must have a unique name (where the name does NOT include
1984# the path). If a tag file is not located in the directory in which doxygen is
1985# run, you must also specify the path to the tagfile here.
1986
1987TAGFILES =
1988
1989# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1990# tag file that is based on the input files it reads. See section "Linking to
1991# external documentation" for more information about the usage of tag files.
1992
1993GENERATE_TAGFILE =
1994
1995# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1996# class index. If set to NO only the inherited external classes will be listed.
1997# The default value is: NO.
1998
1999ALLEXTERNALS = NO
2000
2001# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2002# the modules index. If set to NO, only the current project's groups will be
2003# listed.
2004# The default value is: YES.
2005
2006EXTERNAL_GROUPS = YES
2007
2008# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2009# the related pages index. If set to NO, only the current project's pages will
2010# be listed.
2011# The default value is: YES.
2012
2013EXTERNAL_PAGES = YES
2014
2015# The PERL_PATH should be the absolute path and name of the perl script
2016# interpreter (i.e. the result of 'which perl').
2017# The default file (with absolute path) is: /usr/bin/perl.
2018
2019PERL_PATH = /usr/bin/perl
2020
2021#---------------------------------------------------------------------------
2022# Configuration options related to the dot tool
2023#---------------------------------------------------------------------------
2024
2025# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2026# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2027# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2028# disabled, but it is recommended to install and use dot, since it yields more
2029# powerful graphs.
2030# The default value is: YES.
2031
2032CLASS_DIAGRAMS = YES
2033
2034# You can define message sequence charts within doxygen comments using the \msc
2035# command. Doxygen will then run the mscgen tool (see:
2036# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2037# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2038# the mscgen tool resides. If left empty the tool is assumed to be found in the
2039# default search path.
2040
2041MSCGEN_PATH =
2042
2043# You can include diagrams made with dia in doxygen documentation. Doxygen will
2044# then run dia to produce the diagram and insert it in the documentation. The
2045# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2046# If left empty dia is assumed to be found in the default search path.
2047
2048DIA_PATH =
2049
2050# If set to YES, the inheritance and collaboration graphs will hide inheritance
2051# and usage relations if the target is undocumented or is not a class.
2052# The default value is: YES.
2053
2054HIDE_UNDOC_RELATIONS = NO
2055
2056# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2057# available from the path. This tool is part of Graphviz (see:
2058# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2059# Bell Labs. The other options in this section have no effect if this option is
2060# set to NO
2061# The default value is: YES.
2062
2063HAVE_DOT = YES
2064
2065# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2066# to run in parallel. When set to 0 doxygen will base this on the number of
2067# processors available in the system. You can set it explicitly to a value
2068# larger than 0 to get control over the balance between CPU load and processing
2069# speed.
2070# Minimum value: 0, maximum value: 32, default value: 0.
2071# This tag requires that the tag HAVE_DOT is set to YES.
2072
2073DOT_NUM_THREADS = 0
2074
2075# When you want a differently looking font n the dot files that doxygen
2076# generates you can specify the font name using DOT_FONTNAME. You need to make
2077# sure dot is able to find the font, which can be done by putting it in a
2078# standard location or by setting the DOTFONTPATH environment variable or by
2079# setting DOT_FONTPATH to the directory containing the font.
2080# The default value is: Helvetica.
2081# This tag requires that the tag HAVE_DOT is set to YES.
2082
2083DOT_FONTNAME = Helvetica
2084
2085# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2086# dot graphs.
2087# Minimum value: 4, maximum value: 24, default value: 10.
2088# This tag requires that the tag HAVE_DOT is set to YES.
2089
2090DOT_FONTSIZE = 10
2091
2092# By default doxygen will tell dot to use the default font as specified with
2093# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2094# the path where dot can find it using this tag.
2095# This tag requires that the tag HAVE_DOT is set to YES.
2096
2097DOT_FONTPATH =
2098
2099# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2100# each documented class showing the direct and indirect inheritance relations.
2101# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2102# The default value is: YES.
2103# This tag requires that the tag HAVE_DOT is set to YES.
2104
2105CLASS_GRAPH = YES
2106
2107# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2108# graph for each documented class showing the direct and indirect implementation
2109# dependencies (inheritance, containment, and class references variables) of the
2110# class with other documented classes.
2111# The default value is: YES.
2112# This tag requires that the tag HAVE_DOT is set to YES.
2113
2114COLLABORATION_GRAPH = YES
2115
2116# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2117# groups, showing the direct groups dependencies.
2118# The default value is: YES.
2119# This tag requires that the tag HAVE_DOT is set to YES.
2120
2121GROUP_GRAPHS = YES
2122
2123# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2124# collaboration diagrams in a style similar to the OMG's Unified Modeling
2125# Language.
2126# The default value is: NO.
2127# This tag requires that the tag HAVE_DOT is set to YES.
2128
2129UML_LOOK = YES
2130
2131# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2132# class node. If there are many fields or methods and many nodes the graph may
2133# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2134# number of items for each type to make the size more manageable. Set this to 0
2135# for no limit. Note that the threshold may be exceeded by 50% before the limit
2136# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2137# but if the number exceeds 15, the total amount of fields shown is limited to
2138# 10.
2139# Minimum value: 0, maximum value: 100, default value: 10.
2140# This tag requires that the tag HAVE_DOT is set to YES.
2141
2142UML_LIMIT_NUM_FIELDS = 10
2143
2144# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2145# collaboration graphs will show the relations between templates and their
2146# instances.
2147# The default value is: NO.
2148# This tag requires that the tag HAVE_DOT is set to YES.
2149
2150TEMPLATE_RELATIONS = NO
2151
2152# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2153# YES then doxygen will generate a graph for each documented file showing the
2154# direct and indirect include dependencies of the file with other documented
2155# files.
2156# The default value is: YES.
2157# This tag requires that the tag HAVE_DOT is set to YES.
2158
2159INCLUDE_GRAPH = YES
2160
2161# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2162# set to YES then doxygen will generate a graph for each documented file showing
2163# the direct and indirect include dependencies of the file with other documented
2164# files.
2165# The default value is: YES.
2166# This tag requires that the tag HAVE_DOT is set to YES.
2167
2168INCLUDED_BY_GRAPH = YES
2169
2170# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2171# dependency graph for every global function or class method.
2172#
2173# Note that enabling this option will significantly increase the time of a run.
2174# So in most cases it will be better to enable call graphs for selected
2175# functions only using the \callgraph command.
2176# The default value is: NO.
2177# This tag requires that the tag HAVE_DOT is set to YES.
2178
2179CALL_GRAPH = YES
2180
2181# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2182# dependency graph for every global function or class method.
2183#
2184# Note that enabling this option will significantly increase the time of a run.
2185# So in most cases it will be better to enable caller graphs for selected
2186# functions only using the \callergraph command.
2187# The default value is: NO.
2188# This tag requires that the tag HAVE_DOT is set to YES.
2189
2190CALLER_GRAPH = NO
2191
2192# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2193# hierarchy of all classes instead of a textual one.
2194# The default value is: YES.
2195# This tag requires that the tag HAVE_DOT is set to YES.
2196
2197GRAPHICAL_HIERARCHY = YES
2198
2199# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2200# dependencies a directory has on other directories in a graphical way. The
2201# dependency relations are determined by the #include relations between the
2202# files in the directories.
2203# The default value is: YES.
2204# This tag requires that the tag HAVE_DOT is set to YES.
2205
2206DIRECTORY_GRAPH = YES
2207
2208# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2209# generated by dot.
2210# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2211# to make the SVG files visible in IE 9+ (other browsers do not have this
2212# requirement).
2213# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2214# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2215# gif:cairo:gd, gif:gd, gif:gd:gd and svg.
2216# The default value is: png.
2217# This tag requires that the tag HAVE_DOT is set to YES.
2218
2219DOT_IMAGE_FORMAT = png
2220
2221# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2222# enable generation of interactive SVG images that allow zooming and panning.
2223#
2224# Note that this requires a modern browser other than Internet Explorer. Tested
2225# and working are Firefox, Chrome, Safari, and Opera.
2226# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2227# the SVG files visible. Older versions of IE do not have SVG support.
2228# The default value is: NO.
2229# This tag requires that the tag HAVE_DOT is set to YES.
2230
2231INTERACTIVE_SVG = YES
2232
2233# The DOT_PATH tag can be used to specify the path where the dot tool can be
2234# found. If left blank, it is assumed the dot tool can be found in the path.
2235# This tag requires that the tag HAVE_DOT is set to YES.
2236
2237DOT_PATH =
2238
2239# The DOTFILE_DIRS tag can be used to specify one or more directories that
2240# contain dot files that are included in the documentation (see the \dotfile
2241# command).
2242# This tag requires that the tag HAVE_DOT is set to YES.
2243
2244DOTFILE_DIRS =
2245
2246# The MSCFILE_DIRS tag can be used to specify one or more directories that
2247# contain msc files that are included in the documentation (see the \mscfile
2248# command).
2249
2250MSCFILE_DIRS =
2251
2252# The DIAFILE_DIRS tag can be used to specify one or more directories that
2253# contain dia files that are included in the documentation (see the \diafile
2254# command).
2255
2256DIAFILE_DIRS =
2257
2258# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2259# that will be shown in the graph. If the number of nodes in a graph becomes
2260# larger than this value, doxygen will truncate the graph, which is visualized
2261# by representing a node as a red box. Note that doxygen if the number of direct
2262# children of the root node in a graph is already larger than
2263# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2264# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2265# Minimum value: 0, maximum value: 10000, default value: 50.
2266# This tag requires that the tag HAVE_DOT is set to YES.
2267
2268DOT_GRAPH_MAX_NODES = 50
2269
2270# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2271# generated by dot. A depth value of 3 means that only nodes reachable from the
2272# root by following a path via at most 3 edges will be shown. Nodes that lay
2273# further from the root node will be omitted. Note that setting this option to 1
2274# or 2 may greatly reduce the computation time needed for large code bases. Also
2275# note that the size of a graph can be further restricted by
2276# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2277# Minimum value: 0, maximum value: 1000, default value: 0.
2278# This tag requires that the tag HAVE_DOT is set to YES.
2279
2280MAX_DOT_GRAPH_DEPTH = 0
2281
2282# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2283# background. This is disabled by default, because dot on Windows does not seem
2284# to support this out of the box.
2285#
2286# Warning: Depending on the platform used, enabling this option may lead to
2287# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2288# read).
2289# The default value is: NO.
2290# This tag requires that the tag HAVE_DOT is set to YES.
2291
2292DOT_TRANSPARENT = YES
2293
2294# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2295# files in one run (i.e. multiple -o and -T options on the command line). This
2296# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2297# this, this feature is disabled by default.
2298# The default value is: NO.
2299# This tag requires that the tag HAVE_DOT is set to YES.
2300
2301DOT_MULTI_TARGETS = YES
2302
2303# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2304# explaining the meaning of the various boxes and arrows in the dot generated
2305# graphs.
2306# The default value is: YES.
2307# This tag requires that the tag HAVE_DOT is set to YES.
2308
2309GENERATE_LEGEND = YES
2310
2311# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2312# files that are used to generate the various graphs.
2313# The default value is: YES.
2314# This tag requires that the tag HAVE_DOT is set to YES.
2315
2316DOT_CLEANUP = YES
02317
=== added directory 'doc/qt/cpp/css'
=== added file 'doc/qt/cpp/css/base.css'
--- doc/qt/cpp/css/base.css 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/css/base.css 2014-08-19 17:36:21 +0000
@@ -0,0 +1,638 @@
1/**
2* Ubuntu Developer base stylesheet
3*
4* A base stylesheet containing site-wide styles
5*
6* @project Ubuntu Developer
7* @version 1.0
8* @author Canonical Web Team: Steve Edwards
9* @copyright 2011 Canonical Ltd.
10*/
11
12/**
13* @section Global
14*/
15
16body {
17 font-family: 'Ubuntu', 'Ubuntu Beta', UbuntuBeta, Ubuntu, 'Bitstream Vera Sans', 'DejaVu Sans', Tahoma, sans-serif;
18 font-size: 13px;
19 line-height: 1.4;
20 color: #333;
21}
22a {
23 color: #dd4814;
24 text-decoration: none;
25 outline: 0;
26}
27p, dl {
28 margin-bottom: 10px;
29}
30strong {
31 font-weight: bold;
32}
33em {
34 font-style: italic;
35}
36code{
37 padding: 10px;
38 font-family: 'Ubuntu Mono', 'Consolas', 'Monaco', 'DejaVu Sans Mono', Courier, monospace;
39 background-color: #fdf6f2;
40 display: block;
41 margin-bottom: 10px;
42 -moz-border-radius: 4px;
43 -webkit-border-radius: 4px;
44 border-radius: 4px;
45}
46h1 {
47 font-size: 36px;
48 line-height: 1.1;
49 margin-bottom: 20px;
50}
51article h1,
52h2 {
53 font-size: 24px;
54 line-height: 1.2;
55 margin-bottom: 14px;
56}
57h3 {
58 font-size: 16px;
59 line-height: 1.3;
60 margin-bottom: 8px;
61}
62h4 {
63 font-weight: bold;
64}
65
66time {
67 color:#999;
68}
69
70/**
71* @section Structure
72*/
73
74.header-login,
75.header-navigation div,
76.header-content div {
77 margin: 0 auto;
78 width: 940px;
79}
80
81.header-content h1{
82 background-color:#ffffff;
83 display:inline-block;
84}
85
86.header-content h2{
87 background-color:#ffffff;
88 display:table;
89}
90
91.header-login ul {
92 margin: 4px 0;
93 float: right;
94}
95.header-login li {
96 margin-right: 10px;
97 float: left;
98}
99.header-login a {
100 color: #333;
101}
102.header-navigation {
103 border-top: 2px solid #dd4814;
104 border-bottom: 2px solid #dd4814;
105 background-color: #fff;
106 height: 54px;
107 clear: right;
108 overflow: hidden;
109}
110.header-navigation nav ul {
111 border-right: 1px solid #dd4814;
112 float: right;
113}
114.header-navigation nav li {
115 border-left: 1px solid #dd4814;
116 float: left;
117 height: 54px;
118}
119.header-navigation nav a {
120 padding: 18px 14px 0;
121 font-size: 14px;
122 display: block;
123 height: 36px;
124}
125.header-navigation nav a:hover {
126 background-color: #fcece7;
127}
128.header-navigation nav .current_page_item a,
129.header-navigation nav .current_page_parent a,
130.header-navigation nav .current_page_ancestor a {
131 background-color: #dd4814;
132 color: #fff;
133}
134.header-navigation input {
135 margin: 12px 10px 0 10px;
136 padding: 5px;
137 border-top: 1px solid #a1a1a1;
138 border-right: 1px solid #e0e0e0;
139 border-bottom: 1px solid #fff;
140 border-left: 1px solid #e0e0e0;
141 width: 90px;
142 font-style: italic;
143 color: #ccc;
144 -moz-border-radius: 3px;
145 -webkit-border-radius: 3px;
146 border-radius: 3px;
147 -moz-box-shadow: inset 0 1px 1px #e0e0e0;
148 -webkit-box-shadow: inset 0 1px 1px #e0e0e0;
149 box-shadow: inset 0 1px 1px #e0e0e0;
150}
151.header-navigation h2 {
152 margin: 18px 0 0 6px;
153 text-transform: lowercase;
154 font-size: 22px;
155 color: #dd4814;
156 float: left;
157}
158.header-navigation .logo-ubuntu {
159 margin-top: 12px;
160 float: left;
161}
162.header-content .header-navigation-secondary {
163 margin-bottom: 40px;
164 padding: 0;
165 position: relative;
166 z-index: 2;
167}
168.header-navigation-secondary div {
169 padding: 0;
170 border: 2px solid #dd4814;
171 -moz-border-radius: 0px 0px 4px 4px;
172 -webkit-border-radius: 0px 0px 4px 4px;
173 border-radius: 0px 0px 4px 4px;
174 background: #fff;
175 border-top: 0px;
176 width: 936px;
177}
178.header-navigation-secondary nav li {
179 float: left;
180}
181.header-navigation-secondary nav li a {
182 color: #333;
183 display: block;
184 height: 25px;
185 padding: 8px 8px 0;
186}
187.header-navigation-secondary nav li:hover,
188.header-navigation-secondary nav .current_page_item a {
189 background: url("../img/sec-nav-hover.gif");
190}
191.header-content {
192 padding-bottom: 30px;
193 border-bottom: 1px solid #e0e0e0;
194 -moz-box-shadow: 0 1px 3px #e0e0e0;
195 -webkit-box-shadow: 0 1px 3px #e0e0e0;
196 box-shadow: 0 1px 3px #e0e0e0;
197 margin-bottom: 3px;
198 position: relative;
199 overflow: hidden;
200}
201footer {
202 padding: 10px 10px 40px 10px;
203 position: relative;
204 -moz-border-radius: 0 0 4px 4px;
205 -webkit-border-radius: 0 0 4px 4px;
206 border-radius: 0 0 4px 4px;
207 font-size: 12px;
208 background: url("../img/background-footer.png") repeat scroll 0 0 #f7f6f5;
209}
210footer div {
211 margin: 0 auto;
212 padding: 0 10px;
213 width: 940px;
214}
215footer a {
216 color: #000;
217}
218footer nav ul {
219 margin: 10px 17px 30px 0;
220 width: 172px;
221 display: inline-block;
222 vertical-align: top;
223 height: auto;
224 zoom: 1;
225 *display: inline;
226}
227footer nav ul.last {
228 margin-right: 0;
229}
230footer nav li {
231 margin-bottom: 8px;
232}
233footer nav li:first-child {
234 font-weight: bold;
235}
236footer p {
237 margin-bottom: 0;
238}
239#content {
240 padding-top: 35px;
241}
242.arrow-nav {
243 display: none;
244 position: absolute;
245 top: -1px;
246 z-index: 3;
247}
248.shadow {
249 margin: 30px 0 3px 0;
250 border-bottom: 1px solid #e0e0e0;
251 -moz-box-shadow: 0 2px 3px #e0e0e0;
252 -webkit-box-shadow: 0 2px 3px #e0e0e0;
253 box-shadow: 0 2px 3px #e0e0e0;
254 height: 3px;
255}
256
257/**
258* @section Site-wide
259*/
260
261#content h2{
262 font-size:24px;
263}
264
265.box-orange {
266 padding: 10px;
267 border: 3px solid #dd4814;
268 -moz-border-radius: 4px;
269 -webkit-border-radius: 4px;
270 border-radius: 4px;
271}
272.box-orange .link-action-small {
273 float: right;
274 margin: 0 0 0 20px;
275}
276.link-bug {
277 margin-left: 10px;
278 color: #999;
279}
280.link-action {
281 float: left;
282 margin-bottom: 20px;
283 padding: 8px 12px;
284 display: block;
285 background-color: #dd4814;
286 color: #fff;
287 -moz-border-radius: 20px;
288 -webkit-border-radius: 20px;
289 border-radius: 20px;
290 font-size: 16px;
291 line-height: 1.3;
292 border-top: 3px solid #e6633a;
293 border-bottom: 3px solid #c03d14;
294}
295.link-action2 {
296 float: left;
297 display: block;
298 color: #fff;
299 font-size: 16px;
300 line-height: 1.3;
301}
302.link-action2 span{
303 display:block;
304 float:left;
305}
306.link-action2 .cta-left{
307 background:url(../img/button-cta-left.png) no-repeat;
308 width:22px;
309 height:48px;
310}
311.link-action2 .cta-center{
312 background:url(../img/button-cta-slice.png) repeat-x;
313 line-height:45px;
314 height:48px;
315}
316.link-action2 .cta-right{
317 background:url(../img/button-cta-right.png) no-repeat;
318 width:22px;
319 height:48px;
320}
321
322.link-action-small {
323 float: left;
324 display: block;
325 color: #fff;
326 font-size: 16px;
327}
328.link-action-small span{
329 display:block;
330 float:left;
331 height:42px;
332}
333.link-action-small .cta-left{
334 background:url(../img/button-cta-left-small.png) no-repeat;
335 width:19px;
336}
337.link-action-small .cta-center{
338 background:url(../img/button-cta-slice-small.png) repeat-x;
339 line-height:42px;
340}
341.link-action-small .cta-right{
342 background:url(../img/button-cta-right-small.png) no-repeat;
343 width:19px;
344}
345
346.link-action:active {
347 position: relative;
348 top: 1px;
349}
350.link-action2:active {
351 position: relative;
352 top: 1px;
353}
354.link-action-small:active {
355 position: relative;
356 top: 1px;
357}
358.list-bullets li {
359 margin-bottom: 10px;
360 list-style: disc;
361 list-style-position: inside;
362}
363.box {
364 margin-bottom: 30px;
365 padding: 15px;
366 border: 1px solid #aea79f;
367 -moz-border-radius: 4px;
368 -webkit-border-radius: 4px;
369 border-radius: 4px;
370}
371.box-padded {
372 margin-bottom: 30px;
373 padding: 5px;
374 border: 2px solid #aea79f;
375 -moz-border-radius: 4px;
376 -webkit-border-radius: 4px;
377 border-radius: 4px;
378 background: url("../img/pattern-featured.gif") repeat scroll 0 0 #ebe9e7;
379 overflow: hidden;
380}
381.box-padded h3 {
382 margin: 5px 0 10px 5px;
383}
384.box-padded div {
385 padding: 10px;
386 border: 1px solid #aea79f;
387 -moz-border-radius: 4px;
388 -webkit-border-radius: 4px;
389 border-radius: 4px;
390 background-color: #fff;
391 overflow: hidden;
392}
393.box-padded li {
394 padding: 0 10px;
395 float: left;
396 width: 211px;
397 border-right: 1px dotted #aea79f;
398}
399.box-padded li.first {
400 padding: 0;
401 margin-bottom: 0;
402}
403.box-padded li.last {
404 border: 0;
405 width: 217px;
406}
407.box-padded img {
408 margin: 0 10px 50px 0;
409 float: left;
410 -moz-border-radius: 8px;
411 -webkit-border-radius: 8px;
412 border-radius: 8px;
413}
414.box-clear {
415 margin-bottom: 40px;
416}
417.box-clear .grid-4.first {
418 margin-right: 15px;
419 padding-right: 15px;
420}
421.box-clear .grid-4 {
422 margin-left: 0;
423 margin-right: 10px;
424 padding-right: 10px;
425 width: 298px;
426}
427.box-clear time {
428 display: block;
429 border-bottom: 1px dotted #aea79f;
430 padding-bottom: 10px;
431 margin-bottom: 10px;
432}
433.box-clear div.first {
434 border-right: 1px dotted #aea79f;
435}
436.box-clear a {
437 display: block;
438}
439.box-clear .rss {
440 background: url("../img/rss.jpg") no-repeat scroll 0 center;
441 padding-left: 20px;
442}
443.box-clear .location {
444 display: block;
445 margin-bottom: 1px;
446}
447.box-clear .last {
448 margin: 0;
449 padding-right: 0;
450 -moz-border-radius: 4px;
451 -webkit-border-radius: 4px;
452 border-radius: 4px;
453 width: 293px;
454}
455
456/* Widgets */
457
458.ui-state-focus {
459 outline: none;
460}
461.ui-accordion {
462 border-bottom: 1px dotted #aea79f;
463}
464.ui-accordion a {
465 display: block;
466}
467.ui-accordion h3 {
468 margin-bottom: 0;
469 border-top: 1px dotted #aea79f;
470 position: relative;
471 font-size: 13px;
472 font-weight: bold;
473}
474.ui-accordion h3 a {
475 padding: 10px 0;
476 color: #333;
477}
478.ui-accordion h4 {
479 margin-bottom: 5px;
480}
481.ui-accordion div fieldset {
482 padding-bottom: 5px;
483}
484.ui-accordion div li,
485.ui-accordion div input {
486 margin-bottom: 10px;
487}
488.ui-accordion .ui-icon {
489 position: absolute;
490 top: 15px;
491 right: 0;
492 display: block;
493 width: 8px;
494 height: 8px;
495 background: url("../img/icon-accordion-inactive.png") 0 0 no-repeat transparent;
496}
497.ui-accordion .ui-state-active .ui-icon {
498 background-image: url("../img/icon-accordion-active.png");
499}
500.ui-accordion .current_page_item a {
501 color: #333;
502}
503.container-tweet {
504 -moz-border-radius: 4px 4px 4px 4px;
505 -webkit-border-radius: 4px 4px 4px 4px;
506 border-radius: 4px 4px 4px 4px;
507 padding: 10px 10px 10px;
508 background-color: #f7f7f7;
509}
510.container-tweet .tweet-follow {
511 margin-top: 10px;
512 margin-bottom: -10px;
513 padding-left: 55px;
514 padding-bottom: 6px;
515 background: url("../img/tweet-follow.png") 0 5px no-repeat;
516 display: block;
517}
518.container-tweet .tweet-follow span {
519 font-size: 16px;
520 font-weight: bold;
521 line-height: 1.2;
522 display: block;
523}
524.tweet a {
525 display: inline;
526}
527.tweet .tweet_text {
528 padding: 10px;
529 background-color: #fff;
530 -moz-border-radius: 4px 4px 4px 4px;
531 -webkit-border-radius: 4px 4px 4px 4px;
532 border-radius: 4px 4px 4px 4px;
533 border: 1px solid #dd4814;
534 font-size: 16px;
535 display: block;
536 clear: both;
537}
538.tweet.tweet-small .tweet_text {
539 font-size: inherit;
540}
541.tweet .tweet_text a {
542 color: #333;
543}
544.tweet .tweet_time,
545.tweet .tweet_user_and_time {
546 padding: 15px 0 10px 0;
547 position: relative;
548 top: -2px;
549 background: url("../img/tweet-arrow.png") no-repeat;
550 display: block;
551}
552.tweet .tweet_odd .tweet_time,
553.tweet .tweet_odd .tweet_user_and_time {
554 background-position: right 0;
555 float: right;
556}
557.tweet .tweet_even .tweet_time,
558.tweet .tweet_even .tweet_user_and_time {
559 background-position: left 0;
560 float: left;
561}
562
563/* Search */
564
565#content .list-search li {
566 list-style-type:none;
567 border:0px;
568 margin-bottom: 15px;
569 padding-top: 15px;
570}
571
572/* Blog */
573
574.blog-article #nav-single {
575 margin-top: 30px;
576 margin-bottom: 30px;
577}
578.blog-article #nav-single .nav-next {
579 float: right;
580}
581.blog-article article header .entry-meta {
582 margin-bottom: 20px;
583}
584.blog-article article .entry-meta {
585 color: #999;
586}
587.blog-article #respond form input[type="submit"] {
588 float: left;
589 cursor: pointer;
590 margin-bottom: 20px;
591 padding: 8px 12px;
592 display: block;
593 background-color: #dd4814;
594 color: #fff;
595 -moz-border-radius: 20px;
596 -webkit-border-radius: 20px;
597 border-radius: 20px;
598 font-size: 16px;
599 line-height: 1.3;
600 border-top: 3px solid #e6633a;
601 border-left: 3px solid #e6633a;
602 border-right: 3px solid #e6633a;
603 border-bottom: 3px solid #c03d14;
604}
605.blog-article #respond form input[type="submit"]:active {
606 position: relative;
607 top: 1px;
608}
609
610.alignnone{
611 float:left;
612 margin:10px 20px 10px 0;
613}
614.alignleft{
615 float:left;
616 margin:10px 20px 10px 0;
617}
618.alignright{
619 float:right;
620 margin:10px 0 10px 20px;
621}
622
623.aligncenter{
624 float:left;
625 margin:10px 20px 10px 0;
626}
627.entry-content h2, .entry-content h3{
628 margin-top:20px;
629}
630.entry-content ul li{
631 list-style-type: circle;
632 margin-left:16px;
633}
634
635.entry-content hr{
636 border:none;
637 border-top: 1px dotted #AEA79F;
638}
0639
=== added file 'doc/qt/cpp/css/qtquick.css'
--- doc/qt/cpp/css/qtquick.css 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/css/qtquick.css 2014-08-19 17:36:21 +0000
@@ -0,0 +1,772 @@
1@media screen
2{
3
4/* basic elements */
5 html
6 {
7 color: #000000;
8 background: #FFFFFF;
9 }
10 table
11 {
12 border-collapse: collapse;
13 border-spacing: 0;
14 }
15 fieldset, img
16 {
17 border: 0;
18 max-width:100%;
19 }
20 address, caption, cite, code, dfn, em, strong, th, var, optgroup
21 {
22 font-style: inherit;
23 font-weight: inherit;
24 }
25 del, ins
26 {
27 text-decoration: none;
28 }
29 ol li
30 {
31 list-style: decimal;
32 }
33 ul li
34 {
35 list-style: none;
36 }
37 caption, th
38 {
39 text-align: left;
40 }
41 h1.title
42 {
43 font-weight: bold;
44 font-size: 150%;
45 }
46 h0
47 {
48 font-weight: bold;
49 font-size: 130%;
50 }
51 h1, h2, h3, h4, h5, h6
52 {
53 font-size: 100%;
54 }
55 q:before, q:after
56 {
57 content: '';
58 }
59 abbr, acronym
60 {
61 border: 0;
62 font-variant: normal;
63 }
64 sup, sub
65 {
66 vertical-align: baseline;
67 }
68 tt, .qmlreadonly span, .qmldefault span
69 {
70 word-spacing:0.5em;
71 }
72 legend
73 {
74 color: #000000;
75 }
76 strong
77 {
78 font-weight: bold;
79 }
80 em
81 {
82 font-style: italic;
83 }
84
85 body
86 {
87 margin: 0 1.5em 0 1.5em;
88 font-family: ubuntu;
89 line-height: normal
90 }
91 a
92 {
93 color: #00732F;
94 text-decoration: none;
95 }
96 hr
97 {
98 background-color: #E6E6E6;
99 border: 1px solid #E6E6E6;
100 height: 1px;
101 width: 100%;
102 text-align: left;
103 margin: 1.5em 0 1.5em 0;
104 }
105
106 pre
107 {
108 border: 1px solid #DDDDDD;
109 -moz-border-radius: 0.7em 0.7em 0.7em 0.7em;
110 -webkit-border-radius: 0.7em 0.7em 0.7em 0.7em;
111 border-radius: 0.7em 0.7em 0.7em 0.7em;
112 padding: 1em 1em 1em 1em;
113 overflow-x: auto;
114 }
115 table, pre
116 {
117 -moz-border-radius: 0.7em 0.7em 0.7em 0.7em;
118 -webkit-border-radius: 0.7em 0.7em 0.7em 0.7em;
119 border-radius: 0.7em 0.7em 0.7em 0.7em;
120 background-color: #F6F6F6;
121 border: 1px solid #E6E6E6;
122 border-collapse: separate;
123 margin-bottom: 2.5em;
124 }
125 pre {
126 font-size: 90%;
127 display: block;
128 overflow:hidden;
129 }
130 thead
131 {
132 margin-top: 0.5em;
133 font-weight: bold
134 }
135 th
136 {
137 padding: 0.5em 1.5em 0.5em 1em;
138 background-color: #E1E1E1;
139 border-left: 1px solid #E6E6E6;
140 }
141 td
142 {
143 padding: 0.25em 1.5em 0.25em 1em;
144 }
145
146 td.rightAlign
147 {
148 padding: 0.25em 0.5em 0.25em 1em;
149 }
150 table tr.odd
151 {
152 border-left: 1px solid #E6E6E6;
153 background-color: #F6F6F6;
154 color: black;
155 }
156 table tr.even
157 {
158 border-left: 1px solid #E6E6E6;
159 background-color: #ffffff;
160 color: #202020;
161 }
162
163 div.float-left
164 {
165 float: left; margin-right: 2em
166 }
167 div.float-right
168 {
169 float: right; margin-left: 2em
170 }
171
172 span.comment
173 {
174 color: #008B00;
175 }
176 span.string, span.char
177 {
178 color: #000084;
179 }
180 span.number
181 {
182 color: #a46200;
183 }
184 span.operator
185 {
186 color: #202020;
187 }
188 span.keyword
189 {
190 color: #840000;
191 }
192 span.name
193 {
194 color: black
195 }
196 span.type
197 {
198 font-weight: bold
199 }
200 span.type a:visited
201 {
202 color: #0F5300;
203 }
204 span.preprocessor
205 {
206 color: #404040
207 }
208/* end basic elements */
209
210/* font style elements */
211 .heading
212 {
213 font-weight: bold;
214 font-size: 125%;
215 }
216 .subtitle
217 {
218 font-size: 110%
219 }
220 .small-subtitle
221 {
222 font-size: 100%
223 }
224 .red
225 {
226 color:red;
227 }
228/* end font style elements */
229
230/* global settings*/
231 .header, .footer
232 {
233 display: block;
234 clear: both;
235 overflow: hidden;
236 }
237/* end global settings*/
238
239/* header elements */
240 .header .qtref
241 {
242 color: #00732F;
243 font-weight: bold;
244 font-size: 130%;
245 }
246
247 .header .content
248 {
249 margin-left: 5px;
250 margin-top: 5px;
251 margin-bottom: 0.5em;
252 }
253
254 .header .breadcrumb
255 {
256 font-size: 90%;
257 padding: 0.5em 0 0.5em 1em;
258 margin: 0;
259 background-color: #fafafa;
260 height: 1.35em;
261 border-bottom: 1px solid #d1d1d1;
262 }
263
264 .header .breadcrumb ul
265 {
266 margin: 0;
267 padding: 0;
268 }
269
270 .header .content
271 {
272 word-wrap: break-word;
273 }
274
275 .header .breadcrumb ul li
276 {
277 float: left;
278 background: url(../images/breadcrumb.png) no-repeat 0 3px;
279 padding-left: 1.5em;
280 margin-left: 1.5em;
281 }
282
283 .header .breadcrumb ul li.last
284 {
285 font-weight: normal;
286 }
287
288 .header .breadcrumb ul li a
289 {
290 color: #00732F;
291 }
292
293 .header .breadcrumb ul li.first
294 {
295 background-image: none;
296 padding-left: 0;
297 margin-left: 0;
298 }
299
300 .header .content ol li {
301 background: none;
302 margin-bottom: 1.0em;
303 margin-left: 1.2em;
304 padding-left: 0
305 }
306
307 .header .content li
308 {
309 background: url(../images/bullet_sq.png) no-repeat 0 5px;
310 margin-bottom: 1em;
311 padding-left: 1.2em;
312 }
313
314/* end header elements */
315
316/* content elements */
317 .content h1
318 {
319 font-weight: bold;
320 font-size: 130%
321 }
322
323 .content h2
324 {
325 font-weight: bold;
326 font-size: 120%;
327 width: 100%;
328 }
329 .content h3
330 {
331 font-weight: bold;
332 font-size: 110%;
333 width: 100%;
334 }
335 .content table p
336 {
337 margin: 0
338 }
339 .content ul
340 {
341 padding-left: 2.5em;
342 }
343 .content li
344 {
345 padding-top: 0.25em;
346 padding-bottom: 0.25em;
347 }
348 .content ul img {
349 vertical-align: middle;
350 }
351
352 .content a:visited
353 {
354 color: #4c0033;
355 text-decoration: none;
356 }
357
358 .content a:visited:hover
359 {
360 color: #4c0033;
361 text-decoration: underline;
362 }
363
364 a:hover
365 {
366 color: #4c0033;
367 text-decoration: underline;
368 }
369 descr p a
370 {
371 text-decoration: underline;
372 }
373
374 .descr p a:visited
375 {
376 text-decoration: underline;
377 }
378
379 .alphaChar{
380 width:95%;
381 background-color:#F6F6F6;
382 border:1px solid #E6E6E6;
383 -moz-border-radius: 7px 7px 7px 7px;
384 border-radius: 7px 7px 7px 7px;
385 -webkit-border-radius: 7px 7px 7px 7px;
386 font-size:12pt;
387 padding-left:10px;
388 margin-top:10px;
389 margin-bottom:10px;
390 }
391 .flowList{
392 /*vertical-align:top;*/
393 /*margin:20px auto;*/
394
395 column-count:3;
396 -webkit-column-count:3;
397 -moz-column-count:3;
398/*
399 column-width:100%;
400 -webkit-column-width:200px;
401 -col-column-width:200px;
402*/
403 column-gap:41px;
404 -webkit-column-gap:41px;
405 -moz-column-gap:41px;
406
407 column-rule: 1px dashed #ccc;
408 -webkit-column-rule: 1px dashed #ccc;
409 -moz-column-rule: 1px dashed #ccc;
410 }
411
412 .flowList dl{
413 }
414 .flowList dd{
415 /*display:inline-block;*/
416 margin-left:10px;
417 min-width:250px;
418 line-height: 1.5;
419 min-width:100%;
420 min-height:15px;
421 }
422
423 .flowList dd a{
424 }
425
426 .mainContent
427 {
428 padding-left:5px;
429 }
430
431 .content .flowList p{
432 padding:0px;
433 }
434
435 .content .alignedsummary
436 {
437 margin: 15px;
438 }
439
440
441 .qmltype
442 {
443 text-align: center;
444 font-size: 120%;
445 }
446 .qmlreadonly
447 {
448 padding-left: 5px;
449 float: right;
450 color: #254117;
451 }
452
453 .qmldefault
454 {
455 padding-left: 5px;
456 float: right;
457 color: red;
458 }
459
460 .qmldoc
461 {
462 }
463
464 .generic .alphaChar{
465 margin-top:5px;
466 }
467
468 .generic .odd .alphaChar{
469 background-color: #F6F6F6;
470 }
471
472 .generic .even .alphaChar{
473 background-color: #FFFFFF;
474 }
475
476 .memItemRight{
477 padding: 0.25em 1.5em 0.25em 0;
478 }
479 .highlightedCode
480 {
481 margin: 1.0em;
482 }
483 .annotated td {
484 padding: 0.25em 0.5em 0.25em 0.5em;
485 }
486
487 .toc
488 {
489 font-size: 80%
490 }
491
492 .header .content .toc ul
493 {
494 padding-left: 0px;
495 }
496
497 .content .toc h3 {
498 border-bottom: 0px;
499 margin-top: 0px;
500 }
501
502 .content .toc h3 a:hover {
503 color: #00732F;
504 text-decoration: none;
505 }
506
507 .content .toc .level2
508 {
509 margin-left: 1.5em;
510 }
511
512 .content .toc .level3
513 {
514 margin-left: 3.0em;
515 }
516
517 .content ul li
518 {
519 background: url(../images/bullet_sq.png) no-repeat 0 0.7em;
520 padding-left: 1em
521 }
522
523 .content .toc li
524 {
525 background: url(../images/bullet_dn.png) no-repeat 0 5px;
526 padding-left: 1em
527 }
528
529 .relpage
530 {
531 -moz-border-radius: 7px 7px 7px 7px;
532 -webkit-border-radius: 7px 7px 7px 7px;
533 border-radius: 7px 7px 7px 7px;
534 border: 1px solid #DDDDDD;
535 padding: 25px 25px;
536 clear: both;
537 }
538 .relpage ul
539 {
540 float: none;
541 padding: 1.5em;
542 }
543
544 h3.fn, span.fn
545 {
546 -moz-border-radius:7px 7px 7px 7px;
547 -webkit-border-radius:7px 7px 7px 7px;
548 border-radius:7px 7px 7px 7px;
549 background-color: #F6F6F6;
550 border-width: 1px;
551 border-style: solid;
552 border-color: #E6E6E6;
553 font-weight: bold;
554 word-spacing:3px;
555 padding:3px 5px;
556 }
557
558 .functionIndex {
559 font-size:12pt;
560 word-spacing:10px;
561 margin-bottom:10px;
562 background-color: #F6F6F6;
563 border-width: 1px;
564 border-style: solid;
565 border-color: #E6E6E6;
566 -moz-border-radius: 7px 7px 7px 7px;
567 -webkit-border-radius: 7px 7px 7px 7px;
568 border-radius: 7px 7px 7px 7px;
569 width:100%;
570 }
571
572 .centerAlign
573 {
574 text-align:center;
575 }
576
577 .rightAlign
578 {
579 text-align:right;
580 }
581
582 .leftAlign
583 {
584 text-align:left;
585 }
586
587 .topAlign{
588 vertical-align:top
589 }
590
591 .functionIndex a{
592 display:inline-block;
593 }
594
595/* end content elements */
596/* footer elements */
597
598 .footer
599 {
600 color: #393735;
601 font-size: 0.75em;
602 text-align: center;
603 padding-top: 1.5em;
604 padding-bottom: 1em;
605 background-color: #E6E7E8;
606 margin: 0;
607 }
608 .footer p
609 {
610 margin: 0.25em
611 }
612 .small
613 {
614 font-size: 0.5em;
615 }
616/* end footer elements */
617
618 .item {
619 float: left;
620 position: relative;
621 width: 100%;
622 overflow: hidden;
623 }
624
625
626 .item .primary {
627 margin-right: 220px;
628 position: relative;
629 }
630
631 .item hr {
632 margin-left: -220px;
633 }
634
635 .item .secondary {
636 float: right;
637 width: 200px;
638 position: relative;
639 }
640
641 .item .cols {
642 clear: both;
643 display: block;
644 }
645
646 .item .cols .col {
647 float: left;
648 margin-left: 1.5%;
649 }
650
651 .item .cols .col.first {
652 margin-left: 0;
653 }
654
655 .item .cols.two .col {
656 width: 45%;
657 }
658
659 .item .box {
660 margin: 0 0 10px 0;
661 }
662
663 .item .box h3 {
664 margin: 0 0 10px 0;
665 }
666
667 .cols.unclear {
668 clear:none;
669 }
670}
671
672/* end of screen media */
673
674/* start of print media */
675
676@media print
677{
678 input, textarea, .header, .footer, .toolbar, .feedback, .wrapper .hd, .wrapper .bd .sidebar, .wrapper .ft, #feedbackBox, #blurpage, .toc, .breadcrumb, .toolbar, .floatingResult
679 {
680 display: none;
681 background: none;
682 }
683 .content
684 {
685 background: none;
686 display: block;
687 width: 100%; margin: 0; float: none;
688 }
689}
690/* end of print media */
691
692
693/* modify the TOC layouts */
694div.toc ul {
695 padding-left: 20px;
696}
697div.toc li {
698 padding-left: 4px;
699}
700/* Remove the border around images*/
701a img
702{
703 border:none;
704}
705
706/*Add styling to the front pages*/
707
708.threecolumn_area
709{
710 padding-top: 20px;
711 padding-bottom: 20px;
712}
713.threecolumn_piece
714{
715 display: inline-block;
716 margin-left: 78px;
717 margin-top: 8px;
718 padding: 0;
719 vertical-align: top;
720 width: 25.5%;
721}
722div.threecolumn_piece ul {
723 list-style-type: none;
724 padding-left: 0px;
725 margin-top: 2px;
726}
727div.threecolumn_piece p {
728 margin-bottom: 7px;
729 color: #5C626E;
730 text-decoration: none;
731 font-weight: bold;
732}
733div.threecolumn_piece li {
734 padding-left: 0px;
735 margin-bottom: 5px;
736}
737div.threecolumn_piece a {
738 font-weight: normal;
739}
740/* Add style to guide page*/
741.fourcolumn_area
742{
743 padding-top: 20px;
744 padding-bottom: 20px;
745}
746.fourcolumn_piece
747{
748 display: inline-block;
749 margin-left: 35px;
750 margin-top: 8px;
751 padding: 0;
752 vertical-align: top;
753 width: 21.3%;
754}
755div.fourcolumn_piece ul {
756 list-style-type: none;
757 padding-left: 0px;
758 margin-top: 2px;
759}
760div.fourcolumn_piece p {
761 margin-bottom: 7px;
762 color: #40444D;
763 text-decoration: none;
764 font-weight: bold;
765}
766div.fourcolumn_piece li {
767 padding-left: 0px;
768 margin-bottom: 5px;
769}
770div.fourcolumn_piece a {
771 font-weight: normal;
772}
0773
=== added file 'doc/qt/cpp/css/reset.css'
--- doc/qt/cpp/css/reset.css 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/css/reset.css 2014-08-19 17:36:21 +0000
@@ -0,0 +1,8 @@
1/*
2Copyright (c) 2010, Yahoo! Inc. All rights reserved.
3Code licensed under the BSD License:
4http://developer.yahoo.com/yui/license.html
5version: 3.3.0
6build: 3167
7*/
8html{color:#000;background:#FFF;}body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,textarea,p,blockquote,th,td{margin:0;padding:0;}table{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}li{list-style:none;}caption,th{text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym{border:0;font-variant:normal;}sup{vertical-align:text-top;}sub{vertical-align:text-bottom;}input,textarea,select{font-family:inherit;font-size:inherit;font-weight:inherit;}input,textarea,select{*font-size:100%;}legend{color:#000;}
0\ No newline at end of file9\ No newline at end of file
110
=== added file 'doc/qt/cpp/css/scratch.css'
--- doc/qt/cpp/css/scratch.css 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/css/scratch.css 2014-08-19 17:36:21 +0000
@@ -0,0 +1,61 @@
1body {
2 margin: 0;
3}
4
5
6div.toc ul {
7 padding: 0;
8}
9
10div.toc li {
11 margin-bottom: 3px;
12}
13
14h1.title {
15 font-size: 36px;
16 line-height: 1.1;
17 font-weight: normal;
18}
19h0, h2 {
20 font-size: 24px;
21 line-height: 1.2;
22 margin: 14px 0;
23 font-weight: normal;
24 display: block;
25}
26a:hover {
27 color: #dd4814;
28 text-decoration: underline;
29 outline: 0;
30}
31table, pre {
32 border-radius: 0;
33}
34
35.annotated td {
36 padding: 0.8em 1em 0.3em;
37}
38.wrapper {
39 width: 940px;
40 margin: 0 auto;
41}
42.main-content {
43 width: 668px;
44 position: relative;
45 left: 270px;
46}
47.title {
48 margin-left: -270px;
49 margin-top: 30px;
50 margin-bottom: 50px;
51}
52.toc {
53 margin-left: -270px;
54 font-size: 100%;
55 margin-bottom: 40px;
56 padding: 0;
57 z-index: 2;
58 position: absolute;
59 top: 100px;
60 width: 250px;
61}
062
=== added directory 'doc/qt/cpp/examples'
=== added file 'doc/qt/cpp/examples/CMakeLists.txt'
--- doc/qt/cpp/examples/CMakeLists.txt 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/examples/CMakeLists.txt 2014-08-19 17:36:21 +0000
@@ -0,0 +1,6 @@
1include_directories(${CMAKE_SOURCE_DIR}/src/qt/include)
2add_executable(
3 networking_status
4 example_networking_status.cpp
5)
6target_link_libraries(networking_status ${CONNECTIVITY_QT_LIB_TARGET})
07
=== added file 'doc/qt/cpp/examples/example_networking_status.cpp'
--- doc/qt/cpp/examples/example_networking_status.cpp 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/examples/example_networking_status.cpp 2014-08-19 17:36:21 +0000
@@ -0,0 +1,86 @@
1/*
2 * Copyright © 2014 Canonical Ltd.
3 *
4 * This program is free software: you can redistribute it and/or modify it
5 * under the terms of the GNU Lesser General Public License version 3,
6 * as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU Lesser General Public License for more details.
12 *
13 * You should have received a copy of the GNU Lesser General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 *
16 * Authors:
17 * Antti Kaijanmäki <antti.kaijanmaki@canonical.com>
18 */
19
20#include <QCoreApplication>
21#include <QScopedPointer>
22#include <QDebug>
23
24//! [include]
25#include <ubuntu/connectivity/networking-status.h>
26using ubuntu::connectivity::NetworkingStatus;
27//! [include]
28
29int
30main(int argc, char *argv[])
31{
32 QCoreApplication app(argc, argv);
33
34 //! [create networkingstatus]
35 QScopedPointer<NetworkingStatus> ns(new NetworkingStatus());
36 //! [create networkingstatus]
37
38 //! [status]
39 // normal getter
40 if (ns->status() == NetworkingStatus::Online)
41 qDebug() << "We are online.";
42
43 // Subscribe to system networking changes
44 QObject::connect(ns.data(),
45 &NetworkingStatus::statusChanged,
46 [](NetworkingStatus::Status value)
47 {
48 switch(value) {
49 case NetworkingStatus::Offline:
50 qDebug() << "System networking status changed to: Offline";
51 break;
52 case NetworkingStatus::Connecting:
53 qDebug() << "System networking status changed to: Connecting";
54 break;
55 case NetworkingStatus::Online:
56 qDebug() << "System networking status changed to: Online";
57 break;
58 }
59 });
60 //! [status]
61
62 //! [limitations]
63 // normal getter
64 if (ns->limitations().isEmpty())
65 qDebug() << "No limitations";
66
67 // Subscribe to limitation changes
68 QObject::connect(ns.data(),
69 &NetworkingStatus::limitationsChanged,
70 [&ns](){
71 if (ns->limitations().isEmpty()) {
72 qDebug() << "No limitations.";
73 return;
74 }
75
76 qDebug() << "Limitations:";
77 if (ns->limitations().contains(NetworkingStatus::Limitations::Bandwith)) {
78 qDebug() << " - Bandwith";
79 }
80 });
81 //! [limitations]
82
83 app.exec();
84
85 return 0;
86}
087
=== added directory 'doc/qt/cpp/pages'
=== added file 'doc/qt/cpp/pages/mainpage.dox'
--- doc/qt/cpp/pages/mainpage.dox 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/pages/mainpage.dox 2014-08-19 17:36:21 +0000
@@ -0,0 +1,18 @@
1/*!
2\mainpage Ubuntu Connectivity API
3
4\tableofcontents
5
6\section sec_introduction Introduction
7
8Ubuntu Connectivity API offers a way to access the connectivity related information of the system.
9
10\section sec_general General Topics
11
12 - \ref using-cpp "Using this C++ API"
13 - \ref networking-status "Getting the networking status."
14
15\section sec_bug_reports Reporting Bugs
16If you find any problems with the or this documentation,
17please file a bug in Connectivity API [Launchpad page](https://bugs.launchpad.net/connectivity-api).
18*/
019
=== added file 'doc/qt/cpp/pages/networking-status.dox'
--- doc/qt/cpp/pages/networking-status.dox 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/pages/networking-status.dox 2014-08-19 17:36:21 +0000
@@ -0,0 +1,35 @@
1/*!
2\page networking-status Networking Status
3
4Applications needing to access the overall system networking status must access the
5ubuntu::connectivity::NetworkingStatus class. The class has properties
6for the networking status and connection limitations of the system networking.
7
8Accessing the networking status from confined applications requires
9the <i>connectivity</i> policy group.
10
11\section Setup
12
13Manager is accessed by including the appropriate header:
14\snippet example_networking_status.cpp include
15
16and then creating an instance of the NetworkingStatus:
17\snippet example_networking_status.cpp create networkingstatus
18
19\section sec_networking_status Networking Status
20
21\subsection sec_networking_status_status Status
22
23The status of the system networking can be accessed through the ubuntu::connectivity::NetworkingStatus::status property:
24\snippet example_networking_status.cpp status
25
26\subsection sec_networking_status_limitations Limitations
27
28The limitations can be accessed through the ubuntu::connectivity::NetworkingStatus::limitations property:
29\snippet example_networking_status.cpp limitations
30
31---
32The complete example (found in <i>examples/example_networking_status.cpp</i>):
33\include example_networking_status.cpp
34
35*/
036
=== added file 'doc/qt/cpp/pages/using.dox'
--- doc/qt/cpp/pages/using.dox 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/pages/using.dox 2014-08-19 17:36:21 +0000
@@ -0,0 +1,26 @@
1/*!
2\page using-cpp Using the C++ API
3
4Install the development headers:
5
6\code{.txt}
7sudo apt-get install libconnectivity-qt1-dev
8\endcode
9
10Enable c++11 and use pkg-config to get the necessary compilation flags:
11
12\code{.txt}
13$ g++ myapp.cpp -std=c++11 `pkg-config --cflags --libs connectivity-qt1` -o myapp
14\endcode
15
16The headers can then be included as:
17
18\code{.cpp}
19// includes the ubuntu::connectivity::NetworkingStatus class
20#include <ubuntu/connectivity/networking-status.h>
21\endcode
22
23<b>note:</b><br />
24Accessing the networking status from confined applications requires the <i>connectivity</i> policy group.
25
26*/
027
=== added file 'doc/qt/cpp/ubuntu-appdev-site-footer.html'
--- doc/qt/cpp/ubuntu-appdev-site-footer.html 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/ubuntu-appdev-site-footer.html 2014-08-19 17:36:21 +0000
@@ -0,0 +1,53 @@
1</div></div>
2<div class="shadow"></div>
3<footer>
4 <div>
5 <nav role="navigation" class="clearfix">
6 <ul>
7 <li><a href="/get-started">Get started</a></li>
8 <li class="page_item page-item-16"><a href="http://developer.ubuntu.com/get-started/quickly-workflow/">Quickly workflow</a></li>
9 <li class="page_item page-item-18"><a href="http://developer.ubuntu.com/get-started/qt-creator/">Qt Creator</a></li>
10 <li class="page_item page-item-20"><a href="http://developer.ubuntu.com/get-started/eclipse/">Eclipse</a></li>
11 <li class="page_item page-item-22"><a href="http://developer.ubuntu.com/get-started/monodevelop/">MonoDevelop</a></li>
12 </ul>
13 <ul>
14 <li><a href="/resources">Resources</a></li>
15 <li><a href="/resources/tools/quickly">Quickly</a></li>
16 <li><a href="/resources/platform/api">API</a></li>
17 <li><a href="/resources/platform/documentation/platform-diagram">Platform overview</a></li>
18 </ul>
19 <ul>
20 <li><a href="/publish">Publish</a></li>
21 <li class="page_item page-item-24"><a href="http://developer.ubuntu.com/publish/commercial-software-faqs/">Commercial software FAQs</a></li>
22 <li class="page_item page-item-34"><a href="http://developer.ubuntu.com/publish/application-states/">Application states</a></li>
23 <li class="page_item page-item-577"><a href="http://developer.ubuntu.com/publish/my-apps-packages/">Uploading your app</a></li>
24 <li class="page_item page-item-404"><a href="http://developer.ubuntu.com/publish/ubuntu-software-centre/">Ubuntu Software Centre</a></li>
25 <li class="page_item page-item-427"><a href="http://developer.ubuntu.com/publish/licence-key-infrastructure/">Licence key infrastructure</a></li>
26 <li class="page_item page-item-1230"><a href="http://developer.ubuntu.com/publish/updating-your-app/">Updating your app</a></li>
27 </ul>
28 <ul>
29 <li><a href="/community">Community</a></li>
30 <li class="page_item page-item-28"><a href="http://developer.ubuntu.com/community/app-developer-blog/">App Developer Blog</a></li>
31 <li class="page_item page-item-30"><a href="http://developer.ubuntu.com/community/submit-a-tutorial/">Submit a tutorial</a></li>
32 <li class="page_item page-item-32"><a href="http://developer.ubuntu.com/community/app-review-board-charter/">App Review Board charter</a></li>
33 <li class="page_item page-item-2987"><a href="http://developer.ubuntu.com/community/on-air/">On air</a>
34 <ul class='children'>
35 <li class="page_item page-item-3066"><a href="http://developer.ubuntu.com/community/on-air/recordings/">Recordings</a></li>
36 </ul>
37 </li>
38 </ul>
39 <ul class="last">
40 <li><a href="https://myapps.developer.ubuntu.com/dev">My Apps</a></li>
41 <li><a href="https://myapps.developer.ubuntu.com/openid/login/?next=/dev">Sign in or register</a></li>
42 <li><a href="https://myapps.developer.ubuntu.com/dev/account">My account</a></li>
43 </ul>
44 </nav>
45 <p>&copy; 2013 Canonical Ltd. Ubuntu and Canonical are registered trademarks of Canonical Ltd.
46 <a class="link-bug" href="https://bugs.launchpad.net/ubuntudeveloperportal/+filebug">
47 Report a bug on this site
48 </a>
49 </p>
50 </div>
51</footer>
52<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js"></script>
53<script type="text/javascript" src="http://developer.ubuntu.com/wp-content/themes/wordpress-theme-ubuntudeveloper/js/base.js"></script>\n"
054
=== added file 'doc/qt/cpp/ubuntu-appdev-site-header.html'
--- doc/qt/cpp/ubuntu-appdev-site-header.html 1970-01-01 00:00:00 +0000
+++ doc/qt/cpp/ubuntu-appdev-site-header.html 2014-08-19 17:36:21 +0000
@@ -0,0 +1,35 @@
1<header>
2 <div class="header-login">
3 <ul>
4 <li><a href="https://myapps.developer.ubuntu.com/openid/login/?next\=/dev">Sign in or register</a></li>
5 </ul>
6 </div>
7 <div class="header-navigation">
8 <div>
9 <nav role="navigation">
10 <ul>
11 <li class="page_item page-item-5"><a href="http://developer.ubuntu.com/">Home</a></li>
12 <li class="page_item page-item-7"><a href="http://developer.ubuntu.com/get-started/">Get started</a></li>
13 <li class="page_item page-item-9"><a href="http://developer.ubuntu.com/resources/">Resources</a></li>
14 <li class="page_item page-item-11"><a href="http://developer.ubuntu.com/publish/">Publish</a></li>
15 <li class="page_item page-item-13"><a href="http://developer.ubuntu.com/community/">Community</a></li>
16 <li><a href="https://myapps.developer.ubuntu.com/dev">My Apps</a></li>
17 <li>
18 <form id="form-search" method="get" action="/">
19 <fieldset>
20 <input id="input-search" type="text" name="s" value="Search" />
21 </fieldset>
22 </form>
23 </li>
24 </ul>
25 </nav>
26 <a class="logo-ubuntu" href="/"><img src="http://developer.ubuntu.com/wp-content/themes/wordpress-theme-ubuntudeveloper/img/logo-ubuntu.png" width="119" height="27" alt="Ubuntu logo" /></a>
27 <h2><a href="/">App Developer</a></h2>
28 </div>
29 </div>
30
31</header>
32<div class="wrapper">
33 <div class="main-content">\n"
34
35
036
=== added directory 'doc/qt/qml'
=== added file 'doc/qt/qml/CMakeLists.txt'
--- doc/qt/qml/CMakeLists.txt 1970-01-01 00:00:00 +0000
+++ doc/qt/qml/CMakeLists.txt 2014-08-19 17:36:21 +0000
@@ -0,0 +1,41 @@
1set(DOC_SOURCES
2 examples/example_networking_status.qml
3 qml-api/NetworkingStatus.qml
4 pages/mainpage.qdoc)
5
6# add a target to generate API documentation with qdoc
7FIND_PROGRAM(QDOC_EXECUTABLE qdoc)
8if(QDOC_EXECUTABLE)
9configure_file(${CMAKE_CURRENT_SOURCE_DIR}/connectivity-qml.qdocconf.in ${CMAKE_CURRENT_BINARY_DIR}/connectivity-qml.qdocconf @ONLY)
10add_custom_target(qmldoc
11${QDOC_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/connectivity-qml.qdocconf
12WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
13COMMENT "Generating QML API documentation with qdoc" VERBATIM
14SOURCES ${DOC_SOURCES}
15)
16
17# copy stylesheet files into build directory for shadow builds
18file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/css"
19 DESTINATION ${CMAKE_CURRENT_BINARY_DIR}
20 )
21
22# copy the API files over ot the build directery as there is a
23# bug in qt5.2 qdoc for handling absolute paths
24file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/qml-api"
25 DESTINATION ${CMAKE_CURRENT_BINARY_DIR}
26 )
27file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/pages"
28 DESTINATION ${CMAKE_CURRENT_BINARY_DIR}
29 )
30file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/examples"
31 DESTINATION ${CMAKE_CURRENT_BINARY_DIR}
32 )
33
34install(
35 DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/
36 DESTINATION ${INSTALL_DOCDIR}/qml/html/
37)
38
39endif(QDOC_EXECUTABLE)
40
41
042
=== added file 'doc/qt/qml/connectivity-qml.qdocconf.in'
--- doc/qt/qml/connectivity-qml.qdocconf.in 1970-01-01 00:00:00 +0000
+++ doc/qt/qml/connectivity-qml.qdocconf.in 2014-08-19 17:36:21 +0000
@@ -0,0 +1,55 @@
1project = Connectivity
2description = Ubuntu Connectivity QML API
3version = CONNECTIVITY_QT_VERSION_MAJOR@.@CONNECTIVITY_QT_VERSION_MINOR@
4
5outputencoding = UTF-8
6sourceencoding = UTF-8
7
8# Bug in Qt5.2 qdoc, does not support absolute paths
9# just have to hack this over and copy the files to BINARY_DIR
10#sourcedirs = @CMAKE_CURRENT_SOURCE_DIR@/pages @CMAKE_CURRENT_SOURCE_DIR@/qml-api
11#exampledirs = @CMAKE_SOURCE_DIR@/examples/
12#imagedirs = @CMAKE_CURRENT_SOURCE_DIR@/../images
13sourcedirs = pages qml-api
14exampledirs = examples/
15
16sources.fileextensions = "*.qdoc *.qml"
17headers.fileextensions = "*.h"
18examples.fileextensions = "*.js *.qml"
19examples.imageextensions = "*.png *.jpeg *.jpg"
20
21outputdir = @CMAKE_CURRENT_BINARY_DIR@/html
22outputformat = HTML
23
24outputprefixes = QML
25outputprefixes.QML = qml-
26
27HTML.templatedir = @CMAKE_CURRENT_SOURCE_DIR@/
28HTML.nobreadcrumbs = "true"
29
30HTML.stylesheets = \
31 css/reset.css \
32 css/qtquick.css \
33 css/base.css \
34 css/scratch.css
35
36HTML.headerstyles = \
37 "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/reset.css\" />\n" \
38 "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/qtquick.css\" />\n" \
39 "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/base.css\" />\n" \
40 "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/scratch.css\" />\n"
41
42HTML.postheader = \
43 " <div class=\"wrapper\">\n" \
44 " <div class=\"main-content\">\n"
45
46HTML.footer = \
47 "</div></div>\n" \
48 "<div class=\"shadow\"></div>\n" \
49 "<footer>\n" \
50 " <div>\n" \
51 " <nav role=\"navigation\" class=\"clearfix\">\n" \
52 " </nav>\n" \
53 " <p>&copy; 2014 Canonical Ltd. Ubuntu and Canonical are registered trademarks of Canonical Ltd.</p>\n" \
54 " </div>\n" \
55 "</footer>\n"
056
=== added directory 'doc/qt/qml/css'
=== added file 'doc/qt/qml/css/base.css'
--- doc/qt/qml/css/base.css 1970-01-01 00:00:00 +0000
+++ doc/qt/qml/css/base.css 2014-08-19 17:36:21 +0000
@@ -0,0 +1,638 @@
1/**
2* Ubuntu Developer base stylesheet
3*
4* A base stylesheet containing site-wide styles
5*
6* @project Ubuntu Developer
7* @version 1.0
8* @author Canonical Web Team: Steve Edwards
9* @copyright 2011 Canonical Ltd.
10*/
11
12/**
13* @section Global
14*/
15
16body {
17 font-family: 'Ubuntu', 'Ubuntu Beta', UbuntuBeta, Ubuntu, 'Bitstream Vera Sans', 'DejaVu Sans', Tahoma, sans-serif;
18 font-size: 13px;
19 line-height: 1.4;
20 color: #333;
21}
22a {
23 color: #dd4814;
24 text-decoration: none;
25 outline: 0;
26}
27p, dl {
28 margin-bottom: 10px;
29}
30strong {
31 font-weight: bold;
32}
33em {
34 font-style: italic;
35}
36code{
37 padding: 10px;
38 font-family: 'Ubuntu Mono', 'Consolas', 'Monaco', 'DejaVu Sans Mono', Courier, monospace;
39 background-color: #fdf6f2;
40 display: block;
41 margin-bottom: 10px;
42 -moz-border-radius: 4px;
43 -webkit-border-radius: 4px;
44 border-radius: 4px;
45}
46h1 {
47 font-size: 36px;
48 line-height: 1.1;
49 margin-bottom: 20px;
50}
51article h1,
52h2 {
53 font-size: 24px;
54 line-height: 1.2;
55 margin-bottom: 14px;
56}
57h3 {
58 font-size: 16px;
59 line-height: 1.3;
60 margin-bottom: 8px;
61}
62h4 {
63 font-weight: bold;
64}
65
66time {
67 color:#999;
68}
69
70/**
71* @section Structure
72*/
73
74.header-login,
75.header-navigation div,
76.header-content div {
77 margin: 0 auto;
78 width: 940px;
79}
80
81.header-content h1{
82 background-color:#ffffff;
83 display:inline-block;
84}
85
86.header-content h2{
87 background-color:#ffffff;
88 display:table;
89}
90
91.header-login ul {
92 margin: 4px 0;
93 float: right;
94}
95.header-login li {
96 margin-right: 10px;
97 float: left;
98}
99.header-login a {
100 color: #333;
101}
102.header-navigation {
103 border-top: 2px solid #dd4814;
104 border-bottom: 2px solid #dd4814;
105 background-color: #fff;
106 height: 54px;
107 clear: right;
108 overflow: hidden;
109}
110.header-navigation nav ul {
111 border-right: 1px solid #dd4814;
112 float: right;
113}
114.header-navigation nav li {
115 border-left: 1px solid #dd4814;
116 float: left;
117 height: 54px;
118}
119.header-navigation nav a {
120 padding: 18px 14px 0;
121 font-size: 14px;
122 display: block;
123 height: 36px;
124}
125.header-navigation nav a:hover {
126 background-color: #fcece7;
127}
128.header-navigation nav .current_page_item a,
129.header-navigation nav .current_page_parent a,
130.header-navigation nav .current_page_ancestor a {
131 background-color: #dd4814;
132 color: #fff;
133}
134.header-navigation input {
135 margin: 12px 10px 0 10px;
136 padding: 5px;
137 border-top: 1px solid #a1a1a1;
138 border-right: 1px solid #e0e0e0;
139 border-bottom: 1px solid #fff;
140 border-left: 1px solid #e0e0e0;
141 width: 90px;
142 font-style: italic;
143 color: #ccc;
144 -moz-border-radius: 3px;
145 -webkit-border-radius: 3px;
146 border-radius: 3px;
147 -moz-box-shadow: inset 0 1px 1px #e0e0e0;
148 -webkit-box-shadow: inset 0 1px 1px #e0e0e0;
149 box-shadow: inset 0 1px 1px #e0e0e0;
150}
151.header-navigation h2 {
152 margin: 18px 0 0 6px;
153 text-transform: lowercase;
154 font-size: 22px;
155 color: #dd4814;
156 float: left;
157}
158.header-navigation .logo-ubuntu {
159 margin-top: 12px;
160 float: left;
161}
162.header-content .header-navigation-secondary {
163 margin-bottom: 40px;
164 padding: 0;
165 position: relative;
166 z-index: 2;
167}
168.header-navigation-secondary div {
169 padding: 0;
170 border: 2px solid #dd4814;
171 -moz-border-radius: 0px 0px 4px 4px;
172 -webkit-border-radius: 0px 0px 4px 4px;
173 border-radius: 0px 0px 4px 4px;
174 background: #fff;
175 border-top: 0px;
176 width: 936px;
177}
178.header-navigation-secondary nav li {
179 float: left;
180}
181.header-navigation-secondary nav li a {
182 color: #333;
183 display: block;
184 height: 25px;
185 padding: 8px 8px 0;
186}
187.header-navigation-secondary nav li:hover,
188.header-navigation-secondary nav .current_page_item a {
189 background: url("../img/sec-nav-hover.gif");
190}
191.header-content {
192 padding-bottom: 30px;
193 border-bottom: 1px solid #e0e0e0;
194 -moz-box-shadow: 0 1px 3px #e0e0e0;
195 -webkit-box-shadow: 0 1px 3px #e0e0e0;
196 box-shadow: 0 1px 3px #e0e0e0;
197 margin-bottom: 3px;
198 position: relative;
199 overflow: hidden;
200}
201footer {
202 padding: 10px 10px 40px 10px;
203 position: relative;
204 -moz-border-radius: 0 0 4px 4px;
205 -webkit-border-radius: 0 0 4px 4px;
206 border-radius: 0 0 4px 4px;
207 font-size: 12px;
208 background: url("../img/background-footer.png") repeat scroll 0 0 #f7f6f5;
209}
210footer div {
211 margin: 0 auto;
212 padding: 0 10px;
213 width: 940px;
214}
215footer a {
216 color: #000;
217}
218footer nav ul {
219 margin: 10px 17px 30px 0;
220 width: 172px;
221 display: inline-block;
222 vertical-align: top;
223 height: auto;
224 zoom: 1;
225 *display: inline;
226}
227footer nav ul.last {
228 margin-right: 0;
229}
230footer nav li {
231 margin-bottom: 8px;
232}
233footer nav li:first-child {
234 font-weight: bold;
235}
236footer p {
237 margin-bottom: 0;
238}
239#content {
240 padding-top: 35px;
241}
242.arrow-nav {
243 display: none;
244 position: absolute;
245 top: -1px;
246 z-index: 3;
247}
248.shadow {
249 margin: 30px 0 3px 0;
250 border-bottom: 1px solid #e0e0e0;
251 -moz-box-shadow: 0 2px 3px #e0e0e0;
252 -webkit-box-shadow: 0 2px 3px #e0e0e0;
253 box-shadow: 0 2px 3px #e0e0e0;
254 height: 3px;
255}
256
257/**
258* @section Site-wide
259*/
260
261#content h2{
262 font-size:24px;
263}
264
265.box-orange {
266 padding: 10px;
267 border: 3px solid #dd4814;
268 -moz-border-radius: 4px;
269 -webkit-border-radius: 4px;
270 border-radius: 4px;
271}
272.box-orange .link-action-small {
273 float: right;
274 margin: 0 0 0 20px;
275}
276.link-bug {
277 margin-left: 10px;
278 color: #999;
279}
280.link-action {
281 float: left;
282 margin-bottom: 20px;
283 padding: 8px 12px;
284 display: block;
285 background-color: #dd4814;
286 color: #fff;
287 -moz-border-radius: 20px;
288 -webkit-border-radius: 20px;
289 border-radius: 20px;
290 font-size: 16px;
291 line-height: 1.3;
292 border-top: 3px solid #e6633a;
293 border-bottom: 3px solid #c03d14;
294}
295.link-action2 {
296 float: left;
297 display: block;
298 color: #fff;
299 font-size: 16px;
300 line-height: 1.3;
301}
302.link-action2 span{
303 display:block;
304 float:left;
305}
306.link-action2 .cta-left{
307 background:url(../img/button-cta-left.png) no-repeat;
308 width:22px;
309 height:48px;
310}
311.link-action2 .cta-center{
312 background:url(../img/button-cta-slice.png) repeat-x;
313 line-height:45px;
314 height:48px;
315}
316.link-action2 .cta-right{
317 background:url(../img/button-cta-right.png) no-repeat;
318 width:22px;
319 height:48px;
320}
321
322.link-action-small {
323 float: left;
324 display: block;
325 color: #fff;
326 font-size: 16px;
327}
328.link-action-small span{
329 display:block;
330 float:left;
331 height:42px;
332}
333.link-action-small .cta-left{
334 background:url(../img/button-cta-left-small.png) no-repeat;
335 width:19px;
336}
337.link-action-small .cta-center{
338 background:url(../img/button-cta-slice-small.png) repeat-x;
339 line-height:42px;
340}
341.link-action-small .cta-right{
342 background:url(../img/button-cta-right-small.png) no-repeat;
343 width:19px;
344}
345
346.link-action:active {
347 position: relative;
348 top: 1px;
349}
350.link-action2:active {
351 position: relative;
352 top: 1px;
353}
354.link-action-small:active {
355 position: relative;
356 top: 1px;
357}
358.list-bullets li {
359 margin-bottom: 10px;
360 list-style: disc;
361 list-style-position: inside;
362}
363.box {
364 margin-bottom: 30px;
365 padding: 15px;
366 border: 1px solid #aea79f;
367 -moz-border-radius: 4px;
368 -webkit-border-radius: 4px;
369 border-radius: 4px;
370}
371.box-padded {
372 margin-bottom: 30px;
373 padding: 5px;
374 border: 2px solid #aea79f;
375 -moz-border-radius: 4px;
376 -webkit-border-radius: 4px;
377 border-radius: 4px;
378 background: url("../img/pattern-featured.gif") repeat scroll 0 0 #ebe9e7;
379 overflow: hidden;
380}
381.box-padded h3 {
382 margin: 5px 0 10px 5px;
383}
384.box-padded div {
385 padding: 10px;
386 border: 1px solid #aea79f;
387 -moz-border-radius: 4px;
388 -webkit-border-radius: 4px;
389 border-radius: 4px;
390 background-color: #fff;
391 overflow: hidden;
392}
393.box-padded li {
394 padding: 0 10px;
395 float: left;
396 width: 211px;
397 border-right: 1px dotted #aea79f;
398}
399.box-padded li.first {
400 padding: 0;
401 margin-bottom: 0;
402}
403.box-padded li.last {
404 border: 0;
405 width: 217px;
406}
407.box-padded img {
408 margin: 0 10px 50px 0;
409 float: left;
410 -moz-border-radius: 8px;
411 -webkit-border-radius: 8px;
412 border-radius: 8px;
413}
414.box-clear {
415 margin-bottom: 40px;
416}
417.box-clear .grid-4.first {
418 margin-right: 15px;
419 padding-right: 15px;
420}
421.box-clear .grid-4 {
422 margin-left: 0;
423 margin-right: 10px;
424 padding-right: 10px;
425 width: 298px;
426}
427.box-clear time {
428 display: block;
429 border-bottom: 1px dotted #aea79f;
430 padding-bottom: 10px;
431 margin-bottom: 10px;
432}
433.box-clear div.first {
434 border-right: 1px dotted #aea79f;
435}
436.box-clear a {
437 display: block;
438}
439.box-clear .rss {
440 background: url("../img/rss.jpg") no-repeat scroll 0 center;
441 padding-left: 20px;
442}
443.box-clear .location {
444 display: block;
445 margin-bottom: 1px;
446}
447.box-clear .last {
448 margin: 0;
449 padding-right: 0;
450 -moz-border-radius: 4px;
451 -webkit-border-radius: 4px;
452 border-radius: 4px;
453 width: 293px;
454}
455
456/* Widgets */
457
458.ui-state-focus {
459 outline: none;
460}
461.ui-accordion {
462 border-bottom: 1px dotted #aea79f;
463}
464.ui-accordion a {
465 display: block;
466}
467.ui-accordion h3 {
468 margin-bottom: 0;
469 border-top: 1px dotted #aea79f;
470 position: relative;
471 font-size: 13px;
472 font-weight: bold;
473}
474.ui-accordion h3 a {
The diff has been truncated for viewing.

Subscribers

People subscribed via source and target branches