# Merge lp:~alan-griffiths/mir/fix-1668651 into lp:mir

Proposed by Alan Griffiths
Reviewer Review Type Date Requested Status
Mir development team Pending

### Commit message

Untangle part of the (largely hidden) miral-shell shutdown mess.

### Description of the change

Untangle part of the miral-shell shutdown mess.

Closing the server caused the internal client to kill the server with SIGHUP which "just" resulted in an EXIT_FAILURE.

The server now closes cleanly (but the client code doesn't clear down correctly - working on that in a follow-up).

## Unmerged revisions

526. By Alan Griffiths

525. By Alan Griffiths

Don't kill the server with a SIGHUP

524. By Alan Griffiths

Don't treat workaround window as a titlebar

523. By Alan Griffiths

Update debian/changelog

522. By Alan Griffiths

[mirclientcpp] Avoid unnecessary include of deprecated functions

521. By Alan Griffiths

[libmiral] Fix initialization order so that policies can allocate workspaces when constructed

520. By Alan Griffiths

[libmiral] Workaround for server crash (LP: #1667645)

519. By Alan Griffiths

[libmirclientcpp] Prevent accidental double-release by deleting release functions for handle classes

518. By Alan Griffiths

[miral-kiosk] Use libmirclientcpp where possible

517. By Alan Griffiths

 1 === added directory '.bzr-builddeb' 2 === renamed directory '.bzr-builddeb' => '.bzr-builddeb.moved' 3 === added file '.bzr-builddeb/default.conf' 4 --- .bzr-builddeb/default.conf 1970-01-01 00:00:00 +0000 5 +++ .bzr-builddeb/default.conf 2017-03-01 12:28:42 +0000 6 @@ -0,0 +1,2 @@ 7 1 [BUILDDEB] 8 2 split = True 9 0 3 10 === added file '.bzrignore' 11 --- .bzrignore 1970-01-01 00:00:00 +0000 12 +++ .bzrignore 2017-03-01 12:28:42 +0000 13 @@ -0,0 +1,3 @@ 14 1 include/mir/client/detail/mir_features.h 15 2 include/miral/version.h 16 3 .idea 17 0 4 18 === renamed file '.bzrignore' => '.bzrignore.moved' 19 === added file 'CMakeLists.txt' 20 --- CMakeLists.txt 1970-01-01 00:00:00 +0000 21 +++ CMakeLists.txt 2017-03-01 12:28:42 +0000 22 @@ -0,0 +1,78 @@ 23 1 cmake_minimum_required(VERSION 3.1) 24 2 project(miral) 25 3 26 4 if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) 27 5 set(CMAKE_INSTALL_PREFIX "/usr" CACHE PATH "/usr install prefix" FORCE) 28 6 endif() 29 7 30 8 include (GNUInstallDirs) 31 9 include(CheckCXXCompilerFlag) 32 10 33 11 cmake_policy(SET CMP0015 NEW) 34 12 cmake_policy(SET CMP0022 NEW) 35 13 36 14 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH}${CMAKE_CURRENT_SOURCE_DIR}/cmake) 37 15 38 16 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) 39 17 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY${CMAKE_BINARY_DIR}/lib) 40 18 41 19 set(CMAKE_CXX_STANDARD 14) 42 20 set(CMAKE_CXX_STANDARD_REQUIRED on) 43 21 set(CMAKE_CXX_EXTENSIONS off) 44 22 45 23 set(CMAKE_C_STANDARD 99) 46 24 set(CMAKE_C_STANDARD_REQUIRED on) 47 25 set(CMAKE_C_EXTENSIONS off) 48 26 49 27 set(MIRAL_COMPILER_FLAGS "-pthread -g -Werror -Wall -pedantic -Wextra -fPIC") 50 28 set(MIRAL_LINKER_FLAGS "-Wl,-z,defs") 51 29 52 30 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS}${MIRAL_COMPILER_FLAGS}") 53 31 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}${MIRAL_COMPILER_FLAGS} -Wnon-virtual-dtor") 54 32 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-long-long") # fix spurious FTBFS on X+O 55 33 set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${MIRAL_LINKER_FLAGS}") 56 34 set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} ${MIRAL_LINKER_FLAGS}") 57 35 set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${MIRAL_LINKER_FLAGS}") 58 36 59 37 include(FindPkgConfig) 60 38 61 39 pkg_check_modules(MIRCLIENT mirclient>=0.20 REQUIRED) 62 40 63 41 include_directories(include SYSTEM${MIRCLIENT_INCLUDE_DIRS}) 64 42 65 43 set(MIRAL_VERSION_MAJOR 1) 66 44 set(MIRAL_VERSION_MINOR 3) 67 45 set(MIRAL_VERSION_PATCH 0) 68 46 69 47 set(MIRAL_VERSION ${MIRAL_VERSION_MAJOR}.${MIRAL_VERSION_MINOR}.${MIRAL_VERSION_PATCH}) 70 48 71 49 add_subdirectory(miral) 72 50 add_subdirectory(miral-shell) 73 51 add_subdirectory(miral-kiosk) 74 52 75 53 pkg_check_modules(MIRTEST mirtest) 76 54 if(NOT MIRTEST_FOUND) 77 55 message(WARNING "mirtest-dev package not installed - tests cannot be built") 78 56 else() 79 57 if (MIRTEST_VERSION VERSION_LESS 0.24) 80 58 # building the tests is disabled by default because the mirtest-dev package is broken on xenial 81 59 # (lp:1583536 and lp:1603080) 82 60 option(MIRAL_ENABLE_TESTS "Build tests" off) 83 61 else() 84 62 option(MIRAL_ENABLE_TESTS "Build tests" on) 85 63 endif() 86 64 87 65 if (MIRAL_ENABLE_TESTS) 88 66 enable_testing() 89 67 find_package(GMock REQUIRED) 90 68 add_subdirectory(test) 91 69 endif() 92 70 endif() 93 71 94 72 include (cmake/Doxygen.cmake) 95 73 96 74 if(TARGET doc) 97 75 add_custom_target(symbols 98 76${CMAKE_SOURCE_DIR}/scripts/process_doxygen_xml.py ${CMAKE_BINARY_DIR}/doc/xml/*.xml >${CMAKE_SOURCE_DIR}/miral/symbols.map 99 77 DEPENDS doc) 100 78 endif() 101 0 79 102 === renamed file 'CMakeLists.txt' => 'CMakeLists.txt.moved' 103 === added file 'COPYING' 104 --- COPYING 1970-01-01 00:00:00 +0000 105 +++ COPYING 2017-03-01 12:28:42 +0000 106 @@ -0,0 +1,674 @@ 107 1 GNU GENERAL PUBLIC LICENSE 108 2 Version 3, 29 June 2007 109 3 110 4 Copyright (C) 2007 Free Software Foundation, Inc. 111 5 Everyone is permitted to copy and distribute verbatim copies 112 6 of this license document, but changing it is not allowed. 113 7 114 8 Preamble 115 9 116 10 The GNU General Public License is a free, copyleft license for 117 11 software and other kinds of works. 118 12 119 13 The licenses for most software and other practical works are designed 120 14 to take away your freedom to share and change the works. By contrast, 121 15 the GNU General Public License is intended to guarantee your freedom to 122 16 share and change all versions of a program--to make sure it remains free 123 17 software for all its users. We, the Free Software Foundation, use the 124 18 GNU General Public License for most of our software; it applies also to 125 19 any other work released this way by its authors. You can apply it to 126 20 your programs, too. 127 21 128 22 When we speak of free software, we are referring to freedom, not 129 23 price. Our General Public Licenses are designed to make sure that you 130 24 have the freedom to distribute copies of free software (and charge for 131 25 them if you wish), that you receive source code or can get it if you 132 26 want it, that you can change the software or use pieces of it in new 133 27 free programs, and that you know you can do these things. 134 28 135 29 To protect your rights, we need to prevent others from denying you 136 30 these rights or asking you to surrender the rights. Therefore, you have 137 31 certain responsibilities if you distribute copies of the software, or if 138 32 you modify it: responsibilities to respect the freedom of others. 139 33 140 34 For example, if you distribute copies of such a program, whether 141 35 gratis or for a fee, you must pass on to the recipients the same 142 36 freedoms that you received. You must make sure that they, too, receive 143 37 or can get the source code. And you must show them these terms so they 144 38 know their rights. 145 39 146 40 Developers that use the GNU GPL protect your rights with two steps: 147 41 (1) assert copyright on the software, and (2) offer you this License 148 42 giving you legal permission to copy, distribute and/or modify it. 149 43 150 44 For the developers' and authors' protection, the GPL clearly explains 151 45 that there is no warranty for this free software. For both users' and 152 46 authors' sake, the GPL requires that modified versions be marked as 153 47 changed, so that their problems will not be attributed erroneously to 154 48 authors of previous versions. 155 49 156 50 Some devices are designed to deny users access to install or run 157 51 modified versions of the software inside them, although the manufacturer 158 52 can do so. This is fundamentally incompatible with the aim of 159 53 protecting users' freedom to change the software. The systematic 160 54 pattern of such abuse occurs in the area of products for individuals to 161 55 use, which is precisely where it is most unacceptable. Therefore, we 162 56 have designed this version of the GPL to prohibit the practice for those 163 57 products. If such problems arise substantially in other domains, we 164 58 stand ready to extend this provision to those domains in future versions 165 59 of the GPL, as needed to protect the freedom of users. 166 60 167 61 Finally, every program is threatened constantly by software patents. 168 62 States should not allow patents to restrict development and use of 169 63 software on general-purpose computers, but in those that do, we wish to 170 64 avoid the special danger that patents applied to a free program could 171 65 make it effectively proprietary. To prevent this, the GPL assures that 172 66 patents cannot be used to render the program non-free. 173 67 174 68 The precise terms and conditions for copying, distribution and 175 69 modification follow. 176 70 177 71 TERMS AND CONDITIONS 178 72 179 73 0. Definitions. 180 74 181 75 "This License" refers to version 3 of the GNU General Public License. 182 76 183 77 "Copyright" also means copyright-like laws that apply to other kinds of 184 78 works, such as semiconductor masks. 185 79 186 80 "The Program" refers to any copyrightable work licensed under this 187 81 License. Each licensee is addressed as "you". "Licensees" and 188 82 "recipients" may be individuals or organizations. 189 83 190 84 To "modify" a work means to copy from or adapt all or part of the work 191 85 in a fashion requiring copyright permission, other than the making of an 192 86 exact copy. The resulting work is called a "modified version" of the 193 87 earlier work or a work "based on" the earlier work. 194 88 195 89 A "covered work" means either the unmodified Program or a work based 196 90 on the Program. 197 91 198 92 To "propagate" a work means to do anything with it that, without 199 93 permission, would make you directly or secondarily liable for 200 94 infringement under applicable copyright law, except executing it on a 201 95 computer or modifying a private copy. Propagation includes copying, 202 96 distribution (with or without modification), making available to the 203 97 public, and in some countries other activities as well. 204 98 205 99 To "convey" a work means any kind of propagation that enables other 206 100 parties to make or receive copies. Mere interaction with a user through 207 101 a computer network, with no transfer of a copy, is not conveying. 208 102 209 103 An interactive user interface displays "Appropriate Legal Notices" 210 104 to the extent that it includes a convenient and prominently visible 211 105 feature that (1) displays an appropriate copyright notice, and (2) 212 106 tells the user that there is no warranty for the work (except to the 213 107 extent that warranties are provided), that licensees may convey the 214 108 work under this License, and how to view a copy of this License. If 215 109 the interface presents a list of user commands or options, such as a 216 110 menu, a prominent item in the list meets this criterion. 217 111 218 112 1. Source Code. 219 113 220 114 The "source code" for a work means the preferred form of the work 221 115 for making modifications to it. "Object code" means any non-source 222 116 form of a work. 223 117 224 118 A "Standard Interface" means an interface that either is an official 225 119 standard defined by a recognized standards body, or, in the case of 226 120 interfaces specified for a particular programming language, one that 227 121 is widely used among developers working in that language. 228 122 229 123 The "System Libraries" of an executable work include anything, other 230 124 than the work as a whole, that (a) is included in the normal form of 231 125 packaging a Major Component, but which is not part of that Major 232 126 Component, and (b) serves only to enable use of the work with that 233 127 Major Component, or to implement a Standard Interface for which an 234 128 implementation is available to the public in source code form. A 235 129 "Major Component", in this context, means a major essential component 236 130 (kernel, window system, and so on) of the specific operating system 237 131 (if any) on which the executable work runs, or a compiler used to 238 132 produce the work, or an object code interpreter used to run it. 239 133 240 134 The "Corresponding Source" for a work in object code form means all 241 135 the source code needed to generate, install, and (for an executable 242 136 work) run the object code and to modify the work, including scripts to 243 137 control those activities. However, it does not include the work's 244 138 System Libraries, or general-purpose tools or generally available free 245 139 programs which are used unmodified in performing those activities but 246 140 which are not part of the work. For example, Corresponding Source 247 141 includes interface definition files associated with source files for 248 142 the work, and the source code for shared libraries and dynamically 249 143 linked subprograms that the work is specifically designed to require, 250 144 such as by intimate data communication or control flow between those 251 145 subprograms and other parts of the work. 252 146 253 147 The Corresponding Source need not include anything that users 254 148 can regenerate automatically from other parts of the Corresponding 255 149 Source. 256 150 257 151 The Corresponding Source for a work in source code form is that 258 152 same work. 259 153 260 154 2. Basic Permissions. 261 155 262 156 All rights granted under this License are granted for the term of 263 157 copyright on the Program, and are irrevocable provided the stated 264 158 conditions are met. This License explicitly affirms your unlimited 265 159 permission to run the unmodified Program. The output from running a 266 160 covered work is covered by this License only if the output, given its 267 161 content, constitutes a covered work. This License acknowledges your 268 162 rights of fair use or other equivalent, as provided by copyright law. 269 163 270 164 You may make, run and propagate covered works that you do not 271 165 convey, without conditions so long as your license otherwise remains 272 166 in force. You may convey covered works to others for the sole purpose 273 167 of having them make modifications exclusively for you, or provide you 274 168 with facilities for running those works, provided that you comply with 275 169 the terms of this License in conveying all material for which you do 276 170 not control copyright. Those thus making or running the covered works 277 171 for you must do so exclusively on your behalf, under your direction 278 172 and control, on terms that prohibit them from making any copies of 279 173 your copyrighted material outside their relationship with you. 280 174 281 175 Conveying under any other circumstances is permitted solely under 282 176 the conditions stated below. Sublicensing is not allowed; section 10 283 177 makes it unnecessary. 284 178 285 179 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 286 180 287 181 No covered work shall be deemed part of an effective technological 288 182 measure under any applicable law fulfilling obligations under article 289 183 11 of the WIPO copyright treaty adopted on 20 December 1996, or 290 184 similar laws prohibiting or restricting circumvention of such 291 185 measures. 292 186 293 187 When you convey a covered work, you waive any legal power to forbid 294 188 circumvention of technological measures to the extent such circumvention 295 189 is effected by exercising rights under this License with respect to 296 190 the covered work, and you disclaim any intention to limit operation or 297 191 modification of the work as a means of enforcing, against the work's 298 192 users, your or third parties' legal rights to forbid circumvention of 299 193 technological measures. 300 194 301 195 4. Conveying Verbatim Copies. 302 196 303 197 You may convey verbatim copies of the Program's source code as you 304 198 receive it, in any medium, provided that you conspicuously and 305 199 appropriately publish on each copy an appropriate copyright notice; 306 200 keep intact all notices stating that this License and any 307 201 non-permissive terms added in accord with section 7 apply to the code; 308 202 keep intact all notices of the absence of any warranty; and give all 309 203 recipients a copy of this License along with the Program. 310 204 311 205 You may charge any price or no price for each copy that you convey, 312 206 and you may offer support or warranty protection for a fee. 313 207 314 208 5. Conveying Modified Source Versions. 315 209 316 210 You may convey a work based on the Program, or the modifications to 317 211 produce it from the Program, in the form of source code under the 318 212 terms of section 4, provided that you also meet all of these conditions: 319 213 320 214 a) The work must carry prominent notices stating that you modified 321 215 it, and giving a relevant date. 322 216 323 217 b) The work must carry prominent notices stating that it is 324 218 released under this License and any conditions added under section 325 219 7. This requirement modifies the requirement in section 4 to 326 220 "keep intact all notices". 327 221 328 222 c) You must license the entire work, as a whole, under this 329 223 License to anyone who comes into possession of a copy. This 330 224 License will therefore apply, along with any applicable section 7 331 225 additional terms, to the whole of the work, and all its parts, 332 226 regardless of how they are packaged. This License gives no 333 227 permission to license the work in any other way, but it does not 334 228 invalidate such permission if you have separately received it. 335 229 336 230 d) If the work has interactive user interfaces, each must display 337 231 Appropriate Legal Notices; however, if the Program has interactive 338 232 interfaces that do not display Appropriate Legal Notices, your 339 233 work need not make them do so. 340 234 341 235 A compilation of a covered work with other separate and independent 342 236 works, which are not by their nature extensions of the covered work, 343 237 and which are not combined with it such as to form a larger program, 344 238 in or on a volume of a storage or distribution medium, is called an 345 239 "aggregate" if the compilation and its resulting copyright are not 346 240 used to limit the access or legal rights of the compilation's users 347 241 beyond what the individual works permit. Inclusion of a covered work 348 242 in an aggregate does not cause this License to apply to the other 349 243 parts of the aggregate. 350 244 351 245 6. Conveying Non-Source Forms. 352 246 353 247 You may convey a covered work in object code form under the terms 354 248 of sections 4 and 5, provided that you also convey the 355 249 machine-readable Corresponding Source under the terms of this License, 356 250 in one of these ways: 357 251 358 252 a) Convey the object code in, or embodied in, a physical product 359 253 (including a physical distribution medium), accompanied by the 360 254 Corresponding Source fixed on a durable physical medium 361 255 customarily used for software interchange. 362 256 363 257 b) Convey the object code in, or embodied in, a physical product 364 258 (including a physical distribution medium), accompanied by a 365 259 written offer, valid for at least three years and valid for as 366 260 long as you offer spare parts or customer support for that product 367 261 model, to give anyone who possesses the object code either (1) a 368 262 copy of the Corresponding Source for all the software in the 369 263 product that is covered by this License, on a durable physical 370 264 medium customarily used for software interchange, for a price no 371 265 more than your reasonable cost of physically performing this 372 266 conveying of source, or (2) access to copy the 373 267 Corresponding Source from a network server at no charge. 374 268 375 269 c) Convey individual copies of the object code with a copy of the 376 270 written offer to provide the Corresponding Source. This 377 271 alternative is allowed only occasionally and noncommercially, and 378 272 only if you received the object code with such an offer, in accord 379 273 with subsection 6b. 380 274 381 275 d) Convey the object code by offering access from a designated 382 276 place (gratis or for a charge), and offer equivalent access to the 383 277 Corresponding Source in the same way through the same place at no 384 278 further charge. You need not require recipients to copy the 385 279 Corresponding Source along with the object code. If the place to 386 280 copy the object code is a network server, the Corresponding Source 387 281 may be on a different server (operated by you or a third party) 388 282 that supports equivalent copying facilities, provided you maintain 389 283 clear directions next to the object code saying where to find the 390 284 Corresponding Source. Regardless of what server hosts the 391 285 Corresponding Source, you remain obligated to ensure that it is 392 286 available for as long as needed to satisfy these requirements. 393 287 394 288 e) Convey the object code using peer-to-peer transmission, provided 395 289 you inform other peers where the object code and Corresponding 396 290 Source of the work are being offered to the general public at no 397 291 charge under subsection 6d. 398 292 399 293 A separable portion of the object code, whose source code is excluded 400 294 from the Corresponding Source as a System Library, need not be 401 295 included in conveying the object code work. 402 296 403 297 A "User Product" is either (1) a "consumer product", which means any 404 298 tangible personal property which is normally used for personal, family, 405 299 or household purposes, or (2) anything designed or sold for incorporation 406 300 into a dwelling. In determining whether a product is a consumer product, 407 301 doubtful cases shall be resolved in favor of coverage. For a particular 408 302 product received by a particular user, "normally used" refers to a 409 303 typical or common use of that class of product, regardless of the status 410 304 of the particular user or of the way in which the particular user 411 305 actually uses, or expects or is expected to use, the product. A product 412 306 is a consumer product regardless of whether the product has substantial 413 307 commercial, industrial or non-consumer uses, unless such uses represent 414 308 the only significant mode of use of the product. 415 309 416 310 "Installation Information" for a User Product means any methods, 417 311 procedures, authorization keys, or other information required to install 418 312 and execute modified versions of a covered work in that User Product from 419 313 a modified version of its Corresponding Source. The information must 420 314 suffice to ensure that the continued functioning of the modified object 421 315 code is in no case prevented or interfered with solely because 422 316 modification has been made. 423 317 424 318 If you convey an object code work under this section in, or with, or 425 319 specifically for use in, a User Product, and the conveying occurs as 426 320 part of a transaction in which the right of possession and use of the 427 321 User Product is transferred to the recipient in perpetuity or for a 428 322 fixed term (regardless of how the transaction is characterized), the 429 323 Corresponding Source conveyed under this section must be accompanied 430 324 by the Installation Information. But this requirement does not apply 431 325 if neither you nor any third party retains the ability to install 432 326 modified object code on the User Product (for example, the work has 433 327 been installed in ROM). 434 328 435 329 The requirement to provide Installation Information does not include a 436 330 requirement to continue to provide support service, warranty, or updates 437 331 for a work that has been modified or installed by the recipient, or for 438 332 the User Product in which it has been modified or installed. Access to a 439 333 network may be denied when the modification itself materially and 440 334 adversely affects the operation of the network or violates the rules and 441 335 protocols for communication across the network. 442 336 443 337 Corresponding Source conveyed, and Installation Information provided, 444 338 in accord with this section must be in a format that is publicly 445 339 documented (and with an implementation available to the public in 446 340 source code form), and must require no special password or key for 447 341 unpacking, reading or copying. 448 342 449 343 7. Additional Terms. 450 344 451 345 "Additional permissions" are terms that supplement the terms of this 452 346 License by making exceptions from one or more of its conditions. 453 347 Additional permissions that are applicable to the entire Program shall 454 348 be treated as though they were included in this License, to the extent 455 349 that they are valid under applicable law. If additional permissions 456 350 apply only to part of the Program, that part may be used separately 457 351 under those permissions, but the entire Program remains governed by 458 352 this License without regard to the additional permissions. 459 353 460 354 When you convey a copy of a covered work, you may at your option 461 355 remove any additional permissions from that copy, or from any part of 462 356 it. (Additional permissions may be written to require their own 463 357 removal in certain cases when you modify the work.) You may place 464 358 additional permissions on material, added by you to a covered work, 465 359 for which you have or can give appropriate copyright permission. 466 360 467 361 Notwithstanding any other provision of this License, for material you 468 362 add to a covered work, you may (if authorized by the copyright holders of 469 363 that material) supplement the terms of this License with terms: 470 364 471 365 a) Disclaiming warranty or limiting liability differently from the 472 366 terms of sections 15 and 16 of this License; or 473 367 474 368 b) Requiring preservation of specified reasonable legal notices or 475 369 author attributions in that material or in the Appropriate Legal 476 370 Notices displayed by works containing it; or 477 371 478 372 c) Prohibiting misrepresentation of the origin of that material, or 479 373 requiring that modified versions of such material be marked in 480 374 reasonable ways as different from the original version; or 481 375 482 376 d) Limiting the use for publicity purposes of names of licensors or 483 377 authors of the material; or 484 378 485 379 e) Declining to grant rights under trademark law for use of some 486 380 trade names, trademarks, or service marks; or 487 381 488 382 f) Requiring indemnification of licensors and authors of that 489 383 material by anyone who conveys the material (or modified versions of 490 384 it) with contractual assumptions of liability to the recipient, for 491 385 any liability that these contractual assumptions directly impose on 492 386 those licensors and authors. 493 387 494 388 All other non-permissive additional terms are considered "further 495 389 restrictions" within the meaning of section 10. If the Program as you 496 390 received it, or any part of it, contains a notice stating that it is 497 391 governed by this License along with a term that is a further 498 392 restriction, you may remove that term. If a license document contains 499 393 a further restriction but permits relicensing or conveying under this 500 394 License, you may add to a covered work material governed by the terms 501 395 of that license document, provided that the further restriction does 502 396 not survive such relicensing or conveying. 503 397 504 398 If you add terms to a covered work in accord with this section, you 505 399 must place, in the relevant source files, a statement of the 506 400 additional terms that apply to those files, or a notice indicating 507 401 where to find the applicable terms. 508 402 509 403 Additional terms, permissive or non-permissive, may be stated in the 510 404 form of a separately written license, or stated as exceptions; 511 405 the above requirements apply either way. 512 406 513 407 8. Termination. 514 408 515 409 You may not propagate or modify a covered work except as expressly 516 410 provided under this License. Any attempt otherwise to propagate or 517 411 modify it is void, and will automatically terminate your rights under 518 412 this License (including any patent licenses granted under the third 519 413 paragraph of section 11). 520 414 521 415 However, if you cease all violation of this License, then your 522 416 license from a particular copyright holder is reinstated (a) 523 417 provisionally, unless and until the copyright holder explicitly and 524 418 finally terminates your license, and (b) permanently, if the copyright 525 419 holder fails to notify you of the violation by some reasonable means 526 420 prior to 60 days after the cessation. 527 421 528 422 Moreover, your license from a particular copyright holder is 529 423 reinstated permanently if the copyright holder notifies you of the 530 424 violation by some reasonable means, this is the first time you have 531 425 received notice of violation of this License (for any work) from that 532 426 copyright holder, and you cure the violation prior to 30 days after 533 427 your receipt of the notice. 534 428 535 429 Termination of your rights under this section does not terminate the 536 430 licenses of parties who have received copies or rights from you under 537 431 this License. If your rights have been terminated and not permanently 538 432 reinstated, you do not qualify to receive new licenses for the same 539 433 material under section 10. 540 434 541 435 9. Acceptance Not Required for Having Copies. 542 436 543 437 You are not required to accept this License in order to receive or 544 438 run a copy of the Program. Ancillary propagation of a covered work 545 439 occurring solely as a consequence of using peer-to-peer transmission 546 440 to receive a copy likewise does not require acceptance. However, 547 441 nothing other than this License grants you permission to propagate or 548 442 modify any covered work. These actions infringe copyright if you do 549 443 not accept this License. Therefore, by modifying or propagating a 550 444 covered work, you indicate your acceptance of this License to do so. 551 445 552 446 10. Automatic Licensing of Downstream Recipients. 553 447 554 448 Each time you convey a covered work, the recipient automatically 555 449 receives a license from the original licensors, to run, modify and 556 450 propagate that work, subject to this License. You are not responsible 557 451 for enforcing compliance by third parties with this License. 558 452 559 453 An "entity transaction" is a transaction transferring control of an 560 454 organization, or substantially all assets of one, or subdividing an 561 455 organization, or merging organizations. If propagation of a covered 562 456 work results from an entity transaction, each party to that 563 457 transaction who receives a copy of the work also receives whatever 564 458 licenses to the work the party's predecessor in interest had or could 565 459 give under the previous paragraph, plus a right to possession of the 566 460 Corresponding Source of the work from the predecessor in interest, if 567 461 the predecessor has it or can get it with reasonable efforts. 568 462 569 463 You may not impose any further restrictions on the exercise of the 570 464 rights granted or affirmed under this License. For example, you may 571 465 not impose a license fee, royalty, or other charge for exercise of 572 466 rights granted under this License, and you may not initiate litigation 573 467 (including a cross-claim or counterclaim in a lawsuit) alleging that 574 468 any patent claim is infringed by making, using, selling, offering for 575 469 sale, or importing the Program or any portion of it. 576 470 577 471 11. Patents. 578 472 579 473 A "contributor" is a copyright holder who authorizes use under this 580 474 License of the Program or a work on which the Program is based. The 581 475 work thus licensed is called the contributor's "contributor version". 582 476 583 477 A contributor's "essential patent claims" are all patent claims 584 478 owned or controlled by the contributor, whether already acquired or 585 479 hereafter acquired, that would be infringed by some manner, permitted 586 480 by this License, of making, using, or selling its contributor version, 587 481 but do not include claims that would be infringed only as a 588 482 consequence of further modification of the contributor version. For 589 483 purposes of this definition, "control" includes the right to grant 590 484 patent sublicenses in a manner consistent with the requirements of 591 485 this License. 592 486 593 487 Each contributor grants you a non-exclusive, worldwide, royalty-free 594 488 patent license under the contributor's essential patent claims, to 595 489 make, use, sell, offer for sale, import and otherwise run, modify and 596 490 propagate the contents of its contributor version. 597 491 598 492 In the following three paragraphs, a "patent license" is any express 599 493 agreement or commitment, however denominated, not to enforce a patent 600 494 (such as an express permission to practice a patent or covenant not to 601 495 sue for patent infringement). To "grant" such a patent license to a 602 496 party means to make such an agreement or commitment not to enforce a 603 497 patent against the party. 604 498 605 499 If you convey a covered work, knowingly relying on a patent license, 606 500 and the Corresponding Source of the work is not available for anyone 607 501 to copy, free of charge and under the terms of this License, through a 608 502 publicly available network server or other readily accessible means, 609 503 then you must either (1) cause the Corresponding Source to be so 610 504 available, or (2) arrange to deprive yourself of the benefit of the 611 505 patent license for this particular work, or (3) arrange, in a manner 612 506 consistent with the requirements of this License, to extend the patent 613 507 license to downstream recipients. "Knowingly relying" means you have 614 508 actual knowledge that, but for the patent license, your conveying the 615 509 covered work in a country, or your recipient's use of the covered work 616 510 in a country, would infringe one or more identifiable patents in that 617 511 country that you have reason to believe are valid. 618 512 619 513 If, pursuant to or in connection with a single transaction or 620 514 arrangement, you convey, or propagate by procuring conveyance of, a 621 515 covered work, and grant a patent license to some of the parties 622 516 receiving the covered work authorizing them to use, propagate, modify 623 517 or convey a specific copy of the covered work, then the patent license 624 518 you grant is automatically extended to all recipients of the covered 625 519 work and works based on it. 626 520 627 521 A patent license is "discriminatory" if it does not include within 628 522 the scope of its coverage, prohibits the exercise of, or is 629 523 conditioned on the non-exercise of one or more of the rights that are 630 524 specifically granted under this License. You may not convey a covered 631 525 work if you are a party to an arrangement with a third party that is 632 526 in the business of distributing software, under which you make payment 633 527 to the third party based on the extent of your activity of conveying 634 528 the work, and under which the third party grants, to any of the 635 529 parties who would receive the covered work from you, a discriminatory 636 530 patent license (a) in connection with copies of the covered work 637 531 conveyed by you (or copies made from those copies), or (b) primarily 638 532 for and in connection with specific products or compilations that 639 533 contain the covered work, unless you entered into that arrangement, 640 534 or that patent license was granted, prior to 28 March 2007. 641 535 642 536 Nothing in this License shall be construed as excluding or limiting 643 537 any implied license or other defenses to infringement that may 644 538 otherwise be available to you under applicable patent law. 645 539 646 540 12. No Surrender of Others' Freedom. 647 541 648 542 If conditions are imposed on you (whether by court order, agreement or 649 543 otherwise) that contradict the conditions of this License, they do not 650 544 excuse you from the conditions of this License. If you cannot convey a 651 545 covered work so as to satisfy simultaneously your obligations under this 652 546 License and any other pertinent obligations, then as a consequence you may 653 547 not convey it at all. For example, if you agree to terms that obligate you 654 548 to collect a royalty for further conveying from those to whom you convey 655 549 the Program, the only way you could satisfy both those terms and this 656 550 License would be to refrain entirely from conveying the Program. 657 551 658 552 13. Use with the GNU Affero General Public License. 659 553 660 554 Notwithstanding any other provision of this License, you have 661 555 permission to link or combine any covered work with a work licensed 662 556 under version 3 of the GNU Affero General Public License into a single 663 557 combined work, and to convey the resulting work. The terms of this 664 558 License will continue to apply to the part which is the covered work, 665 559 but the special requirements of the GNU Affero General Public License, 666 560 section 13, concerning interaction through a network will apply to the 667 561 combination as such. 668 562 669 563 14. Revised Versions of this License. 670 564 671 565 The Free Software Foundation may publish revised and/or new versions of 672 566 the GNU General Public License from time to time. Such new versions will 673 567 be similar in spirit to the present version, but may differ in detail to 674 568 address new problems or concerns. 675 569 676 570 Each version is given a distinguishing version number. If the 677 571 Program specifies that a certain numbered version of the GNU General 678 572 Public License "or any later version" applies to it, you have the 679 573 option of following the terms and conditions either of that numbered 680 574 version or of any later version published by the Free Software 681 575 Foundation. If the Program does not specify a version number of the 682 576 GNU General Public License, you may choose any version ever published 683 577 by the Free Software Foundation. 684 578 685 579 If the Program specifies that a proxy can decide which future 686 580 versions of the GNU General Public License can be used, that proxy's 687 581 public statement of acceptance of a version permanently authorizes you 688 582 to choose that version for the Program. 689 583 690 584 Later license versions may give you additional or different 691 585 permissions. However, no additional obligations are imposed on any 692 586 author or copyright holder as a result of your choosing to follow a 693 587 later version. 694 588 695 589 15. Disclaimer of Warranty. 696 590 697 591 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 698 592 APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 699 593 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 700 594 OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 701 595 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 702 596 PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 703 597 IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 704 598 ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 705 599 706 600 16. Limitation of Liability. 707 601 708 602 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 709 603 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 710 604 THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 711 605 GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 712 606 USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 713 607 DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 714 608 PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 715 609 EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 716 610 SUCH DAMAGES. 717 611 718 612 17. Interpretation of Sections 15 and 16. 719 613 720 614 If the disclaimer of warranty and limitation of liability provided 721 615 above cannot be given local legal effect according to their terms, 722 616 reviewing courts shall apply local law that most closely approximates 723 617 an absolute waiver of all civil liability in connection with the 724 618 Program, unless a warranty or assumption of liability accompanies a 725 619 copy of the Program in return for a fee. 726 620 727 621 END OF TERMS AND CONDITIONS 728 622 729 623 How to Apply These Terms to Your New Programs 730 624 731 625 If you develop a new program, and you want it to be of the greatest 732 626 possible use to the public, the best way to achieve this is to make it 733 627 free software which everyone can redistribute and change under these terms. 734 628 735 629 To do so, attach the following notices to the program. It is safest 736 630 to attach them to the start of each source file to most effectively 737 631 state the exclusion of warranty; and each file should have at least 738 632 the "copyright" line and a pointer to where the full notice is found. 739 633 740 634 741 635 Copyright (C) 742 636 743 637 This program is free software: you can redistribute it and/or modify 744 638 it under the terms of the GNU General Public License as published by 745 639 the Free Software Foundation, either version 3 of the License, or 746 640 (at your option) any later version. 747 641 748 642 This program is distributed in the hope that it will be useful, 749 643 but WITHOUT ANY WARRANTY; without even the implied warranty of 750 644 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 751 645 GNU General Public License for more details. 752 646 753 647 You should have received a copy of the GNU General Public License 754 648 along with this program. If not, see . 755 649 756 650 Also add information on how to contact you by electronic and paper mail. 757 651 758 652 If the program does terminal interaction, make it output a short 759 653 notice like this when it starts in an interactive mode: 760 654 761 655 Copyright (C) 762 656 This program comes with ABSOLUTELY NO WARRANTY; for details type show w'. 763 657 This is free software, and you are welcome to redistribute it 764 658 under certain conditions; type show c' for details. 765 659 766 660 The hypothetical commands show w' and show c' should show the appropriate 767 661 parts of the General Public License. Of course, your program's commands 768 662 might be different; for a GUI interface, you would use an "about box". 769 663 770 664 You should also get your employer (if you work as a programmer) or school, 771 665 if any, to sign a "copyright disclaimer" for the program, if necessary. 772 666 For more information on this, and how to apply and follow the GNU GPL, see 773 667 . 774 668 775 669 The GNU General Public License does not permit incorporating your program 776 670 into proprietary programs. If your program is a subroutine library, you 777 671 may consider it more useful to permit linking proprietary applications with 778 672 the library. If this is what you want to do, use the GNU Lesser General 779 673 Public License instead of this License. But first, please read 780 674 . 781 0 675 782 === added file 'README.md' 783 --- README.md 1970-01-01 00:00:00 +0000 784 +++ README.md 2017-03-01 12:28:42 +0000 785 @@ -0,0 +1,46 @@ 786 1 Readme 787 2 ====== 788 3 789 4 MirAL - The Mir Abstraction Layer 790 5 --------------------------------- 791 6 792 7 MirAL aims to provide a stable “abstraction layer” written over the top of the 793 8 Mir server API that will provide a stable ABI. There are a number of other 794 9 goals that can be addressed at the same time: 795 10 796 11 - The API can be considerably narrowed as a lot of things can be customized 797 12 that are of no interest to shell development; 798 13 - A more declarative design style can be follow than the implementation 799 14 focussed approach that the Mir server API follows; and, 800 15 - Common facilities that don’t belong in the Mir libraries can be provided. 801 16 802 17 The Mir Abstraction Layer (miral) is a both a proof-of-concept and a 803 18 work-in-progress but may be of interest as modern C++ codebase to experiment 804 19 with. 805 20 806 21 There are two significant components to the MirAL project: 807 22 808 23 - libmiral.so is the abstraction library itself 809 24 - miral-shell is an example shell demonstrating the use of libmiral 810 25 811 26 See also: 812 27 813 28 - \ref getting_and_using_miral "Getting and using Miral" 814 29 - \ref tasks_for_the_interested_reader "Tasks for the interested reader" 815 30 816 31 License 817 32 ------- 818 33 This program is free software: you can redistribute it and/or modify 819 34 it under the terms of the GNU General Public License version 3 as 820 35 published by the Free Software Foundation. 821 36 822 37 This program is distributed in the hope that it will be useful, 823 38 but WITHOUT ANY WARRANTY; without even the implied warranty of 824 39 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 825 40 GNU General Public License for more details. 826 41 827 42 You should have received a copy of the GNU General Public License 828 43 along with this program. If not, see . 829 44 830 45 \copyright Copyright © 2016-2017 Canonical Ltd. 831 46 \author Alan Griffiths 832 0 47 833 === renamed file 'README.md' => 'README.md.moved' 834 === added directory 'cmake' 835 === renamed directory 'cmake' => 'cmake.moved' 836 === added file 'cmake/Doxygen.cmake' 837 --- cmake/Doxygen.cmake 1970-01-01 00:00:00 +0000 838 +++ cmake/Doxygen.cmake 2017-03-01 12:28:42 +0000 839 @@ -0,0 +1,26 @@ 840 1 # Check if doxygen is present and add 'make doc' target 841 2 find_package(Doxygen) 842 3 843 4 option( 844 5 BUILD_DOXYGEN 845 6 "Build Doxygen documentation as part of the default build" 846 7 OFF 847 8 ) 848 9 849 10 if(DOXYGEN_FOUND AND (DOXYGEN_VERSION VERSION_GREATER "1.8")) 850 11 message(STATUS "doxygen ${DOXYGEN_VERSION} (>= 1.8.0) available - enabling make target doc") 851 12 EXECUTE_PROCESS(COMMAND "date" "-u" OUTPUT_VARIABLE DATE_TODAY) 852 13 configure_file(doc/Doxyfile.in 853 14${PROJECT_BINARY_DIR}/Doxyfile @ONLY IMMEDIATE) 854 15 configure_file(doc/footer.html.in 855 16 ${PROJECT_BINARY_DIR}/doc/footer.html @ONLY IMMEDIATE) 856 17 configure_file(doc/extra.css 857 18${PROJECT_BINARY_DIR}/doc/extra.css @ONLY IMMEDIATE) 858 19 if (BUILD_DOXYGEN) 859 20 set(ALL "ALL") 860 21 endif() 861 22 add_custom_target(doc ${ALL} 862 23 COMMAND${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/Doxyfile 863 24 SOURCES${PROJECT_BINARY_DIR}/Doxyfile) 864 25 install(DIRECTORY ${CMAKE_BINARY_DIR}/doc/html DESTINATION${CMAKE_INSTALL_PREFIX}/share/doc/miral-doc/ OPTIONAL) 865 26 endif() 866 0 27 867 === added file 'cmake/FindGLESv2.cmake' 868 --- cmake/FindGLESv2.cmake 1970-01-01 00:00:00 +0000 869 +++ cmake/FindGLESv2.cmake 2017-03-01 12:28:42 +0000 870 @@ -0,0 +1,25 @@ 871 1 # - Try to find GLESv2 872 2 # Once done this will define 873 3 # GLESv2_FOUND - System has GLESv2 874 4 # GLESv2_INCLUDE_DIRS - The GLESv2 include directories 875 5 # GLESv2_LIBRARIES - The libraries needed to use GLESv2 876 6 877 7 find_package(PkgConfig) 878 8 pkg_check_modules(PC_GLESv2 QUIET glesv2) 879 9 880 10 find_path(GLESv2_INCLUDE_DIR GLES2/gl2.h 881 11 HINTS ${PC_GLESv2_INCLUDEDIR}${PC_GLESv2_INCLUDE_DIRS}) 882 12 883 13 find_library(GLESv2_LIBRARY GLESv2 884 14 HINTS ${PC_GLESv2_LIBDIR}${PC_GLESv2_LIBRARY_DIRS}) 885 15 886 16 set(GLESv2_LIBRARIES ${GLESv2_LIBRARY}) 887 17 set(GLESv2_INCLUDE_DIRS${GLESv2_INCLUDE_DIR}) 888 18 889 19 include(FindPackageHandleStandardArgs) 890 20 # handle the QUIETLY and REQUIRED arguments and set GLESv2_FOUND to TRUE 891 21 # if all listed variables are TRUE 892 22 find_package_handle_standard_args(GLESv2 DEFAULT_MSG 893 23 GLESv2_LIBRARY GLESv2_INCLUDE_DIR) 894 24 895 25 mark_as_advanced(GLESv2_INCLUDE_DIR GLESv2_LIBRARY) 896 0 26 897 === added file 'cmake/FindPIL.cmake' 898 --- cmake/FindPIL.cmake 1970-01-01 00:00:00 +0000 899 +++ cmake/FindPIL.cmake 2017-03-01 12:28:42 +0000 900 @@ -0,0 +1,8 @@ 901 1 execute_process( 902 2 COMMAND python -c "from PIL import Image" 903 3 RESULT_VARIABLE HAVE_PIL 904 4 ) 905 5 906 6 if (NOT ${HAVE_PIL} EQUAL 0) 907 7 message(FATAL_ERROR "Python Imaging Library (PIL) not found") 908 8 endif() 909 0 9 910 === added directory 'debian' 911 === renamed directory 'debian' => 'debian.moved' 912 === added file 'debian/changelog' 913 --- debian/changelog 1970-01-01 00:00:00 +0000 914 +++ debian/changelog 2017-03-01 12:28:42 +0000 915 @@ -0,0 +1,227 @@ 916 1 miral (1.3.0) UNRELEASED; urgency=medium 917 2 918 3 * New upstream release 1.3.0 (https://launchpad.net/miral/+milestone/1.3) 919 4 920 5 - ABI summary: 921 6 . miral ABI unchanged at 2 922 7 - Enhancements: 923 8 . [libmiral] Support for workspaces 924 9 . [miral-shell] Example workspaces implementation 925 10 . [miral-shell] Use background to show keyboard shortcuts 926 11 . [libmirclientcpp] A better description of libmirclientcpp-dev 927 12 . [libmirclientcpp] Prevent accidental double-release by deleting release 928 13 functions for handle classes 929 14 . [libmirclientcpp] Add RAII wrapper for MirDisplayConfig. 930 15 - Bugs fixed: 931 16 . [miral-shell] Workaround for crash on exit (LP: #1667645) 932 17 933 18 -- Alan Griffiths Thu, 02 Feb 2017 17:26:54 +0000 934 19 935 20 miral (1.2.0+17.04.20170215.1-0ubuntu1) zesty; urgency=medium 936 21 937 22 * New upstream release 1.2.0 (https://launchpad.net/miral/+milestone/1.2) 938 23 939 24 - ABI summary: 940 25 . miral ABI unchanged at 2 941 26 - Enhancements: 942 27 . New libmirclientcpp-dev package "C++ wrapper for libmirclient". (Split 943 28 from libmiral-dev) 944 29 . Give miral-app and miral-desktop a good default for -bindir 945 30 . More surface to window renaming to reflect Mir name changes 946 31 . Refresh the "Building and Using MirAL" doc 947 32 - Bugs fixed: 948 33 . Chrome-less shell hint does not work any more (LP: #1658117) 949 34 . WindowSpec::set_state() wrapper for mir_window_spec_set_state() 950 35 (LP: #1661256) 951 36 . "$ miral-app -kiosk" fails with "Unknown command line options: 952 37 --desktop_file_hint=miral-shell.desktop" (LP: #1660933) 953 38 . libmiral] Fix focus and movement rules for Input Method and Satellite 954 39 windows. (LP: #1660691) 955 40 956 41 957 42 -- Alan Griffiths Wed, 15 Feb 2017 14:05:46 +0000 958 43 959 44 miral (1.1.0+17.04.20170127-0ubuntu1) zesty; urgency=medium 960 45 961 46 [ Alan Griffiths ] 962 47 * New upstream release 1.1.0 (https://launchpad.net/miral/+milestone/1.1) 963 48 - ABI summary: 964 49 . miral ABI unchanged at 2 965 50 - Enhancements: 966 51 . Compatibility with Mir 0.26 and update API to use the new Mir types and 967 52 enums. 968 53 . Logging of exceptions added to --window-management-trace 969 54 . Rename WindowManagementPolicy::place_new_surface => place_new_window" 970 55 - Bugs fixed: 971 56 . top-level window is not raised along with its child (LP: #1658085) 972 57 . miral-shell depends on default cursor theme being installed 973 58 (LP: #1658159) 974 59 975 60 -- Cemil Azizoglu Fri, 27 Jan 2017 03:02:28 +0000 976 61 977 62 miral (1.0.2+17.04.20170118.1-0ubuntu1) zesty; urgency=medium 978 63 979 64 * New upstream release 1.0.1 (https://launchpad.net/miral/+milestone/1.0) 980 65 - ABI summary: 981 66 . miral ABI unchanged at 2 982 67 - Enhancements: 983 68 - Bugs fixed: 984 69 . Let the policy decide how to handle "ready" for windows that can't have 985 70 focus (LP: #1652109) 986 71 987 72 -- Alan Griffiths Wed, 18 Jan 2017 18:17:47 +0000 988 73 989 74 miral (1.0.1+17.04.20161220-0ubuntu1) zesty; urgency=medium 990 75 991 76 * New upstream release 1.0.1 (https://launchpad.net/miral/+milestone/1.0) 992 77 - ABI summary: 993 78 . miral ABI unchanged at 2 994 79 - Enhancements: 995 80 . None 996 81 - Bugs fixed: 997 82 . Workaround for a missing dependency in Mir packaging (LP: #1651391) 998 83 . Avoid double lock in WindowManagerTools::force_close() (LP: #1646735) 999 84 . Fix typo in miral-app script 1000 85 1001 86 -- Alan Griffiths Tue, 20 Dec 2016 16:00:02 +0000 1002 87 1003 88 miral (1.0.0+17.04.20161216-0ubuntu1) zesty; urgency=medium 1004 89 1005 90 [ Alan Griffiths ] 1006 91 * New upstream release 1.0.0 (https://launchpad.net/miral/+milestone/1.0) 1007 92 - ABI summary: 1008 93 . miral ABI bumped to 2 1009 94 - Enhancements: 1010 95 . Allow the WM policy a say in inherited moves of child windows 1011 96 . Remove deprecated APIs 1012 97 . add miral-app script to launch examples hosted by an existing desktop 1013 98 - Bugs fixed: 1014 99 . Examples fail to start under Unity8 (LP: #1646431) 1015 100 . [miral-shell --window-manager tiling] windows are not correctly 1016 101 constrained to tiles (LP: #1646735) 1017 102 1018 103 -- Brandon Schaefer Fri, 16 Dec 2016 00:36:20 +0000 1019 104 1020 105 miral (0.5.0+17.04.20161203-0ubuntu1) zesty; urgency=medium 1021 106 1022 107 * no change rebuild 1023 108 1024 109 -- Brandon Schaefer Sat, 03 Dec 2016 12:38:23 +0000 1025 110 1026 111 miral (0.5.0+17.04.20161130-0ubuntu1) zesty; urgency=medium 1027 112 1028 113 * New upstream release 0.5.0 (https://launchpad.net/miral/+milestone/0.5) 1029 114 - ABI summary: 1030 115 . miral ABI unchanged at 1 1031 116 - Enhancements: 1032 117 . Add miral::DebugExtension allowing shells to enable & disable support 1033 118 for debug extension API(s) dynamically 1034 119 . Improve handling of fullscreen surfaces when switching outputs, or 1035 120 specified output doesn't exist (any more) 1036 121 . Initial tests and some fixes for tracking of active window. 1037 122 . Document the order of windows passed to 1038 123 WindowManagementPolicy::advise_raise() so clients can rely on it. 1039 124 . [examples] Add miral-desktop script for launching a pseudo-desktop 1040 125 . [examples] Add miral-screencast - a utility script to assist with 1041 126 creating a screencast 1042 127 . [examples: miral-shell --window-manager tiling] implement the layout 1043 128 suggested in "Tasks for the interested reader" 1044 129 . [examples: miral-shell --window-manager tiling] Don't place a tile 1045 130 until the first window is ready 1046 131 . [examples: miral-kiosk] Provide configuration options for kiosk: 1047 132 --keymap --kiosk-maximize-root-windows & --kiosk-startup-apps-only 1048 133 - Bugs fixed: 1049 134 . Display configuration changes may cause "fatal errors" when there are 1050 135 fullscreen windows (LP: #1640557) 1051 136 1052 137 -- Alan Griffiths Wed, 30 Nov 2016 08:40:24 +0000 1053 138 1054 139 miral (0.4.0+17.04.20161104-0ubuntu1) zesty; urgency=medium 1055 140 1056 141 * New upstream release 0.4.0 (https://launchpad.net/miral/+milestone/0.4) 1057 142 - ABI summary: 1058 143 . miral ABI unchanged at 1 1059 144 - Enhancements: 1060 145 . Add miral::WindowManagerTools::force_close(window) to forcefully close 1061 146 a window (i.e. without a close request to the client) 1062 147 . Add functions to manage Applications 1063 148 . Add miral::CommandLineOption - enables the setting and processing of 1064 149 configuration options. These may be supplied on the commandline, as 1065 150 MIR_SERVER_XXX environment variables or in a config file. 1066 151 . Add +options to the keymap configuration 1067 152 . [miral-shell] Add window name to titlebars 1068 153 1069 154 -- Alan Griffiths Fri, 04 Nov 2016 16:45:44 +0000 1070 155 1071 156 miral (0.3.0+17.04.20161028-0ubuntu1) zesty; urgency=medium 1072 157 1073 158 * No change rebuild to target Xenial+Overlay 1074 159 1075 160 -- Alan Griffiths Fri, 28 Oct 2016 16:03:16 +0000 1076 161 1077 162 miral (0.3.0+17.04.20161024-0ubuntu1) zesty; urgency=medium 1078 163 1079 164 * New upstream release 0.3.0 (https://launchpad.net/miral/+milestone/0.3) 1080 165 - ABI summary: 1081 166 . miral ABI unchanged at 1 1082 167 - Enhancements: 1083 168 . Add miral-xrun as a better way to use Xmir 1084 169 . Added miral/version.h to allow permit compile-time feature detection 1085 170 . A convenient overload of WindowManagerTools::modify_window() that 1086 171 doesn't require the WindowInfo 1087 172 . Add userdata property to WindowSpecification and copy it to WindowInfo 1088 173 . miral::Keymap - support for keyboard maps (either programatically 1089 174 Keymap::set_keymap(), or via config --keymap) 1090 175 - Bugs fixed: 1091 176 . Crash after closing Qt dialog (LP: #1631958) 1092 177 . tooltips positioned wrong with mir0.24 (LP: #1632325, LP: #1633052) 1093 178 . Shell wants way to associate initially requested window creation state 1094 179 with the window later created (#1629349) 1095 180 . [Xmir] Alt+ switch between different apps not just windows 1096 181 (LP: #1625849) 1097 182 . miral-shell splash screen should be fullscreen. 1098 183 . TitlebarWindowManagerPolicy::end_resize() should do nothing if not 1099 184 resizing 1100 185 . deduplicate logging of WindowSpecification::top_left 1101 186 1102 187 -- Alan Griffiths Mon, 24 Oct 2016 15:25:46 +0000 1103 188 1104 189 miral (0.2.0+16.10.20160930.1-0ubuntu1) yakkety; urgency=medium 1105 190 1106 191 * New upstream release 0.2.0 (https://launchpad.net/miral/+milestone/0.2) 1107 192 - ABI summary: 1108 193 . miral ABI unchanged at 1 1109 194 - Enhancements: 1110 195 . –window-management-trace option for debugging window management 1111 196 . Enable cursor theme selection 1112 197 . Improved resizing of size-constrained windows in miral-shell example 1113 198 . Enable pointer confinement (where underlying Mir version >= 0.24) 1114 199 . Enhanced "surface placement" request handling. 1115 200 . Results of placement request notified to clients (where supported by 1116 201 underlying Mir version >= 0.25) 1117 202 - Bugs fixed: 1118 203 . advise_focus_lost() isn't called when the active window is minimised/ 1119 204 hidden (LP: #1628594) 1120 205 . miral should not change surface geometry because it got maximized 1121 206 (LP: #1628630) 1122 207 . TitlebarWindowManager: sometime the initial display of titlebars doesn't 1123 208 happen (LP: #1628981) 1124 209 . Dialogs with parents should be modal i.e. they receive focus when the 1125 210 parent is clicked (LP: #1626659) 1126 211 . Deadlock in default window manager when Ctrl+Alt+Backspace with a client 1127 212 connected (LP: #1628482) 1128 213 . Need to support pointer confinement in Mir and toolkits using Mir 1129 214 (LP: #1590099) 1130 215 . User can drag menus (and other inappropriate) surfaces (LP: #1616818) 1131 216 . Starting qtcreator on miral-shell gives an orphan "titlebar" 1132 217 (LP: #1628033) 1133 218 . Mouse cursor disappears (or just never changes) when entering the 1134 219 windows of Qt apps (LP: #1625853) 1135 220 1136 221 -- Alan Griffiths Fri, 30 Sep 2016 13:18:17 +0000 1137 222 1138 223 miral (0.1.0+16.10.20160919-0ubuntu1) yakkety; urgency=medium 1139 224 1140 225 * Initial release. (LP: #1613220) 1141 226 1142 227 -- Larry Price Mon, 19 Sep 2016 13:41:34 +0000 1143 0 228 1144 === added file 'debian/compat' 1145 --- debian/compat 1970-01-01 00:00:00 +0000 1146 +++ debian/compat 2017-03-01 12:28:42 +0000 1147 @@ -0,0 +1,1 @@ 1148 1 9 1149 0 2 1150 === added file 'debian/control' 1151 --- debian/control 1970-01-01 00:00:00 +0000 1152 +++ debian/control 2017-03-01 12:28:42 +0000 1153 @@ -0,0 +1,90 @@ 1154 1 Source: miral 1155 2 Section: x11 1156 3 Priority: optional 1157 4 Maintainer: Ubuntu Developers 1158 5 XSBC-Original-Maintainer: Alan Griffiths 1159 6 Build-Depends: cmake, 1160 7 cmake-extras, 1161 8 pkg-config, 1162 9 debhelper (>= 9), 1163 10 doxygen, 1164 11 xsltproc, 1165 12 graphviz, 1166 13 pkg-config, 1167 14 python-pil, 1168 15 google-mock (>= 1.6.0+svn437), 1169 16 python3:any, 1170 17 libmirserver-dev, 1171 18 libmirclient-dev, 1172 19 mirtest-dev, 1173 20 libglib2.0-dev, 1174 21 libgles2-mesa-dev, 1175 22 libfreetype6-dev, 1176 23 # The following workaround missing dependencies in Mir packages 1177 24 uuid-dev, 1178 25 libboost-system-dev, 1179 26 libboost-filesystem-dev, 1180 27 mir-test-tools, 1181 28 mir-renderer-gl-dev, 1182 29 Standards-Version: 3.9.8 1183 30 Homepage: https://launchpad.net/miral 1184 31 # If you aren't a member of ~mir-team but need to upload packaging changes, 1185 32 # just go ahead. ~mir-team will notice and sync up the code again. 1186 33 Vcs-Bzr: https://code.launchpad.net/miral 1187 34 1188 35 Package: libmiral2 1189 36 Section: libs 1190 37 Architecture: linux-any 1191 38 Multi-Arch: same 1192 39 Pre-Depends: ${misc:Pre-Depends} 1193 40 Depends:${misc:Depends}, 1194 41 ${shlibs:Depends}, 1195 42 Description: Display server for Ubuntu - ABI preserving abstraction layer 1196 43 MirAL provides an ABI-stable abstraction layer for Mir based shells, 1197 44 insulating them from mirserver ABI breaks. 1198 45 . 1199 46 Contains the shared library containing MirAL abstraction layer. 1200 47 1201 48 Package: libmiral-dev 1202 49 Section: libdevel 1203 50 Architecture: linux-any 1204 51 Multi-Arch: same 1205 52 Pre-Depends:${misc:Pre-Depends} 1206 53 Depends: libmiral2 (= ${binary:Version}), 1207 54 libmirclientcpp-dev (=${binary:Version}), 1208 55 ${misc:Depends}, 1209 56 Description: Developer files for the Mir ABI-stable abstraction layer 1210 57 MirAL provides an ABI-stable abstraction layer for Mir based shells, 1211 58 insulating them from mirserver ABI breaks. 1212 59 . 1213 60 Contains header files required for development using the MirAL abstraction 1214 61 layer. 1215 62 1216 63 Package: libmirclientcpp-dev 1217 64 Section: libdevel 1218 65 Architecture: linux-any 1219 66 Multi-Arch: same 1220 67 Pre-Depends:${misc:Pre-Depends} 1221 68 Depends: libmirclient-dev, 1222 69 Description: A C++ wrapper for libmirclient-dev 1223 70 Provides RAII (and other facilities) for Mir client library types. 1224 71 . 1225 72 Contains header files useful for C++ development against Mir. 1226 73 1227 74 Package: miral-examples 1228 75 Architecture: linux-any 1229 76 Depends: ${misc:Depends}, 1230 77${shlibs:Depends}, 1231 78 Recommends: dmz-cursor-theme, 1232 79 Description: Display server for Ubuntu - demonstration programs 1233 80 MirAL provides an ABI-stable abstraction layer for Mir based shells, 1234 81 insulating them from mirserver ABI breaks. 1235 82 . 1236 83 Contains demo applications that use the MirAL abstraction layer 1237 84 1238 85 Package: miral-doc 1239 86 Section: doc 1240 87 Architecture: all 1241 88 Depends: ${misc:Depends}, 1242 89 Description: API documentation for MirAL 1243 90 This package installs the MirAL abstraction layer documentation. 1244 0 91 1245 === added file 'debian/copyright' 1246 --- debian/copyright 1970-01-01 00:00:00 +0000 1247 +++ debian/copyright 2017-03-01 12:28:42 +0000 1248 @@ -0,0 +1,24 @@ 1249 1 Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ 1250 2 Upstream-Name: MirAL 1251 3 Upstream-Contact: Alan Griffiths 1252 4 Source: https://launchpad.net/miral 1253 5 1254 6 Files: * 1255 7 Copyright: 2016 Canonical Ltd. 1256 8 License: GPL-3 1257 9 1258 10 License: GPL-3 1259 11 This program is free software: you can redistribute it and/or modify 1260 12 it under the terms of the GNU General Public License as published by 1261 13 the Free Software Foundation, version 3 of the License. 1262 14 . 1263 15 This program is distributed in the hope that it will be useful, 1264 16 but WITHOUT ANY WARRANTY; without even the implied warranty of 1265 17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 1266 18 GNU General Public License for more details. 1267 19 . 1268 20 You should have received a copy of the GNU General Public License 1269 21 along with this program. If not, see . 1270 22 . 1271 23 On Debian systems, the full text of the GNU General Public License 1272 24 version 3 can be found in the file /usr/share/common-licenses/GPL-3. 1273 0 25 1274 === added file 'debian/libmiral-dev.install' 1275 --- debian/libmiral-dev.install 1970-01-01 00:00:00 +0000 1276 +++ debian/libmiral-dev.install 2017-03-01 12:28:42 +0000 1277 @@ -0,0 +1,3 @@ 1278 1 usr/include/miral/miral/* 1279 2 usr/lib/*/pkgconfig/miral.pc 1280 3 usr/lib/*/libmiral.so 1281 0 4 1282 === added file 'debian/libmiral2.install' 1283 --- debian/libmiral2.install 1970-01-01 00:00:00 +0000 1284 +++ debian/libmiral2.install 2017-03-01 12:28:42 +0000 1285 @@ -0,0 +1,1 @@ 1286 1 usr/lib/*/libmiral.so.2 1287 0 2 1288 === added file 'debian/libmiral2.symbols' 1289 --- debian/libmiral2.symbols 1970-01-01 00:00:00 +0000 1290 +++ debian/libmiral2.symbols 2017-03-01 12:28:42 +0000 1291 @@ -0,0 +1,383 @@ 1292 1 libmiral.so.2 libmiral2 #MINVER# 1293 2 MIRAL_1.0@MIRAL_1.0 1.0.0 1294 3 (c++)"miral::WindowInfo::height_inc(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1295 4 (c++)"miral::WindowInfo::max_aspect(miral::WindowSpecification::AspectRatio)@MIRAL_1.0" 1.0.0 1296 5 (c++)"miral::WindowInfo::max_height(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1297 6 (c++)"miral::WindowInfo::min_aspect(miral::WindowSpecification::AspectRatio)@MIRAL_1.0" 1.0.0 1298 7 (c++)"miral::WindowInfo::min_height(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1299 8 (c++)"miral::WindowInfo::remove_child(miral::Window const&)@MIRAL_1.0" 1.0.0 1300 9 (c++)"miral::WindowInfo::restore_rect(mir::geometry::Rectangle const&)@MIRAL_1.0" 1.0.0 1301 10 (c++)"miral::WindowInfo::needs_titlebar(MirSurfaceType)@MIRAL_1.0" 1.0.0 1302 11 (c++)"miral::WindowInfo::confine_pointer(MirPointerConfinementState)@MIRAL_1.0" 1.0.0 1303 12 (c++)"miral::WindowInfo::preferred_orientation(MirOrientationMode)@MIRAL_1.0" 1.0.0 1304 13 (c++)"miral::WindowInfo::name(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1305 14 (c++)"miral::WindowInfo::type(MirSurfaceType)@MIRAL_1.0" 1.0.0 1306 15 (c++)"miral::WindowInfo::state(MirSurfaceState)@MIRAL_1.0" 1.0.0 1307 16 (c++)"miral::WindowInfo::parent(miral::Window const&)@MIRAL_1.0" 1.0.0 1308 17 (c++)"miral::WindowInfo::userdata(std::shared_ptr)@MIRAL_1.0" 1.0.0 1309 18 (c++)"miral::WindowInfo::add_child(miral::Window const&)@MIRAL_1.0" 1.0.0 1310 19 (c++)"miral::WindowInfo::max_width(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1311 20 (c++)"miral::WindowInfo::min_width(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1312 21 (c++)"miral::WindowInfo::output_id(mir::optional_value)@MIRAL_1.0" 1.0.0 1313 22 (c++)"miral::WindowInfo::width_inc(mir::geometry::detail::IntWrapper)@MIRAL_1.0" 1.0.0 1314 23 (c++)"miral::WindowInfo::WindowInfo(miral::Window const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1315 24 (c++)"miral::WindowInfo::WindowInfo(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1316 25 (c++)"miral::WindowInfo::WindowInfo()@MIRAL_1.0" 1.0.0 1317 26 (c++)"miral::WindowInfo::WindowInfo(miral::Window const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1318 27 (c++)"miral::WindowInfo::WindowInfo(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1319 28 (c++)"miral::WindowInfo::WindowInfo()@MIRAL_1.0" 1.0.0 1320 29 (c++)"miral::WindowInfo::~WindowInfo()@MIRAL_1.0" 1.0.0 1321 30 (c++)"miral::WindowInfo::~WindowInfo()@MIRAL_1.0" 1.0.0 1322 31 (c++)"miral::WindowInfo::operator=(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1323 32 (c++)"miral::CursorTheme::CursorTheme(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1324 33 (c++)"miral::CursorTheme::CursorTheme(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1325 34 (c++)"miral::CursorTheme::~CursorTheme()@MIRAL_1.0" 1.0.0 1326 35 (c++)"miral::CursorTheme::~CursorTheme()@MIRAL_1.0" 1.0.0 1327 36 (c++)"miral::SetTerminator::SetTerminator(std::function const&)@MIRAL_1.0" 1.0.0 1328 37 (c++)"miral::SetTerminator::SetTerminator(std::function const&)@MIRAL_1.0" 1.0.0 1329 38 (c++)"miral::SetTerminator::~SetTerminator()@MIRAL_1.0" 1.0.0 1330 39 (c++)"miral::SetTerminator::~SetTerminator()@MIRAL_1.0" 1.0.0 1331 40 (c++)"miral::DebugExtension::enable()@MIRAL_1.0" 1.0.0 1332 41 (c++)"miral::DebugExtension::disable()@MIRAL_1.0" 1.0.0 1333 42 (c++)"miral::DebugExtension::DebugExtension(miral::DebugExtension const&)@MIRAL_1.0" 1.0.0 1334 43 (c++)"miral::DebugExtension::DebugExtension()@MIRAL_1.0" 1.0.0 1335 44 (c++)"miral::DebugExtension::DebugExtension(miral::DebugExtension const&)@MIRAL_1.0" 1.0.0 1336 45 (c++)"miral::DebugExtension::DebugExtension()@MIRAL_1.0" 1.0.0 1337 46 (c++)"miral::DebugExtension::operator=(miral::DebugExtension const&)@MIRAL_1.0" 1.0.0 1338 47 (c++)"miral::AddInitCallback::AddInitCallback(std::function const&)@MIRAL_1.0" 1.0.0 1339 48 (c++)"miral::AddInitCallback::AddInitCallback(std::function const&)@MIRAL_1.0" 1.0.0 1340 49 (c++)"miral::AddInitCallback::~AddInitCallback()@MIRAL_1.0" 1.0.0 1341 50 (c++)"miral::AddInitCallback::~AddInitCallback()@MIRAL_1.0" 1.0.0 1342 51 (c++)"miral::ApplicationInfo::add_window(miral::Window const&)@MIRAL_1.0" 1.0.0 1343 52 (c++)"miral::ApplicationInfo::remove_window(miral::Window const&)@MIRAL_1.0" 1.0.0 1344 53 (c++)"miral::ApplicationInfo::userdata(std::shared_ptr)@MIRAL_1.0" 1.0.0 1345 54 (c++)"miral::ApplicationInfo::ApplicationInfo(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0 1346 55 (c++)"miral::ApplicationInfo::ApplicationInfo(std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1347 56 (c++)"miral::ApplicationInfo::ApplicationInfo()@MIRAL_1.0" 1.0.0 1348 57 (c++)"miral::ApplicationInfo::ApplicationInfo(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0 1349 58 (c++)"miral::ApplicationInfo::ApplicationInfo(std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1350 59 (c++)"miral::ApplicationInfo::ApplicationInfo()@MIRAL_1.0" 1.0.0 1351 60 (c++)"miral::ApplicationInfo::~ApplicationInfo()@MIRAL_1.0" 1.0.0 1352 61 (c++)"miral::ApplicationInfo::~ApplicationInfo()@MIRAL_1.0" 1.0.0 1353 62 (c++)"miral::ApplicationInfo::operator=(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0 1354 63 (c++)"miral::AppendEventFilter::AppendEventFilter(std::function const&)@MIRAL_1.0" 1.0.0 1355 64 (c++)"miral::AppendEventFilter::AppendEventFilter(std::function const&)@MIRAL_1.0" 1.0.0 1356 65 (c++)"miral::AppendEventFilter::operator()(mir::Server&)@MIRAL_1.0" 1.0.0 1357 66 (c++)"miral::CommandLineOption::CommandLineOption(miral::CommandLineOption const&)@MIRAL_1.0" 1.0.0 1358 67 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1359 68 (c++)"miral::CommandLineOption::CommandLineOption(std::function const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1360 69 (c++)"miral::CommandLineOption::CommandLineOption(std::function const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1361 70 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, char const*)@MIRAL_1.0" 1.0.0 1362 71 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1363 72 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1364 73 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, bool)@MIRAL_1.0" 1.0.0 1365 74 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, double)@MIRAL_1.0" 1.0.0 1366 75 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, int)@MIRAL_1.0" 1.0.0 1367 76 (c++)"miral::CommandLineOption::CommandLineOption(miral::CommandLineOption const&)@MIRAL_1.0" 1.0.0 1368 77 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1369 78 (c++)"miral::CommandLineOption::CommandLineOption(std::function const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1370 79 (c++)"miral::CommandLineOption::CommandLineOption(std::function const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1371 80 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, char const*)@MIRAL_1.0" 1.0.0 1372 81 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::allocator > const&)>, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1373 82 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1374 83 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, bool)@MIRAL_1.0" 1.0.0 1375 84 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, double)@MIRAL_1.0" 1.0.0 1376 85 (c++)"miral::CommandLineOption::CommandLineOption(std::function, std::__cxx11::basic_string, std::allocator > const&, std::__cxx11::basic_string, std::allocator > const&, int)@MIRAL_1.0" 1.0.0 1377 86 (c++)"miral::CommandLineOption::~CommandLineOption()@MIRAL_1.0" 1.0.0 1378 87 (c++)"miral::CommandLineOption::~CommandLineOption()@MIRAL_1.0" 1.0.0 1379 88 (c++)"miral::CommandLineOption::operator=(miral::CommandLineOption const&)@MIRAL_1.0" 1.0.0 1380 89 (c++)"miral::WindowManagerTools::raise_tree(miral::Window const&)@MIRAL_1.0" 1.0.0 1381 90 (c++)"miral::WindowManagerTools::force_close(miral::Window const&)@MIRAL_1.0" 1.0.0 1382 91 (c++)"miral::WindowManagerTools::modify_window(miral::Window const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1383 92 (c++)"miral::WindowManagerTools::modify_window(miral::WindowInfo&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1384 93 (c++)"miral::WindowManagerTools::active_display()@MIRAL_1.0" 1.0.0 1385 94 (c++)"miral::WindowManagerTools::find_application(std::function const&)@MIRAL_1.0" 1.0.0 1386 95 (c++)"miral::WindowManagerTools::invoke_under_lock(std::function const&)@MIRAL_1.0" 1.0.0 1387 96 (c++)"miral::WindowManagerTools::drag_active_window(mir::geometry::Displacement)@MIRAL_1.0" 1.0.0 1388 97 (c++)"miral::WindowManagerTools::ask_client_to_close(miral::Window const&)@MIRAL_1.0" 1.0.0 1389 98 (c++)"miral::WindowManagerTools::for_each_application(std::function const&)@MIRAL_1.0" 1.0.0 1390 99 (c++)"miral::WindowManagerTools::select_active_window(miral::Window const&)@MIRAL_1.0" 1.0.0 1391 100 (c++)"miral::WindowManagerTools::focus_next_application()@MIRAL_1.0" 1.0.0 1392 101 (c++)"miral::WindowManagerTools::focus_next_within_application()@MIRAL_1.0" 1.0.0 1393 102 (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerToolsImplementation*)@MIRAL_1.0" 1.0.0 1394 103 (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0 1395 104 (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerToolsImplementation*)@MIRAL_1.0" 1.0.0 1396 105 (c++)"miral::WindowManagerTools::WindowManagerTools(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0 1397 106 (c++)"miral::WindowManagerTools::~WindowManagerTools()@MIRAL_1.0" 1.0.0 1398 107 (c++)"miral::WindowManagerTools::~WindowManagerTools()@MIRAL_1.0" 1.0.0 1399 108 (c++)"miral::WindowManagerTools::operator=(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0 1400 109 (c++)"miral::WindowSpecification::height_inc()@MIRAL_1.0" 1.0.0 1401 110 (c++)"miral::WindowSpecification::input_mode()@MIRAL_1.0" 1.0.0 1402 111 (c++)"miral::WindowSpecification::max_aspect()@MIRAL_1.0" 1.0.0 1403 112 (c++)"miral::WindowSpecification::max_height()@MIRAL_1.0" 1.0.0 1404 113 (c++)"miral::WindowSpecification::min_aspect()@MIRAL_1.0" 1.0.0 1405 114 (c++)"miral::WindowSpecification::min_height()@MIRAL_1.0" 1.0.0 1406 115 (c++)"miral::WindowSpecification::input_shape()@MIRAL_1.0" 1.0.0 1407 116 (c++)"miral::WindowSpecification::shell_chrome()@MIRAL_1.0" 1.0.0 1408 117 (c++)"miral::WindowSpecification::confine_pointer()@MIRAL_1.0" 1.0.0 1409 118 (c++)"miral::WindowSpecification::placement_hints()@MIRAL_1.0" 1.0.0 1410 119 (c++)"miral::WindowSpecification::preferred_orientation()@MIRAL_1.0" 1.0.0 1411 120 (c++)"miral::WindowSpecification::window_placement_gravity()@MIRAL_1.0" 1.0.0 1412 121 (c++)"miral::WindowSpecification::aux_rect_placement_offset()@MIRAL_1.0" 1.0.0 1413 122 (c++)"miral::WindowSpecification::aux_rect_placement_gravity()@MIRAL_1.0" 1.0.0 1414 123 (c++)"miral::WindowSpecification::name[abi:cxx11]()@MIRAL_1.0" 1.0.0 1415 124 (c++)"miral::WindowSpecification::size()@MIRAL_1.0" 1.0.0 1416 125 (c++)"miral::WindowSpecification::type()@MIRAL_1.0" 1.0.0 1417 126 (c++)"miral::WindowSpecification::state()@MIRAL_1.0" 1.0.0 1418 127 (c++)"miral::WindowSpecification::parent()@MIRAL_1.0" 1.0.0 1419 128 (c++)"miral::WindowSpecification::aux_rect()@MIRAL_1.0" 1.0.0 1420 129 (c++)"miral::WindowSpecification::top_left()@MIRAL_1.0" 1.0.0 1421 130 (c++)"miral::WindowSpecification::userdata()@MIRAL_1.0" 1.0.0 1422 131 (c++)"miral::WindowSpecification::max_width()@MIRAL_1.0" 1.0.0 1423 132 (c++)"miral::WindowSpecification::min_width()@MIRAL_1.0" 1.0.0 1424 133 (c++)"miral::WindowSpecification::output_id()@MIRAL_1.0" 1.0.0 1425 134 (c++)"miral::WindowSpecification::width_inc()@MIRAL_1.0" 1.0.0 1426 135 (c++)"miral::WindowSpecification::WindowSpecification(mir::scene::SurfaceCreationParameters const&)@MIRAL_1.0" 1.0.0 1427 136 (c++)"miral::WindowSpecification::WindowSpecification(mir::shell::SurfaceSpecification const&)@MIRAL_1.0" 1.0.0 1428 137 (c++)"miral::WindowSpecification::WindowSpecification(miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1429 138 (c++)"miral::WindowSpecification::WindowSpecification()@MIRAL_1.0" 1.0.0 1430 139 (c++)"miral::WindowSpecification::WindowSpecification(mir::scene::SurfaceCreationParameters const&)@MIRAL_1.0" 1.0.0 1431 140 (c++)"miral::WindowSpecification::WindowSpecification(mir::shell::SurfaceSpecification const&)@MIRAL_1.0" 1.0.0 1432 141 (c++)"miral::WindowSpecification::WindowSpecification(miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1433 142 (c++)"miral::WindowSpecification::WindowSpecification()@MIRAL_1.0" 1.0.0 1434 143 (c++)"miral::WindowSpecification::~WindowSpecification()@MIRAL_1.0" 1.0.0 1435 144 (c++)"miral::WindowSpecification::~WindowSpecification()@MIRAL_1.0" 1.0.0 1436 145 (c++)"miral::WindowSpecification::operator=(miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1437 146 (c++)"miral::ActiveOutputsMonitor::add_listener(miral::ActiveOutputsListener*)@MIRAL_1.0" 1.0.0 1438 147 (c++)"miral::ActiveOutputsMonitor::delete_listener(miral::ActiveOutputsListener*)@MIRAL_1.0" 1.0.0 1439 148 (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor(miral::ActiveOutputsMonitor const&)@MIRAL_1.0" 1.0.0 1440 149 (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0 1441 150 (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor(miral::ActiveOutputsMonitor const&)@MIRAL_1.0" 1.0.0 1442 151 (c++)"miral::ActiveOutputsMonitor::ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0 1443 152 (c++)"miral::ActiveOutputsMonitor::~ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0 1444 153 (c++)"miral::ActiveOutputsMonitor::~ActiveOutputsMonitor()@MIRAL_1.0" 1.0.0 1445 154 (c++)"miral::ActiveOutputsMonitor::operator=(miral::ActiveOutputsMonitor const&)@MIRAL_1.0" 1.0.0 1446 155 (c++)"miral::ActiveOutputsMonitor::operator()(mir::Server&)@MIRAL_1.0" 1.0.0 1447 156 (c++)"miral::ActiveOutputsListener::advise_output_end()@MIRAL_1.0" 1.0.0 1448 157 (c++)"miral::ActiveOutputsListener::advise_output_begin()@MIRAL_1.0" 1.0.0 1449 158 (c++)"miral::ActiveOutputsListener::advise_output_create(miral::Output const&)@MIRAL_1.0" 1.0.0 1450 159 (c++)"miral::ActiveOutputsListener::advise_output_delete(miral::Output const&)@MIRAL_1.0" 1.0.0 1451 160 (c++)"miral::ActiveOutputsListener::advise_output_update(miral::Output const&, miral::Output const&)@MIRAL_1.0" 1.0.0 1452 161 (c++)"miral::SetCommandLineHandler::SetCommandLineHandler(std::function const&)@MIRAL_1.0" 1.0.0 1453 162 (c++)"miral::SetCommandLineHandler::SetCommandLineHandler(std::function const&)@MIRAL_1.0" 1.0.0 1454 163 (c++)"miral::SetCommandLineHandler::~SetCommandLineHandler()@MIRAL_1.0" 1.0.0 1455 164 (c++)"miral::SetCommandLineHandler::~SetCommandLineHandler()@MIRAL_1.0" 1.0.0 1456 165 (c++)"miral::StartupInternalClient::StartupInternalClient(std::__cxx11::basic_string, std::allocator >, std::function, std::function)>)@MIRAL_1.0" 1.0.0 1457 166 (c++)"miral::StartupInternalClient::StartupInternalClient(std::__cxx11::basic_string, std::allocator >, std::function, std::function)>)@MIRAL_1.0" 1.0.0 1458 167 (c++)"miral::StartupInternalClient::~StartupInternalClient()@MIRAL_1.0" 1.0.0 1459 168 (c++)"miral::StartupInternalClient::~StartupInternalClient()@MIRAL_1.0" 1.0.0 1460 169 (c++)"miral::StartupInternalClient::operator()(mir::Server&)@MIRAL_1.0" 1.0.0 1461 170 (c++)"miral::ApplicationCredentials::ApplicationCredentials(mir::frontend::SessionCredentials const&)@MIRAL_1.0" 1.0.0 1462 171 (c++)"miral::ApplicationCredentials::ApplicationCredentials(mir::frontend::SessionCredentials const&)@MIRAL_1.0" 1.0.0 1463 172 (c++)"miral::InternalClientLauncher::InternalClientLauncher()@MIRAL_1.0" 1.0.0 1464 173 (c++)"miral::InternalClientLauncher::InternalClientLauncher()@MIRAL_1.0" 1.0.0 1465 174 (c++)"miral::InternalClientLauncher::~InternalClientLauncher()@MIRAL_1.0" 1.0.0 1466 175 (c++)"miral::InternalClientLauncher::~InternalClientLauncher()@MIRAL_1.0" 1.0.0 1467 176 (c++)"miral::InternalClientLauncher::operator()(mir::Server&)@MIRAL_1.0" 1.0.0 1468 177 (c++)"miral::WindowManagementPolicy::advise_end()@MIRAL_1.0" 1.0.0 1469 178 (c++)"miral::WindowManagementPolicy::advise_begin()@MIRAL_1.0" 1.0.0 1470 179 (c++)"miral::WindowManagementPolicy::advise_raise(std::vector > const&)@MIRAL_1.0" 1.0.0 1471 180 (c++)"miral::WindowManagementPolicy::advise_resize(miral::WindowInfo const&, mir::geometry::Size const&)@MIRAL_1.0" 1.0.0 1472 181 (c++)"miral::WindowManagementPolicy::advise_move_to(miral::WindowInfo const&, mir::geometry::Point)@MIRAL_1.0" 1.0.0 1473 182 (c++)"miral::WindowManagementPolicy::advise_new_app(miral::ApplicationInfo&)@MIRAL_1.0" 1.0.0 1474 183 (c++)"miral::WindowManagementPolicy::advise_delete_app(miral::ApplicationInfo const&)@MIRAL_1.0" 1.0.0 1475 184 (c++)"miral::WindowManagementPolicy::advise_focus_lost(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1476 185 (c++)"miral::WindowManagementPolicy::advise_new_window(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1477 186 (c++)"miral::WindowManagementPolicy::advise_focus_gained(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1478 187 (c++)"miral::WindowManagementPolicy::advise_state_change(miral::WindowInfo const&, MirSurfaceState)@MIRAL_1.0" 1.0.0 1479 188 (c++)"miral::WindowManagementPolicy::advise_delete_window(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1480 189 (c++)"miral::equivalent_display_area(miral::Output const&, miral::Output const&)@MIRAL_1.0" 1.0.0 1481 190 (c++)"miral::SetWindowManagmentPolicy::SetWindowManagmentPolicy(std::function > (miral::WindowManagerTools const&)> const&)@MIRAL_1.0" 1.0.0 1482 191 (c++)"miral::SetWindowManagmentPolicy::SetWindowManagmentPolicy(std::function > (miral::WindowManagerTools const&)> const&)@MIRAL_1.0" 1.0.0 1483 192 (c++)"miral::SetWindowManagmentPolicy::~SetWindowManagmentPolicy()@MIRAL_1.0" 1.0.0 1484 193 (c++)"miral::SetWindowManagmentPolicy::~SetWindowManagmentPolicy()@MIRAL_1.0" 1.0.0 1485 194 (c++)"miral::apply_lifecycle_state_to(std::shared_ptr const&, MirLifecycleState)@MIRAL_1.0" 1.0.0 1486 195 (c++)"miral::CanonicalWindowManagerPolicy::place_new_surface(miral::ApplicationInfo const&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1487 196 (c++)"miral::CanonicalWindowManagerPolicy::advise_focus_gained(miral::WindowInfo const&)@MIRAL_1.0" 1.0.0 1488 197 (c++)"miral::CanonicalWindowManagerPolicy::handle_raise_window(miral::WindowInfo&)@MIRAL_1.0" 1.0.0 1489 198 (c++)"miral::CanonicalWindowManagerPolicy::handle_window_ready(miral::WindowInfo&)@MIRAL_1.0" 1.0.0 1490 199 (c++)"miral::CanonicalWindowManagerPolicy::handle_modify_window(miral::WindowInfo&, miral::WindowSpecification const&)@MIRAL_1.0" 1.0.0 1491 200 (c++)"miral::CanonicalWindowManagerPolicy::confirm_inherited_move(miral::WindowInfo const&, mir::geometry::Displacement)@MIRAL_1.0" 1.0.0 1492 201 (c++)"miral::CanonicalWindowManagerPolicy::CanonicalWindowManagerPolicy(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0 1493 202 (c++)"miral::CanonicalWindowManagerPolicy::CanonicalWindowManagerPolicy(miral::WindowManagerTools const&)@MIRAL_1.0" 1.0.0 1494 203 (c++)"miral::BasicSetApplicationAuthorizer::BasicSetApplicationAuthorizer(std::function ()> const&)@MIRAL_1.0" 1.0.0 1495 204 (c++)"miral::BasicSetApplicationAuthorizer::BasicSetApplicationAuthorizer(std::function ()> const&)@MIRAL_1.0" 1.0.0 1496 205 (c++)"miral::BasicSetApplicationAuthorizer::~BasicSetApplicationAuthorizer()@MIRAL_1.0" 1.0.0 1497 206 (c++)"miral::BasicSetApplicationAuthorizer::~BasicSetApplicationAuthorizer()@MIRAL_1.0" 1.0.0 1498 207 (c++)"miral::BasicSetApplicationAuthorizer::operator()(mir::Server&)@MIRAL_1.0" 1.0.0 1499 208 (c++)"miral::display_configuration_options(mir::Server&)@MIRAL_1.0" 1.0.0 1500 209 (c++)"miral::kill(std::shared_ptr const&, int)@MIRAL_1.0" 1.0.0 1501 210 (c++)"miral::Keymap::set_keymap(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1502 211 (c++)"miral::Keymap::Keymap(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1503 212 (c++)"miral::Keymap::Keymap(miral::Keymap const&)@MIRAL_1.0" 1.0.0 1504 213 (c++)"miral::Keymap::Keymap()@MIRAL_1.0" 1.0.0 1505 214 (c++)"miral::Keymap::Keymap(std::__cxx11::basic_string, std::allocator > const&)@MIRAL_1.0" 1.0.0 1506 215 (c++)"miral::Keymap::Keymap(miral::Keymap const&)@MIRAL_1.0" 1.0.0 1507 216 (c++)"miral::Keymap::Keymap()@MIRAL_1.0" 1.0.0 1508 217 (c++)"miral::Keymap::~Keymap()@MIRAL_1.0" 1.0.0 1509 218 (c++)"miral::Keymap::~Keymap()@MIRAL_1.0" 1.0.0 1510 219 (c++)"miral::Keymap::operator=(miral::Keymap const&)@MIRAL_1.0" 1.0.0 1511 220 (c++)"miral::Output::Output(mir::graphics::DisplayConfigurationOutput const&)@MIRAL_1.0" 1.0.0 1512 221 (c++)"miral::Output::Output(miral::Output const&)@MIRAL_1.0" 1.0.0 1513 222 (c++)"miral::Output::Output(mir::graphics::DisplayConfigurationOutput const&)@MIRAL_1.0" 1.0.0 1514 223 (c++)"miral::Output::Output(miral::Output const&)@MIRAL_1.0" 1.0.0 1515 224 (c++)"miral::Output::~Output()@MIRAL_1.0" 1.0.0 1516 225 (c++)"miral::Output::~Output()@MIRAL_1.0" 1.0.0 1517 226 (c++)"miral::Output::operator=(miral::Output const&)@MIRAL_1.0" 1.0.0 1518 227 (c++)"miral::Window::resize(mir::geometry::Size const&)@MIRAL_1.0" 1.0.0 1519 228 (c++)"miral::Window::move_to(mir::geometry::Point)@MIRAL_1.0" 1.0.0 1520 229 (c++)"miral::Window::Window(std::shared_ptr const&, std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1521 230 (c++)"miral::Window::Window()@MIRAL_1.0" 1.0.0 1522 231 (c++)"miral::Window::Window(std::shared_ptr const&, std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1523 232 (c++)"miral::Window::Window()@MIRAL_1.0" 1.0.0 1524 233 (c++)"miral::Window::~Window()@MIRAL_1.0" 1.0.0 1525 234 (c++)"miral::Window::~Window()@MIRAL_1.0" 1.0.0 1526 235 (c++)"miral::pid_of(std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1527 236 (c++)"miral::name_of[abi:cxx11](std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1528 237 (c++)"miral::MirRunner::add_stop_callback(std::function const&)@MIRAL_1.0" 1.0.0 1529 238 (c++)"miral::MirRunner::add_start_callback(std::function const&)@MIRAL_1.0" 1.0.0 1530 239 (c++)"miral::MirRunner::set_exception_handler(std::function const&)@MIRAL_1.0" 1.0.0 1531 240 (c++)"miral::MirRunner::stop()@MIRAL_1.0" 1.0.0 1532 241 (c++)"miral::MirRunner::run_with(std::initializer_list >)@MIRAL_1.0" 1.0.0 1533 242 (c++)"miral::MirRunner::MirRunner(int, char const**)@MIRAL_1.0" 1.0.0 1534 243 (c++)"miral::MirRunner::MirRunner(int, char const**, char const*)@MIRAL_1.0" 1.0.0 1535 244 (c++)"miral::MirRunner::MirRunner(int, char const**)@MIRAL_1.0" 1.0.0 1536 245 (c++)"miral::MirRunner::MirRunner(int, char const**, char const*)@MIRAL_1.0" 1.0.0 1537 246 (c++)"miral::MirRunner::~MirRunner()@MIRAL_1.0" 1.0.0 1538 247 (c++)"miral::MirRunner::~MirRunner()@MIRAL_1.0" 1.0.0 1539 248 (c++)"miral::operator==(miral::Output::PhysicalSizeMM const&, miral::Output::PhysicalSizeMM const&)@MIRAL_1.0" 1.0.0 1540 249 (c++)"miral::operator==(miral::Window const&, std::shared_ptr const&)@MIRAL_1.0" 1.0.0 1541 250 (c++)"miral::operator==(miral::Window const&, miral::Window const&)@MIRAL_1.0" 1.0.0 1542 251 (c++)"miral::operator==(std::shared_ptr const&, miral::Window const&)@MIRAL_1.0" 1.0.0 1543 252 (c++)"miral::WindowInfo::height_inc() const@MIRAL_1.0" 1.0.0 1544 253 (c++)"miral::WindowInfo::is_visible() const@MIRAL_1.0" 1.0.0 1545 254 (c++)"miral::WindowInfo::max_aspect() const@MIRAL_1.0" 1.0.0 1546 255 (c++)"miral::WindowInfo::max_height() const@MIRAL_1.0" 1.0.0 1547 256 (c++)"miral::WindowInfo::min_aspect() const@MIRAL_1.0" 1.0.0 1548 257 (c++)"miral::WindowInfo::min_height() const@MIRAL_1.0" 1.0.0 1549 258 (c++)"miral::WindowInfo::can_morph_to(MirSurfaceType) const@MIRAL_1.0" 1.0.0 1550 259 (c++)"miral::WindowInfo::restore_rect() const@MIRAL_1.0" 1.0.0 1551 260 (c++)"miral::WindowInfo::can_be_active() const@MIRAL_1.0" 1.0.0 1552 261 (c++)"miral::WindowInfo::has_output_id() const@MIRAL_1.0" 1.0.0 1553 262 (c++)"miral::WindowInfo::confine_pointer() const@MIRAL_1.0" 1.0.0 1554 263 (c++)"miral::WindowInfo::constrain_resize(mir::geometry::Point&, mir::geometry::Size&) const@MIRAL_1.0" 1.0.0 1555 264 (c++)"miral::WindowInfo::must_have_parent() const@MIRAL_1.0" 1.0.0 1556 265 (c++)"miral::WindowInfo::must_not_have_parent() const@MIRAL_1.0" 1.0.0 1557 266 (c++)"miral::WindowInfo::preferred_orientation() const@MIRAL_1.0" 1.0.0 1558 267 (c++)"miral::WindowInfo::name[abi:cxx11]() const@MIRAL_1.0" 1.0.0 1559 268 (c++)"miral::WindowInfo::type() const@MIRAL_1.0" 1.0.0 1560 269 (c++)"miral::WindowInfo::state() const@MIRAL_1.0" 1.0.0 1561 270 (c++)"miral::WindowInfo::parent() const@MIRAL_1.0" 1.0.0 1562 271 (c++)"miral::WindowInfo::window() const@MIRAL_1.0" 1.0.0 1563 272 (c++)"miral::WindowInfo::children() const@MIRAL_1.0" 1.0.0 1564 273 (c++)"miral::WindowInfo::userdata() const@MIRAL_1.0" 1.0.0 1565 274 (c++)"miral::WindowInfo::max_width() const@MIRAL_1.0" 1.0.0 1566 275 (c++)"miral::WindowInfo::min_width() const@MIRAL_1.0" 1.0.0 1567 276 (c++)"miral::WindowInfo::output_id() const@MIRAL_1.0" 1.0.0 1568 277 (c++)"miral::WindowInfo::width_inc() const@MIRAL_1.0" 1.0.0 1569 278 (c++)"miral::CursorTheme::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1570 279 (c++)"miral::SetTerminator::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1571 280 (c++)"miral::DebugExtension::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1572 281 (c++)"miral::AddInitCallback::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1573 282 (c++)"miral::ApplicationInfo::application() const@MIRAL_1.0" 1.0.0 1574 283 (c++)"miral::ApplicationInfo::name[abi:cxx11]() const@MIRAL_1.0" 1.0.0 1575 284 (c++)"miral::ApplicationInfo::windows() const@MIRAL_1.0" 1.0.0 1576 285 (c++)"miral::ApplicationInfo::userdata() const@MIRAL_1.0" 1.0.0 1577 286 (c++)"miral::CommandLineOption::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1578 287 (c++)"miral::WindowManagerTools::active_window() const@MIRAL_1.0" 1.0.0 1579 288 (c++)"miral::WindowManagerTools::id_for_window[abi:cxx11](miral::Window const&) const@MIRAL_1.0" 1.0.0 1580 289 (c++)"miral::WindowManagerTools::count_applications() const@MIRAL_1.0" 1.0.0 1581 290 (c++)"miral::WindowManagerTools::info_for_window_id(std::__cxx11::basic_string, std::allocator > const&) const@MIRAL_1.0" 1.0.0 1582 291 (c++)"miral::WindowManagerTools::place_and_size_for_state(miral::WindowSpecification&, miral::WindowInfo const&) const@MIRAL_1.0" 1.0.0 1583 292 (c++)"miral::WindowManagerTools::info_for(miral::Window const&) const@MIRAL_1.0" 1.0.0 1584 293 (c++)"miral::WindowManagerTools::info_for(std::weak_ptr const&) const@MIRAL_1.0" 1.0.0 1585 294 (c++)"miral::WindowManagerTools::info_for(std::weak_ptr const&) const@MIRAL_1.0" 1.0.0 1586 295 (c++)"miral::WindowManagerTools::window_at(mir::geometry::Point) const@MIRAL_1.0" 1.0.0 1587 296 (c++)"miral::WindowSpecification::height_inc() const@MIRAL_1.0" 1.0.0 1588 297 (c++)"miral::WindowSpecification::input_mode() const@MIRAL_1.0" 1.0.0 1589 298 (c++)"miral::WindowSpecification::max_aspect() const@MIRAL_1.0" 1.0.0 1590 299 (c++)"miral::WindowSpecification::max_height() const@MIRAL_1.0" 1.0.0 1591 300 (c++)"miral::WindowSpecification::min_aspect() const@MIRAL_1.0" 1.0.0 1592 301 (c++)"miral::WindowSpecification::min_height() const@MIRAL_1.0" 1.0.0 1593 302 (c++)"miral::WindowSpecification::input_shape() const@MIRAL_1.0" 1.0.0 1594 303 (c++)"miral::WindowSpecification::shell_chrome() const@MIRAL_1.0" 1.0.0 1595 304 (c++)"miral::WindowSpecification::confine_pointer() const@MIRAL_1.0" 1.0.0 1596 305 (c++)"miral::WindowSpecification::placement_hints() const@MIRAL_1.0" 1.0.0 1597 306 (c++)"miral::WindowSpecification::preferred_orientation() const@MIRAL_1.0" 1.0.0 1598 307 (c++)"miral::WindowSpecification::window_placement_gravity() const@MIRAL_1.0" 1.0.0 1599 308 (c++)"miral::WindowSpecification::aux_rect_placement_offset() const@MIRAL_1.0" 1.0.0 1600 309 (c++)"miral::WindowSpecification::aux_rect_placement_gravity() const@MIRAL_1.0" 1.0.0 1601 310 (c++)"miral::WindowSpecification::name[abi:cxx11]() const@MIRAL_1.0" 1.0.0 1602 311 (c++)"miral::WindowSpecification::size() const@MIRAL_1.0" 1.0.0 1603 312 (c++)"miral::WindowSpecification::type() const@MIRAL_1.0" 1.0.0 1604 313 (c++)"miral::WindowSpecification::state() const@MIRAL_1.0" 1.0.0 1605 314 (c++)"miral::WindowSpecification::parent() const@MIRAL_1.0" 1.0.0 1606 315 (c++)"miral::WindowSpecification::update(mir::scene::SurfaceCreationParameters&) const@MIRAL_1.0" 1.0.0 1607 316 (c++)"miral::WindowSpecification::aux_rect() const@MIRAL_1.0" 1.0.0 1608 317 (c++)"miral::WindowSpecification::top_left() const@MIRAL_1.0" 1.0.0 1609 318 (c++)"miral::WindowSpecification::userdata() const@MIRAL_1.0" 1.0.0 1610 319 (c++)"miral::WindowSpecification::max_width() const@MIRAL_1.0" 1.0.0 1611 320 (c++)"miral::WindowSpecification::min_width() const@MIRAL_1.0" 1.0.0 1612 321 (c++)"miral::WindowSpecification::output_id() const@MIRAL_1.0" 1.0.0 1613 322 (c++)"miral::WindowSpecification::width_inc() const@MIRAL_1.0" 1.0.0 1614 323 (c++)"miral::ActiveOutputsMonitor::process_outputs(std::function > const&)> const&) const@MIRAL_1.0" 1.0.0 1615 324 (c++)"miral::WindowManagerOptions::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1616 325 (c++)"miral::SetCommandLineHandler::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1617 326 (c++)"miral::ApplicationCredentials::gid() const@MIRAL_1.0" 1.0.0 1618 327 (c++)"miral::ApplicationCredentials::pid() const@MIRAL_1.0" 1.0.0 1619 328 (c++)"miral::ApplicationCredentials::uid() const@MIRAL_1.0" 1.0.0 1620 329 (c++)"miral::InternalClientLauncher::launch(std::__cxx11::basic_string, std::allocator > const&, std::function const&, std::function)> const&) const@MIRAL_1.0" 1.0.0 1621 330 (c++)"miral::SetWindowManagmentPolicy::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1622 331 (c++)"miral::BasicSetApplicationAuthorizer::the_application_authorizer() const@MIRAL_1.0" 1.0.0 1623 332 (c++)"miral::Keymap::operator()(mir::Server&) const@MIRAL_1.0" 1.0.0 1624 333 (c++)"miral::Output::power_mode() const@MIRAL_1.0" 1.0.0 1625 334 (c++)"miral::Output::form_factor() const@MIRAL_1.0" 1.0.0 1626 335 (c++)"miral::Output::orientation() const@MIRAL_1.0" 1.0.0 1627 336 (c++)"miral::Output::pixel_format() const@MIRAL_1.0" 1.0.0 1628 337 (c++)"miral::Output::refresh_rate() const@MIRAL_1.0" 1.0.0 1629 338 (c++)"miral::Output::is_same_output(miral::Output const&) const@MIRAL_1.0" 1.0.0 1630 339 (c++)"miral::Output::physical_size_mm() const@MIRAL_1.0" 1.0.0 1631 340 (c++)"miral::Output::type() const@MIRAL_1.0" 1.0.0 1632 341 (c++)"miral::Output::used() const@MIRAL_1.0" 1.0.0 1633 342 (c++)"miral::Output::scale() const@MIRAL_1.0" 1.0.0 1634 343 (c++)"miral::Output::valid() const@MIRAL_1.0" 1.0.0 1635 344 (c++)"miral::Output::extents() const@MIRAL_1.0" 1.0.0 1636 345 (c++)"miral::Output::connected() const@MIRAL_1.0" 1.0.0 1637 346 (c++)"miral::Window::application() const@MIRAL_1.0" 1.0.0 1638 347 (c++)"miral::Window::size() const@MIRAL_1.0" 1.0.0 1639 348 (c++)"miral::Window::top_left() const@MIRAL_1.0" 1.0.0 1640 349 (c++)"miral::Window::operator std::shared_ptr() const@MIRAL_1.0" 1.0.0 1641 350 (c++)"miral::Window::operator std::weak_ptr() const@MIRAL_1.0" 1.0.0 1642 351 (c++)"miral::Window::operator bool() const@MIRAL_1.0" 1.0.0 1643 352 (c++)"typeinfo for miral::ActiveOutputsListener@MIRAL_1.0" 1.0.0 1644 353 (c++)"typeinfo for miral::WindowManagementPolicy@MIRAL_1.0" 1.0.0 1645 354 (c++)"typeinfo for miral::CanonicalWindowManagerPolicy@MIRAL_1.0" 1.0.0 1646 355 (c++)"vtable for miral::ActiveOutputsListener@MIRAL_1.0" 1.0.0 1647 356 (c++)"vtable for miral::WindowManagementPolicy@MIRAL_1.0" 1.0.0 1648 357 (c++)"vtable for miral::CanonicalWindowManagerPolicy@MIRAL_1.0" 1.0.0 1649 358 MIRAL_1.1@MIRAL_1.1 1.1.0 1650 359 (c++)"miral::WindowInfo::needs_titlebar(MirWindowType)@MIRAL_1.1" 1.1.0 1651 360 (c++)"miral::WindowInfo::type(MirWindowType)@MIRAL_1.1" 1.1.0 1652 361 (c++)"miral::WindowInfo::state(MirWindowState)@MIRAL_1.1" 1.1.0 1653 362 (c++)"miral::WindowManagementPolicy::advise_state_change(miral::WindowInfo const&, MirWindowState)@MIRAL_1.1" 1.1.0 1654 363 (c++)"miral::WindowInfo::can_morph_to(MirWindowType) const@MIRAL_1.1" 1.1.0 1655 364 (c++)"miral::CanonicalWindowManagerPolicy::place_new_window(miral::ApplicationInfo const&, miral::WindowSpecification const&)@MIRAL_1.1" 1.1.0 1656 365 MIRAL_1.2@MIRAL_1.2 1.2.0 1657 366 (c++)"miral::StartupInternalClient::StartupInternalClient(std::__cxx11::basic_string, std::allocator >, std::function, std::function)>)@MIRAL_1.2" 1.2.0 1658 367 (c++)"miral::InternalClientLauncher::launch(std::__cxx11::basic_string, std::allocator > const&, std::function const&, std::function)> const&) const@MIRAL_1.2" 1.2.0 1659 368 (c++)"miral::WindowInfo::shell_chrome(MirShellChrome)@MIRAL_1.2" 1.2.0 1660 369 (c++)"miral::WindowInfo::shell_chrome() const@MIRAL_1.2" 1.2.0 1661 370 (c++)"miral::WindowManagerTools::drag_window(miral::Window const&, mir::geometry::Displacement)@MIRAL_1.2" 1.2.0 1662 371 (c++)"typeinfo for miral::ApplicationAuthorizer@MIRAL_1.0" 1.2.0 1663 372 (c++)"typeinfo for miral::ApplicationAuthorizer1@MIRAL_1.2" 1.2.0 1664 373 MIRAL_1.3@MIRAL_1.3 1.3.0 1665 374 (c++)"miral::operator<(miral::Window const&, miral::Window const&)@MIRAL_1.0" 1.3.0 1666 375 (c++)"miral::WindowManagerTools::create_workspace()@MIRAL_1.3" 1.3.0 1667 376 (c++)"miral::WindowManagerTools::add_tree_to_workspace(miral::Window const&, std::shared_ptr const&)@MIRAL_1.3" 1.3.0 1668 377 (c++)"miral::WindowManagerTools::remove_tree_from_workspace(miral::Window const&, std::shared_ptr const&)@MIRAL_1.3" 1.3.0 1669 378 (c++)"miral::WorkspacePolicy::advise_adding_to_workspace(std::shared_ptr const&, std::vector > const&)@MIRAL_1.3" 1.3.0 1670 379 (c++)"miral::WorkspacePolicy::advise_removing_from_workspace(std::shared_ptr const&, std::vector > const&)@MIRAL_1.3" 1.3.0 1671 380 (c++)"miral::WindowManagerTools::for_each_window_in_workspace(std::shared_ptr const&, std::function const&)@MIRAL_1.3" 1.3.0 1672 381 (c++)"miral::WindowManagerTools::for_each_workspace_containing(miral::Window const&, std::function const&)> const&)@MIRAL_1.3" 1.3.0 1673 382 (c++)"typeinfo for miral::WorkspacePolicy@MIRAL_1.3" 1.3.0 1674 383 (c++)"vtable for miral::WorkspacePolicy@MIRAL_1.3" 1.3.0 1675 0 384 1676 === added file 'debian/libmirclientcpp-dev.install' 1677 --- debian/libmirclientcpp-dev.install 1970-01-01 00:00:00 +0000 1678 +++ debian/libmirclientcpp-dev.install 2017-03-01 12:28:42 +0000 1679 @@ -0,0 +1,2 @@ 1680 1 usr/include/miral/mir/*/* 1681 2 usr/lib/*/pkgconfig/mirclientcpp.pc 1682 0 3 1683 === added file 'debian/miral-doc.install' 1684 --- debian/miral-doc.install 1970-01-01 00:00:00 +0000 1685 +++ debian/miral-doc.install 2017-03-01 12:28:42 +0000 1686 @@ -0,0 +1,1 @@ 1687 1 usr/share/doc/miral-doc/ 1688 0 2 1689 === added file 'debian/miral-examples.install' 1690 --- debian/miral-examples.install 1970-01-01 00:00:00 +0000 1691 +++ debian/miral-examples.install 2017-03-01 12:28:42 +0000 1692 @@ -0,0 +1,9 @@ 1693 1 usr/bin/miral-shell 1694 2 usr/bin/miral-run 1695 3 usr/bin/miral-kiosk 1696 4 usr/bin/miral-xrun 1697 5 usr/bin/miral-screencast 1698 6 usr/bin/miral-desktop 1699 7 usr/bin/miral-app 1700 8 usr/share/applications/miral-shell.desktop 1701 9 usr/share/icons/hicolor/scalable/apps/ubuntu-logo.svg 1702 0 10 1703 === added file 'debian/rules' 1704 --- debian/rules 1970-01-01 00:00:00 +0000 1705 +++ debian/rules 2017-03-01 12:28:42 +0000 1706 @@ -0,0 +1,26 @@ 1707 1 #!/usr/bin/make -f 1708 2 1709 3 DEB_HOST_MULTIARCH ?=$(shell dpkg-architecture -qDEB_HOST_MULTIARCH) 1710 4 1711 5 export DPKG_GENSYMBOLS_CHECK_LEVEL = 4 1712 6 1713 7 # GLPixelBuffer doesn't support big endian architectures 1714 8 testskip_architectures := s390x powerpc 1715 9 1716 10 %: 1717 11 dh $@ --parallel --fail-missing 1718 12 1719 13 COMMON_CONFIGURE_OPTIONS = \ 1720 14 -DCMAKE_INSTALL_LIBEXECDIR="lib/$(DEB_HOST_MULTIARCH)/miral" 1721 15 1722 16 override_dh_auto_configure: 1723 17 dh_auto_configure -- $(COMMON_CONFIGURE_OPTIONS) 1724 18 1725 19 # Only build the docs when we need them 1726 20 override_dh_auto_build-indep: 1727 21 dh_auto_build -- doc 1728 22 1729 23 override_dh_auto_test: 1730 24 ifneq ($(DEB_HOST_ARCH),$(findstring$(DEB_HOST_ARCH), $(testskip_architectures))) 1731 25 dh_auto_test$@ 1732 26 endif 1733 0 27 1734 === added directory 'debian/tmp' 1735 === added directory 'doc' 1736 === renamed directory 'doc' => 'doc.moved' 1737 === added file 'doc/Doxyfile.in' 1738 --- doc/Doxyfile.in 1970-01-01 00:00:00 +0000 1739 +++ doc/Doxyfile.in 2017-03-01 12:28:42 +0000 1740 @@ -0,0 +1,1926 @@ 1741 1 # Doxyfile 1.8.4 1742 2 1743 3 # This file describes the settings to be used by the documentation system 1744 4 # doxygen (www.doxygen.org) for a project. 1745 5 # 1746 6 # All text after a double hash (##) is considered a comment and is placed 1747 7 # in front of the TAG it is preceding . 1748 8 # All text after a hash (#) is considered a comment and will be ignored. 1749 9 # The format is: 1750 10 # TAG = value [value, ...] 1751 11 # For lists items can also be appended using: 1752 12 # TAG += value [value, ...] 1753 13 # Values that contain spaces should be placed between quotes (" "). 1754 14 1755 15 #--------------------------------------------------------------------------- 1756 16 # Project related configuration options 1757 17 #--------------------------------------------------------------------------- 1758 18 1759 19 # This tag specifies the encoding used for all characters in the config file 1760 20 # that follow. The default is UTF-8 which is also the encoding used for all 1761 21 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 1762 22 # iconv built into libc) for the transcoding. See 1763 23 # http://www.gnu.org/software/libiconv for the list of possible encodings. 1764 24 1765 25 DOXYFILE_ENCODING = UTF-8 1766 26 1767 27 # The PROJECT_NAME tag is a single word (or sequence of words) that should 1768 28 # identify the project. Note that if you do not use Doxywizard you need 1769 29 # to put quotes around the project name if it contains spaces. 1770 30 1771 31 PROJECT_NAME = MirAL 1772 32 1773 33 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 1774 34 # This could be handy for archiving the generated documentation or 1775 35 # if some version control system is used. 1776 36 1777 37 PROJECT_NUMBER = 1778 38 1779 39 # Using the PROJECT_BRIEF tag one can provide an optional one line description 1780 40 # for a project that appears at the top of each page and should give viewer 1781 41 # a quick idea about the purpose of the project. Keep the description short. 1782 42 1783 43 PROJECT_BRIEF = 1784 44 1785 45 # With the PROJECT_LOGO tag one can specify an logo or icon that is 1786 46 # included in the documentation. The maximum height of the logo should not 1787 47 # exceed 55 pixels and the maximum width should not exceed 200 pixels. 1788 48 # Doxygen will copy the logo to the output directory. 1789 49 1790 50 PROJECT_LOGO = 1791 51 1792 52 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 1793 53 # base path where the generated documentation will be put. 1794 54 # If a relative path is entered, it will be relative to the location 1795 55 # where doxygen was started. If left blank the current directory will be used. 1796 56 1797 57 OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/doc 1798 58 1799 59 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 1800 60 # 4096 sub-directories (in 2 levels) under the output directory of each output 1801 61 # format and will distribute the generated files over these directories. 1802 62 # Enabling this option can be useful when feeding doxygen a huge amount of 1803 63 # source files, where putting all generated files in the same directory would 1804 64 # otherwise cause performance problems for the file system. 1805 65 1806 66 CREATE_SUBDIRS = NO 1807 67 1808 68 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 1809 69 # documentation generated by doxygen is written. Doxygen will use this 1810 70 # information to generate all constant output in the proper language. 1811 71 # The default language is English, other supported languages are: 1812 72 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 1813 73 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 1814 74 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 1815 75 # messages), Korean, Korean-en, Latvian, Lithuanian, Norwegian, Macedonian, 1816 76 # Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, 1817 77 # Slovak, Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 1818 78 1819 79 OUTPUT_LANGUAGE = English 1820 80 1821 81 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 1822 82 # include brief member descriptions after the members that are listed in 1823 83 # the file and class documentation (similar to JavaDoc). 1824 84 # Set to NO to disable this. 1825 85 1826 86 BRIEF_MEMBER_DESC = YES 1827 87 1828 88 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 1829 89 # the brief description of a member or function before the detailed description. 1830 90 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 1831 91 # brief descriptions will be completely suppressed. 1832 92 1833 93 REPEAT_BRIEF = YES 1834 94 1835 95 # This tag implements a quasi-intelligent brief description abbreviator 1836 96 # that is used to form the text in various listings. Each string 1837 97 # in this list, if found as the leading text of the brief description, will be 1838 98 # stripped from the text and the result after processing the whole list, is 1839 99 # used as the annotated text. Otherwise, the brief description is used as-is. 1840 100 # If left blank, the following values are used ("$name" is automatically 1841 101 # replaced with the name of the entity): "The$name class" "The $name widget" 1842 102 # "The$name file" "is" "provides" "specifies" "contains" 1843 103 # "represents" "a" "an" "the" 1844 104 1845 105 ABBREVIATE_BRIEF = "The $name class" \ 1846 106 "The$name widget" \ 1847 107 "The $name file" \ 1848 108 is \ 1849 109 provides \ 1850 110 specifies \ 1851 111 contains \ 1852 112 represents \ 1853 113 a \ 1854 114 an \ 1855 115 the 1856 116 1857 117 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 1858 118 # Doxygen will generate a detailed section even if there is only a brief 1859 119 # description. 1860 120 1861 121 ALWAYS_DETAILED_SEC = NO 1862 122 1863 123 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 1864 124 # inherited members of a class in the documentation of that class as if those 1865 125 # members were ordinary class members. Constructors, destructors and assignment 1866 126 # operators of the base classes will not be shown. 1867 127 1868 128 INLINE_INHERITED_MEMB = NO 1869 129 1870 130 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 1871 131 # path before files name in the file list and in the header files. If set 1872 132 # to NO the shortest path that makes the file name unique will be used. 1873 133 1874 134 FULL_PATH_NAMES = YES 1875 135 1876 136 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 1877 137 # can be used to strip a user-defined part of the path. Stripping is 1878 138 # only done if one of the specified strings matches the left-hand part of 1879 139 # the path. The tag can be used to show relative paths in the file list. 1880 140 # If left blank the directory from which doxygen is run is used as the 1881 141 # path to strip. Note that you specify absolute paths here, but also 1882 142 # relative paths, which will be relative from the directory where doxygen is 1883 143 # started. 1884 144 1885 145 STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@ 1886 146 1887 147 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 1888 148 # the path mentioned in the documentation of a class, which tells 1889 149 # the reader which header file to include in order to use a class. 1890 150 # If left blank only the name of the header file containing the class 1891 151 # definition is used. Otherwise one should specify the include paths that 1892 152 # are normally passed to the compiler using the -I flag. 1893 153 1894 154 STRIP_FROM_INC_PATH = @CMAKE_CURRENT_SOURCE_DIR@/include 1895 155 1896 156 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 1897 157 # (but less readable) file names. This can be useful if your file system 1898 158 # doesn't support long names like on DOS, Mac, or CD-ROM. 1899 159 1900 160 SHORT_NAMES = NO 1901 161 1902 162 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 1903 163 # will interpret the first line (until the first dot) of a JavaDoc-style 1904 164 # comment as the brief description. If set to NO, the JavaDoc 1905 165 # comments will behave just like regular Qt-style comments 1906 166 # (thus requiring an explicit @brief command for a brief description.) 1907 167 1908 168 JAVADOC_AUTOBRIEF = YES 1909 169 1910 170 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 1911 171 # interpret the first line (until the first dot) of a Qt-style 1912 172 # comment as the brief description. If set to NO, the comments 1913 173 # will behave just like regular Qt-style comments (thus requiring 1914 174 # an explicit \brief command for a brief description.) 1915 175 1916 176 QT_AUTOBRIEF = NO 1917 177 1918 178 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 1919 179 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 1920 180 # comments) as a brief description. This used to be the default behaviour. 1921 181 # The new default is to treat a multi-line C++ comment block as a detailed 1922 182 # description. Set this tag to YES if you prefer the old behaviour instead. 1923 183 1924 184 MULTILINE_CPP_IS_BRIEF = YES 1925 185 1926 186 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 1927 187 # member inherits the documentation from any documented member that it 1928 188 # re-implements. 1929 189 1930 190 INHERIT_DOCS = YES 1931 191 1932 192 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 1933 193 # a new page for each member. If set to NO, the documentation of a member will 1934 194 # be part of the file/class/namespace that contains it. 1935 195 1936 196 SEPARATE_MEMBER_PAGES = NO 1937 197 1938 198 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 1939 199 # Doxygen uses this value to replace tabs by spaces in code fragments. 1940 200 1941 201 TAB_SIZE = 4 1942 202 1943 203 # This tag can be used to specify a number of aliases that acts 1944 204 # as commands in the documentation. An alias has the form "name=value". 1945 205 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 1946 206 # put the command \sideeffect (or @sideeffect) in the documentation, which 1947 207 # will result in a user-defined paragraph with heading "Side Effects:". 1948 208 # You can put \n's in the value part of an alias to insert newlines. 1949 209 1950 210 ALIASES = 1951 211 1952 212 # This tag can be used to specify a number of word-keyword mappings (TCL only). 1953 213 # A mapping has the form "name=value". For example adding 1954 214 # "class=itcl::class" will allow you to use the command class in the 1955 215 # itcl::class meaning. 1956 216 1957 217 TCL_SUBST = 1958 218 1959 219 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 1960 220 # sources only. Doxygen will then generate output that is more tailored for C. 1961 221 # For instance, some of the names that are used will be different. The list 1962 222 # of all members will be omitted, etc. 1963 223 1964 224 OPTIMIZE_OUTPUT_FOR_C = NO 1965 225 1966 226 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 1967 227 # sources only. Doxygen will then generate output that is more tailored for 1968 228 # Java. For instance, namespaces will be presented as packages, qualified 1969 229 # scopes will look different, etc. 1970 230 1971 231 OPTIMIZE_OUTPUT_JAVA = NO 1972 232 1973 233 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 1974 234 # sources only. Doxygen will then generate output that is more tailored for 1975 235 # Fortran. 1976 236 1977 237 OPTIMIZE_FOR_FORTRAN = NO 1978 238 1979 239 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 1980 240 # sources. Doxygen will then generate output that is tailored for 1981 241 # VHDL. 1982 242 1983 243 OPTIMIZE_OUTPUT_VHDL = NO 1984 244 1985 245 # Doxygen selects the parser to use depending on the extension of the files it 1986 246 # parses. With this tag you can assign which parser to use for a given 1987 247 # extension. Doxygen has a built-in mapping, but you can override or extend it 1988 248 # using this tag. The format is ext=language, where ext is a file extension, 1989 249 # and language is one of the parsers supported by doxygen: IDL, Java, 1990 250 # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 1991 251 # C++. For instance to make doxygen treat .inc files as Fortran files (default 1992 252 # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 1993 253 # that for custom extensions you also need to set FILE_PATTERNS otherwise the 1994 254 # files are not read by doxygen. 1995 255 1996 256 EXTENSION_MAPPING = 1997 257 1998 258 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 1999 259 # comments according to the Markdown format, which allows for more readable 2000 260 # documentation. See http://daringfireball.net/projects/markdown/ for details. 2001 261 # The output of markdown processing is further processed by doxygen, so you 2002 262 # can mix doxygen, HTML, and XML commands with Markdown formatting. 2003 263 # Disable only in case of backward compatibilities issues. 2004 264 2005 265 MARKDOWN_SUPPORT = YES 2006 266 2007 267 # When enabled doxygen tries to link words that correspond to documented 2008 268 # classes, or namespaces to their corresponding documentation. Such a link can 2009 269 # be prevented in individual cases by by putting a % sign in front of the word 2010 270 # or globally by setting AUTOLINK_SUPPORT to NO. 2011 271 2012 272 AUTOLINK_SUPPORT = YES 2013 273 2014 274 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 2015 275 # to include (a tag file for) the STL sources as input, then you should 2016 276 # set this tag to YES in order to let doxygen match functions declarations and 2017 277 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 2018 278 # func(std::string) {}). This also makes the inheritance and collaboration 2019 279 # diagrams that involve STL classes more complete and accurate. 2020 280 2021 281 BUILTIN_STL_SUPPORT = YES 2022 282 2023 283 # If you use Microsoft's C++/CLI language, you should set this option to YES to 2024 284 # enable parsing support. 2025 285 2026 286 CPP_CLI_SUPPORT = NO 2027 287 2028 288 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 2029 289 # Doxygen will parse them like normal C++ but will assume all classes use public 2030 290 # instead of private inheritance when no explicit protection keyword is present. 2031 291 2032 292 SIP_SUPPORT = NO 2033 293 2034 294 # For Microsoft's IDL there are propget and propput attributes to indicate 2035 295 # getter and setter methods for a property. Setting this option to YES (the 2036 296 # default) will make doxygen replace the get and set methods by a property in 2037 297 # the documentation. This will only work if the methods are indeed getting or 2038 298 # setting a simple type. If this is not the case, or you want to show the 2039 299 # methods anyway, you should set this option to NO. 2040 300 2041 301 IDL_PROPERTY_SUPPORT = YES 2042 302 2043 303 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 2044 304 # tag is set to YES, then doxygen will reuse the documentation of the first 2045 305 # member in the group (if any) for the other members of the group. By default 2046 306 # all members of a group must be documented explicitly. 2047 307 2048 308 DISTRIBUTE_GROUP_DOC = NO 2049 309 2050 310 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 2051 311 # the same type (for instance a group of public functions) to be put as a 2052 312 # subgroup of that type (e.g. under the Public Functions section). Set it to 2053 313 # NO to prevent subgrouping. Alternatively, this can be done per class using 2054 314 # the \nosubgrouping command. 2055 315 2056 316 SUBGROUPING = YES 2057 317 2058 318 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 2059 319 # unions are shown inside the group in which they are included (e.g. using 2060 320 # @ingroup) instead of on a separate page (for HTML and Man pages) or 2061 321 # section (for LaTeX and RTF). 2062 322 2063 323 INLINE_GROUPED_CLASSES = NO 2064 324 2065 325 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 2066 326 # unions with only public data fields or simple typedef fields will be shown 2067 327 # inline in the documentation of the scope in which they are defined (i.e. file, 2068 328 # namespace, or group documentation), provided this scope is documented. If set 2069 329 # to NO (the default), structs, classes, and unions are shown on a separate 2070 330 # page (for HTML and Man pages) or section (for LaTeX and RTF). 2071 331 2072 332 INLINE_SIMPLE_STRUCTS = NO 2073 333 2074 334 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 2075 335 # is documented as struct, union, or enum with the name of the typedef. So 2076 336 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 2077 337 # with name TypeT. When disabled the typedef will appear as a member of a file, 2078 338 # namespace, or class. And the struct will be named TypeS. This can typically 2079 339 # be useful for C code in case the coding convention dictates that all compound 2080 340 # types are typedef'ed and only the typedef is referenced, never the tag name. 2081 341 2082 342 TYPEDEF_HIDES_STRUCT = NO 2083 343 2084 344 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 2085 345 # cache is used to resolve symbols given their name and scope. Since this can 2086 346 # be an expensive process and often the same symbol appear multiple times in 2087 347 # the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too 2088 348 # small doxygen will become slower. If the cache is too large, memory is wasted. 2089 349 # The cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid 2090 350 # range is 0..9, the default is 0, corresponding to a cache size of 2^16 = 65536 2091 351 # symbols. 2092 352 2093 353 LOOKUP_CACHE_SIZE = 0 2094 354 2095 355 #--------------------------------------------------------------------------- 2096 356 # Build related configuration options 2097 357 #--------------------------------------------------------------------------- 2098 358 2099 359 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 2100 360 # documentation are documented, even if no documentation was available. 2101 361 # Private class members and static file members will be hidden unless 2102 362 # the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES 2103 363 2104 364 EXTRACT_ALL = YES 2105 365 2106 366 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 2107 367 # will be included in the documentation. 2108 368 2109 369 EXTRACT_PRIVATE = NO 2110 370 2111 371 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 2112 372 # scope will be included in the documentation. 2113 373 2114 374 EXTRACT_PACKAGE = NO 2115 375 2116 376 # If the EXTRACT_STATIC tag is set to YES all static members of a file 2117 377 # will be included in the documentation. 2118 378 2119 379 EXTRACT_STATIC = NO 2120 380 2121 381 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 2122 382 # defined locally in source files will be included in the documentation. 2123 383 # If set to NO only classes defined in header files are included. 2124 384 2125 385 EXTRACT_LOCAL_CLASSES = NO 2126 386 2127 387 # This flag is only useful for Objective-C code. When set to YES local 2128 388 # methods, which are defined in the implementation section but not in 2129 389 # the interface are included in the documentation. 2130 390 # If set to NO (the default) only methods in the interface are included. 2131 391 2132 392 EXTRACT_LOCAL_METHODS = NO 2133 393 2134 394 # If this flag is set to YES, the members of anonymous namespaces will be 2135 395 # extracted and appear in the documentation as a namespace called 2136 396 # 'anonymous_namespace{file}', where file will be replaced with the base 2137 397 # name of the file that contains the anonymous namespace. By default 2138 398 # anonymous namespaces are hidden. 2139 399 2140 400 EXTRACT_ANON_NSPACES = NO 2141 401 2142 402 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 2143 403 # undocumented members of documented classes, files or namespaces. 2144 404 # If set to NO (the default) these members will be included in the 2145 405 # various overviews, but no documentation section is generated. 2146 406 # This option has no effect if EXTRACT_ALL is enabled. 2147 407 2148 408 HIDE_UNDOC_MEMBERS = NO 2149 409 2150 410 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 2151 411 # undocumented classes that are normally visible in the class hierarchy. 2152 412 # If set to NO (the default) these classes will be included in the various 2153 413 # overviews. This option has no effect if EXTRACT_ALL is enabled. 2154 414 2155 415 HIDE_UNDOC_CLASSES = NO 2156 416 2157 417 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 2158 418 # friend (class|struct|union) declarations. 2159 419 # If set to NO (the default) these declarations will be included in the 2160 420 # documentation. 2161 421 2162 422 HIDE_FRIEND_COMPOUNDS = NO 2163 423 2164 424 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 2165 425 # documentation blocks found inside the body of a function. 2166 426 # If set to NO (the default) these blocks will be appended to the 2167 427 # function's detailed documentation block. 2168 428 2169 429 HIDE_IN_BODY_DOCS = NO 2170 430 2171 431 # The INTERNAL_DOCS tag determines if documentation 2172 432 # that is typed after a \internal command is included. If the tag is set 2173 433 # to NO (the default) then the documentation will be excluded. 2174 434 # Set it to YES to include the internal documentation. 2175 435 2176 436 INTERNAL_DOCS = NO 2177 437 2178 438 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 2179 439 # file names in lower-case letters. If set to YES upper-case letters are also 2180 440 # allowed. This is useful if you have classes or files whose names only differ 2181 441 # in case and if your file system supports case sensitive file names. Windows 2182 442 # and Mac users are advised to set this option to NO. 2183 443 2184 444 CASE_SENSE_NAMES = NO 2185 445 2186 446 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 2187 447 # will show members with their full class and namespace scopes in the 2188 448 # documentation. If set to YES the scope will be hidden. 2189 449 2190 450 HIDE_SCOPE_NAMES = NO 2191 451 2192 452 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 2193 453 # will put a list of the files that are included by a file in the documentation 2194 454 # of that file. 2195 455 2196 456 SHOW_INCLUDE_FILES = YES 2197 457 2198 458 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 2199 459 # will list include files with double quotes in the documentation 2200 460 # rather than with sharp brackets. 2201 461 2202 462 FORCE_LOCAL_INCLUDES = NO 2203 463 2204 464 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 2205 465 # is inserted in the documentation for inline members. 2206 466 2207 467 INLINE_INFO = YES 2208 468 2209 469 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 2210 470 # will sort the (detailed) documentation of file and class members 2211 471 # alphabetically by member name. If set to NO the members will appear in 2212 472 # declaration order. 2213 473 2214 474 SORT_MEMBER_DOCS = YES 2215 475 2216 476 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 2217 477 # brief documentation of file, namespace and class members alphabetically 2218 478 # by member name. If set to NO (the default) the members will appear in 2219 479 # declaration order. 2220 480 2221 481 SORT_BRIEF_DOCS = NO 2222 482 2223 483 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 2224 484 # will sort the (brief and detailed) documentation of class members so that 2225 485 # constructors and destructors are listed first. If set to NO (the default) 2226 486 # the constructors will appear in the respective orders defined by 2227 487 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 2228 488 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 2229 489 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 2230 490 2231 491 SORT_MEMBERS_CTORS_1ST = NO 2232 492 2233 493 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 2234 494 # hierarchy of group names into alphabetical order. If set to NO (the default) 2235 495 # the group names will appear in their defined order. 2236 496 2237 497 SORT_GROUP_NAMES = NO 2238 498 2239 499 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 2240 500 # sorted by fully-qualified names, including namespaces. If set to 2241 501 # NO (the default), the class list will be sorted only by class name, 2242 502 # not including the namespace part. 2243 503 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 2244 504 # Note: This option applies only to the class list, not to the 2245 505 # alphabetical list. 2246 506 2247 507 SORT_BY_SCOPE_NAME = NO 2248 508 2249 509 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 2250 510 # do proper type resolution of all parameters of a function it will reject a 2251 511 # match between the prototype and the implementation of a member function even 2252 512 # if there is only one candidate or it is obvious which candidate to choose 2253 513 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 2254 514 # will still accept a match between prototype and implementation in such cases. 2255 515 2256 516 STRICT_PROTO_MATCHING = NO 2257 517 2258 518 # The GENERATE_TODOLIST tag can be used to enable (YES) or 2259 519 # disable (NO) the todo list. This list is created by putting \todo 2260 520 # commands in the documentation. 2261 521 2262 522 GENERATE_TODOLIST = YES 2263 523 2264 524 # The GENERATE_TESTLIST tag can be used to enable (YES) or 2265 525 # disable (NO) the test list. This list is created by putting \test 2266 526 # commands in the documentation. 2267 527 2268 528 GENERATE_TESTLIST = YES 2269 529 2270 530 # The GENERATE_BUGLIST tag can be used to enable (YES) or 2271 531 # disable (NO) the bug list. This list is created by putting \bug 2272 532 # commands in the documentation. 2273 533 2274 534 GENERATE_BUGLIST = YES 2275 535 2276 536 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 2277 537 # disable (NO) the deprecated list. This list is created by putting 2278 538 # \deprecated commands in the documentation. 2279 539 2280 540 GENERATE_DEPRECATEDLIST= YES 2281 541 2282 542 # The ENABLED_SECTIONS tag can be used to enable conditional 2283 543 # documentation sections, marked by \if section-label ... \endif 2284 544 # and \cond section-label ... \endcond blocks. 2285 545 2286 546 ENABLED_SECTIONS = 2287 547 2288 548 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 2289 549 # the initial value of a variable or macro consists of for it to appear in 2290 550 # the documentation. If the initializer consists of more lines than specified 2291 551 # here it will be hidden. Use a value of 0 to hide initializers completely. 2292 552 # The appearance of the initializer of individual variables and macros in the 2293 553 # documentation can be controlled using \showinitializer or \hideinitializer 2294 554 # command in the documentation regardless of this setting. 2295 555 2296 556 MAX_INITIALIZER_LINES = 30 2297 557 2298 558 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 2299 559 # at the bottom of the documentation of classes and structs. If set to YES the 2300 560 # list will mention the files that were used to generate the documentation. 2301 561 2302 562 SHOW_USED_FILES = YES 2303 563 2304 564 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 2305 565 # This will remove the Files entry from the Quick Index and from the 2306 566 # Folder Tree View (if specified). The default is YES. 2307 567 2308 568 SHOW_FILES = YES 2309 569 2310 570 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 2311 571 # Namespaces page. 2312 572 # This will remove the Namespaces entry from the Quick Index 2313 573 # and from the Folder Tree View (if specified). The default is YES. 2314 574 2315 575 SHOW_NAMESPACES = YES 2316 576 2317 577 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 2318 578 # doxygen should invoke to get the current version for each file (typically from 2319 579 # the version control system). Doxygen will invoke the program by executing (via 2320 580 # popen()) the command , where is the value of 2321 581 # the FILE_VERSION_FILTER tag, and is the name of an input file 2322 582 # provided by doxygen. Whatever the program writes to standard output 2323 583 # is used as the file version. See the manual for examples. 2324 584 2325 585 FILE_VERSION_FILTER = 2326 586 2327 587 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 2328 588 # by doxygen. The layout file controls the global structure of the generated 2329 589 # output files in an output format independent way. To create the layout file 2330 590 # that represents doxygen's defaults, run doxygen with the -l option. 2331 591 # You can optionally specify a file name after the option, if omitted 2332 592 # DoxygenLayout.xml will be used as the name of the layout file. 2333 593 2334 594 LAYOUT_FILE = 2335 595 2336 596 # The CITE_BIB_FILES tag can be used to specify one or more bib files 2337 597 # containing the references data. This must be a list of .bib files. The 2338 598 # .bib extension is automatically appended if omitted. Using this command 2339 599 # requires the bibtex tool to be installed. See also 2340 600 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 2341 601 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 2342 602 # feature you need bibtex and perl available in the search path. Do not use 2343 603 # file names with spaces, bibtex cannot handle them. 2344 604 2345 605 CITE_BIB_FILES = 2346 606 2347 607 #--------------------------------------------------------------------------- 2348 608 # configuration options related to warning and progress messages 2349 609 #--------------------------------------------------------------------------- 2350 610 2351 611 # The QUIET tag can be used to turn on/off the messages that are generated 2352 612 # by doxygen. Possible values are YES and NO. If left blank NO is used. 2353 613 2354 614 QUIET = NO 2355 615 2356 616 # The WARNINGS tag can be used to turn on/off the warning messages that are 2357 617 # generated by doxygen. Possible values are YES and NO. If left blank 2358 618 # NO is used. 2359 619 2360 620 WARNINGS = YES 2361 621 2362 622 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 2363 623 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 2364 624 # automatically be disabled. 2365 625 2366 626 WARN_IF_UNDOCUMENTED = YES 2367 627 2368 628 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 2369 629 # potential errors in the documentation, such as not documenting some 2370 630 # parameters in a documented function, or documenting parameters that 2371 631 # don't exist or using markup commands wrongly. 2372 632 2373 633 WARN_IF_DOC_ERROR = YES 2374 634 2375 635 # The WARN_NO_PARAMDOC option can be enabled to get warnings for 2376 636 # functions that are documented, but have no documentation for their parameters 2377 637 # or return value. If set to NO (the default) doxygen will only warn about 2378 638 # wrong or incomplete parameter documentation, but not about the absence of 2379 639 # documentation. 2380 640 2381 641 WARN_NO_PARAMDOC = NO 2382 642 2383 643 # The WARN_FORMAT tag determines the format of the warning messages that 2384 644 # doxygen can produce. The string should contain the$file, $line, and$text 2385 645 # tags, which will be replaced by the file and line number from which the 2386 646 # warning originated and the warning text. Optionally the format may contain 2387 647 # $version, which will be replaced by the version of the file (if it could 2388 648 # be obtained via FILE_VERSION_FILTER) 2389 649 2390 650 WARN_FORMAT = "$file:$line:$text" 2391 651 2392 652 # The WARN_LOGFILE tag can be used to specify a file to which warning 2393 653 # and error messages should be written. If left blank the output is written 2394 654 # to stderr. 2395 655 2396 656 WARN_LOGFILE = 2397 657 2398 658 #--------------------------------------------------------------------------- 2399 659 # configuration options related to the input files 2400 660 #--------------------------------------------------------------------------- 2401 661 2402 662 # The INPUT tag can be used to specify the files and/or directories that contain 2403 663 # documented source files. You may enter file names like "myfile.cpp" or 2404 664 # directories like "/usr/src/myproject". Separate the files or directories 2405 665 # with spaces. 2406 666 2407 667 INPUT = @CMAKE_CURRENT_SOURCE_DIR@/doc \ 2408 668 @CMAKE_CURRENT_SOURCE_DIR@/include \ 2409 669 @CMAKE_CURRENT_SOURCE_DIR@/getting_and_using_miral.md \ 2410 670 @CMAKE_CURRENT_SOURCE_DIR@/tasks_for_the_interested_reader.md 2411 671 2412 672 # This tag can be used to specify the character encoding of the source files 2413 673 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 2414 674 # also the default input encoding. Doxygen uses libiconv (or the iconv built 2415 675 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 2416 676 # the list of possible encodings. 2417 677 2418 678 INPUT_ENCODING = UTF-8 2419 679 2420 680 # If the value of the INPUT tag contains directories, you can use the 2421 681 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 2422 682 # and *.h) to filter out the source-files in the directories. If left 2423 683 # blank the following patterns are tested: 2424 684 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 2425 685 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 2426 686 # *.f90 *.f *.for *.vhd *.vhdl 2427 687 2428 688 FILE_PATTERNS = *.c \ 2429 689 *.cc \ 2430 690 *.cxx \ 2431 691 *.cpp \ 2432 692 *.c++ \ 2433 693 *.d \ 2434 694 *.java \ 2435 695 *.ii \ 2436 696 *.ixx \ 2437 697 *.ipp \ 2438 698 *.i++ \ 2439 699 *.inl \ 2440 700 *.h \ 2441 701 *.hh \ 2442 702 *.hxx \ 2443 703 *.hpp \ 2444 704 *.h++ \ 2445 705 *.idl \ 2446 706 *.odl \ 2447 707 *.cs \ 2448 708 *.php \ 2449 709 *.php3 \ 2450 710 *.inc \ 2451 711 *.m \ 2452 712 *.markdown \ 2453 713 *.md \ 2454 714 *.mm \ 2455 715 *.dox \ 2456 716 *.py \ 2457 717 *.f90 \ 2458 718 *.f \ 2459 719 *.for \ 2460 720 *.vhd \ 2461 721 *.vhdl 2462 722 2463 723 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 2464 724 # should be searched for input files as well. Possible values are YES and NO. 2465 725 # If left blank NO is used. 2466 726 2467 727 RECURSIVE = YES 2468 728 2469 729 # The EXCLUDE tag can be used to specify files and/or directories that should be 2470 730 # excluded from the INPUT source files. This way you can easily exclude a 2471 731 # subdirectory from a directory tree whose root is specified with the INPUT tag. 2472 732 # Note that relative paths are relative to the directory from which doxygen is 2473 733 # run. 2474 734 2475 735 EXCLUDE = 2476 736 2477 737 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 2478 738 # directories that are symbolic links (a Unix file system feature) are excluded 2479 739 # from the input. 2480 740 2481 741 EXCLUDE_SYMLINKS = NO 2482 742 2483 743 # If the value of the INPUT tag contains directories, you can use the 2484 744 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 2485 745 # certain files from those directories. Note that the wildcards are matched 2486 746 # against the file with absolute path, so to exclude all test directories 2487 747 # for example use the pattern */test/* 2488 748 2489 749 EXCLUDE_PATTERNS = 2490 750 2491 751 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 2492 752 # (namespaces, classes, functions, etc.) that should be excluded from the 2493 753 # output. The symbol name can be a fully qualified name, a word, or if the 2494 754 # wildcard * is used, a substring. Examples: ANamespace, AClass, 2495 755 # AClass::ANamespace, ANamespace::*Test 2496 756 2497 757 EXCLUDE_SYMBOLS = miral::detail \ 2498 758 mir::* \ 2499 759 mir 2500 760 2501 761 # The EXAMPLE_PATH tag can be used to specify one or more files or 2502 762 # directories that contain example code fragments that are included (see 2503 763 # the \include command). 2504 764 2505 765 EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/miral-shell 2506 766 2507 767 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 2508 768 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 2509 769 # and *.h) to filter out the source-files in the directories. If left 2510 770 # blank all files are included. 2511 771 2512 772 EXAMPLE_PATTERNS = * 2513 773 2514 774 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 2515 775 # searched for input files to be used with the \include or \dontinclude 2516 776 # commands irrespective of the value of the RECURSIVE tag. 2517 777 # Possible values are YES and NO. If left blank NO is used. 2518 778 2519 779 EXAMPLE_RECURSIVE = NO 2520 780 2521 781 # The IMAGE_PATH tag can be used to specify one or more files or 2522 782 # directories that contain image that are included in the documentation (see 2523 783 # the \image command). 2524 784 2525 785 IMAGE_PATH = 2526 786 2527 787 # The INPUT_FILTER tag can be used to specify a program that doxygen should 2528 788 # invoke to filter for each input file. Doxygen will invoke the filter program 2529 789 # by executing (via popen()) the command , where 2530 790 # is the value of the INPUT_FILTER tag, and is the name of an 2531 791 # input file. Doxygen will then use the output that the filter program writes 2532 792 # to standard output. 2533 793 # If FILTER_PATTERNS is specified, this tag will be ignored. 2534 794 # Note that the filter must not add or remove lines; it is applied before the 2535 795 # code is scanned, but not when the output code is generated. If lines are added 2536 796 # or removed, the anchors will not be placed correctly. 2537 797 2538 798 INPUT_FILTER = 2539 799 2540 800 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 2541 801 # basis. 2542 802 # Doxygen will compare the file name with each pattern and apply the 2543 803 # filter if there is a match. 2544 804 # The filters are a list of the form: 2545 805 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 2546 806 # info on how filters are used. If FILTER_PATTERNS is empty or if 2547 807 # non of the patterns match the file name, INPUT_FILTER is applied. 2548 808 2549 809 FILTER_PATTERNS = 2550 810 2551 811 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 2552 812 # INPUT_FILTER) will be used to filter the input files when producing source 2553 813 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 2554 814 2555 815 FILTER_SOURCE_FILES = NO 2556 816 2557 817 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 2558 818 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) 2559 819 # and it is also possible to disable source filtering for a specific pattern 2560 820 # using *.ext= (so without naming a filter). This option only has effect when 2561 821 # FILTER_SOURCE_FILES is enabled. 2562 822 2563 823 FILTER_SOURCE_PATTERNS = 2564 824 2565 825 # If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that 2566 826 # is part of the input, its contents will be placed on the main page 2567 827 # (index.html). This can be useful if you have a project on for instance GitHub 2568 828 # and want reuse the introduction page also for the doxygen output. 2569 829 2570 830 USE_MDFILE_AS_MAINPAGE = 2571 831 2572 832 #--------------------------------------------------------------------------- 2573 833 # configuration options related to source browsing 2574 834 #--------------------------------------------------------------------------- 2575 835 2576 836 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 2577 837 # be generated. Documented entities will be cross-referenced with these sources. 2578 838 # Note: To get rid of all source code in the generated output, make sure also 2579 839 # VERBATIM_HEADERS is set to NO. 2580 840 2581 841 SOURCE_BROWSER = NO 2582 842 2583 843 # Setting the INLINE_SOURCES tag to YES will include the body 2584 844 # of functions and classes directly in the documentation. 2585 845 2586 846 INLINE_SOURCES = NO 2587 847 2588 848 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 2589 849 # doxygen to hide any special comment blocks from generated source code 2590 850 # fragments. Normal C, C++ and Fortran comments will always remain visible. 2591 851 2592 852 STRIP_CODE_COMMENTS = YES 2593 853 2594 854 # If the REFERENCED_BY_RELATION tag is set to YES 2595 855 # then for each documented function all documented 2596 856 # functions referencing it will be listed. 2597 857 2598 858 REFERENCED_BY_RELATION = NO 2599 859 2600 860 # If the REFERENCES_RELATION tag is set to YES 2601 861 # then for each documented function all documented entities 2602 862 # called/used by that function will be listed. 2603 863 2604 864 REFERENCES_RELATION = NO 2605 865 2606 866 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 2607 867 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 2608 868 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 2609 869 # link to the source code. 2610 870 # Otherwise they will link to the documentation. 2611 871 2612 872 REFERENCES_LINK_SOURCE = YES 2613 873 2614 874 # If the USE_HTAGS tag is set to YES then the references to source code 2615 875 # will point to the HTML generated by the htags(1) tool instead of doxygen 2616 876 # built-in source browser. The htags tool is part of GNU's global source 2617 877 # tagging system (see http://www.gnu.org/software/global/global.html). You 2618 878 # will need version 4.8.6 or higher. 2619 879 2620 880 USE_HTAGS = NO 2621 881 2622 882 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 2623 883 # will generate a verbatim copy of the header file for each class for 2624 884 # which an include is specified. Set to NO to disable this. 2625 885 2626 886 VERBATIM_HEADERS = YES 2627 887 2628 888 #--------------------------------------------------------------------------- 2629 889 # configuration options related to the alphabetical class index 2630 890 #--------------------------------------------------------------------------- 2631 891 2632 892 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 2633 893 # of all compounds will be generated. Enable this if the project 2634 894 # contains a lot of classes, structs, unions or interfaces. 2635 895 2636 896 ALPHABETICAL_INDEX = YES 2637 897 2638 898 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 2639 899 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 2640 900 # in which this list will be split (can be a number in the range [1..20]) 2641 901 2642 902 COLS_IN_ALPHA_INDEX = 5 2643 903 2644 904 # In case all classes in a project start with a common prefix, all 2645 905 # classes will be put under the same header in the alphabetical index. 2646 906 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 2647 907 # should be ignored while generating the index headers. 2648 908 2649 909 IGNORE_PREFIX = 2650 910 2651 911 #--------------------------------------------------------------------------- 2652 912 # configuration options related to the HTML output 2653 913 #--------------------------------------------------------------------------- 2654 914 2655 915 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 2656 916 # generate HTML output. 2657 917 2658 918 GENERATE_HTML = YES 2659 919 2660 920 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 2661 921 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 2662 922 # put in front of it. If left blank html' will be used as the default path. 2663 923 2664 924 HTML_OUTPUT = html 2665 925 2666 926 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 2667 927 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 2668 928 # doxygen will generate files with .html extension. 2669 929 2670 930 HTML_FILE_EXTENSION = .html 2671 931 2672 932 # The HTML_HEADER tag can be used to specify a personal HTML header for 2673 933 # each generated HTML page. If it is left blank doxygen will generate a 2674 934 # standard header. Note that when using a custom header you are responsible 2675 935 # for the proper inclusion of any scripts and style sheets that doxygen 2676 936 # needs, which is dependent on the configuration options used. 2677 937 # It is advised to generate a default header using "doxygen -w html 2678 938 # header.html footer.html stylesheet.css YourConfigFile" and then modify 2679 939 # that header. Note that the header is subject to change so you typically 2680 940 # have to redo this when upgrading to a newer version of doxygen or when 2681 941 # changing the value of configuration settings such as GENERATE_TREEVIEW! 2682 942 2683 943 HTML_HEADER = 2684 944 2685 945 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 2686 946 # each generated HTML page. If it is left blank doxygen will generate a 2687 947 # standard footer. 2688 948 2689 949 HTML_FOOTER = @CMAKE_BINARY_DIR@/doc/footer.html 2690 950 2691 951 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 2692 952 # style sheet that is used by each HTML page. It can be used to 2693 953 # fine-tune the look of the HTML output. If left blank doxygen will 2694 954 # generate a default style sheet. Note that it is recommended to use 2695 955 # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 2696 956 # tag will in the future become obsolete. 2697 957 2698 958 HTML_STYLESHEET = 2699 959 2700 960 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 2701 961 # user-defined cascading style sheet that is included after the standard 2702 962 # style sheets created by doxygen. Using this option one can overrule 2703 963 # certain style aspects. This is preferred over using HTML_STYLESHEET 2704 964 # since it does not replace the standard style sheet and is therefor more 2705 965 # robust against future updates. Doxygen will copy the style sheet file to 2706 966 # the output directory. 2707 967 2708 968 HTML_EXTRA_STYLESHEET = @CMAKE_BINARY_DIR@/doc/extra.css 2709 969 2710 970 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 2711 971 # other source files which should be copied to the HTML output directory. Note 2712 972 # that these files will be copied to the base HTML output directory. Use the 2713 973 # \$relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 2714 974 # files. In the HTML_STYLESHEET file, use the file name only. Also note that 2715 975 # the files will be copied as-is; there are no commands or markers available. 2716 976 2717 977 HTML_EXTRA_FILES = 2718 978 2719 979 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 2720 980 # Doxygen will adjust the colors in the style sheet and background images 2721 981 # according to this color. Hue is specified as an angle on a colorwheel, 2722 982 # see http://en.wikipedia.org/wiki/Hue for more information. 2723 983 # For instance the value 0 represents red, 60 is yellow, 120 is green, 2724 984 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 2725 985 # The allowed range is 0 to 359. 2726 986 2727 987 HTML_COLORSTYLE_HUE = 16 2728 988 2729 989 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 2730 990 # the colors in the HTML output. For a value of 0 the output will use 2731 991 # grayscales only. A value of 255 will produce the most vivid colors. 2732 992 2733 993 HTML_COLORSTYLE_SAT = 240 2734 994 2735 995 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 2736 996 # the luminance component of the colors in the HTML output. Values below 2737 997 # 100 gradually make the output lighter, whereas values above 100 make 2738 998 # the output darker. The value divided by 100 is the actual gamma applied, 2739 999 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 2740 1000 # and 100 does not change the gamma. 2741 1001 2742 1002 HTML_COLORSTYLE_GAMMA = 80 2743 1003 2744 1004 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 2745 1005 # page will contain the date and time when the page was generated. Setting 2746 1006 # this to NO can help when comparing the output of multiple runs. 2747 1007 2748 1008 HTML_TIMESTAMP = YES 2749 1009 2750 1010 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 2751 1011 # documentation will contain sections that can be hidden and shown after the 2752 1012 # page has loaded. 2753 1013 2754 1014 HTML_DYNAMIC_SECTIONS = NO 2755 1015 2756 1016 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 2757 1017 # entries shown in the various tree structured indices initially; the user 2758 1018 # can expand and collapse entries dynamically later on. Doxygen will expand 2759 1019 # the tree to such a level that at most the specified number of entries are 2760 1020 # visible (unless a fully collapsed tree already exceeds this amount). 2761 1021 # So setting the number of entries 1 will produce a full collapsed tree by 2762 1022 # default. 0 is a special value representing an infinite number of entries 2763 1023 # and will result in a full expanded tree by default. 2764 1024 2765 1025 HTML_INDEX_NUM_ENTRIES = 100 2766 1026 2767 1027 # If the GENERATE_DOCSET tag is set to YES, additional index files 2768 1028 # will be generated that can be used as input for Apple's Xcode 3 2769 1029 # integrated development environment, introduced with OSX 10.5 (Leopard). 2770 1030 # To create a documentation set, doxygen will generate a Makefile in the 2771 1031 # HTML output directory. Running make will produce the docset in that 2772 1032 # directory and running "make install" will install the docset in 2773 1033 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 2774 1034 # it at startup. 2775 1035 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 2776 1036 # for more information. 2777 1037 2778 1038 GENERATE_DOCSET = NO 2779 1039 2780 1040 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 2781 1041 # feed. A documentation feed provides an umbrella under which multiple 2782 1042 # documentation sets from a single provider (such as a company or product suite) 2783 1043 # can be grouped. 2784 1044 2785 1045 DOCSET_FEEDNAME = "Doxygen generated docs" 2786 1046 2787 1047 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 2788 1048 # should uniquely identify the documentation set bundle. This should be a 2789 1049 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 2790 1050 # will append .docset to the name. 2791 1051 2792 1052 DOCSET_BUNDLE_ID = org.doxygen.Project 2793 1053 2794 1054 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely 2795 1055 # identify the documentation publisher. This should be a reverse domain-name 2796 1056 # style string, e.g. com.mycompany.MyDocSet.documentation. 2797 1057 2798 1058 DOCSET_PUBLISHER_ID = org.doxygen.Publisher 2799 1059 2800 1060 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 2801 1061 2802 1062 DOCSET_PUBLISHER_NAME = Publisher 2803 1063 2804 1064 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 2805 1065 # will be generated that can be used as input for tools like the 2806 1066 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 2807 1067 # of the generated HTML documentation. 2808 1068 2809 1069 GENERATE_HTMLHELP = NO 2810 1070 2811 1071 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 2812 1072 # be used to specify the file name of the resulting .chm file. You 2813 1073 # can add a path in front of the file if the result should not be 2814 1074 # written to the html output directory. 2815 1075 2816 1076 CHM_FILE = 2817 1077 2818 1078 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 2819 1079 # be used to specify the location (absolute path including file name) of 2820 1080 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 2821 1081 # the HTML help compiler on the generated index.hhp. 2822 1082 2823 1083 HHC_LOCATION = 2824 1084 2825 1085 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 2826 1086 # controls if a separate .chi index file is generated (YES) or that 2827 1087 # it should be included in the master .chm file (NO). 2828 1088 2829 1089 GENERATE_CHI = NO 2830 1090 2831 1091 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 2832 1092 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 2833 1093 # content. 2834 1094 2835 1095 CHM_INDEX_ENCODING = 2836 1096 2837 1097 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 2838 1098 # controls whether a binary table of contents is generated (YES) or a 2839 1099 # normal table of contents (NO) in the .chm file. 2840 1100 2841 1101 BINARY_TOC = NO 2842 1102 2843 1103 # The TOC_EXPAND flag can be set to YES to add extra items for group members 2844 1104 # to the contents of the HTML help documentation and to the tree view. 2845 1105 2846 1106 TOC_EXPAND = NO 2847 1107 2848 1108 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 2849 1109 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 2850 1110 # that can be used as input for Qt's qhelpgenerator to generate a 2851 1111 # Qt Compressed Help (.qch) of the generated HTML documentation. 2852 1112 2853 1113 GENERATE_QHP = NO 2854 1114 2855 1115 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 2856 1116 # be used to specify the file name of the resulting .qch file. 2857 1117 # The path specified is relative to the HTML output folder. 2858 1118 2859 1119 QCH_FILE = 2860 1120 2861 1121 # The QHP_NAMESPACE tag specifies the namespace to use when generating 2862 1122 # Qt Help Project output. For more information please see 2863 1123 # http://doc.trolltech.com/qthelpproject.html#namespace 2864 1124 2865 1125 QHP_NAMESPACE = org.doxygen.Project 2866 1126 2867 1127 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 2868 1128 # Qt Help Project output. For more information please see 2869 1129 # http://doc.trolltech.com/qthelpproject.html#virtual-folders 2870 1130 2871 1131 QHP_VIRTUAL_FOLDER = doc 2872 1132 2873 1133 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 2874 1134 # add. For more information please see 2875 1135 # http://doc.trolltech.com/qthelpproject.html#custom-filters 2876 1136 2877 1137 QHP_CUST_FILTER_NAME = 2878 1138 2879 1139 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 2880 1140 # custom filter to add. For more information please see 2881 1141 # 2882 1142 # Qt Help Project / Custom Filters. 2883 1143 2884 1144 QHP_CUST_FILTER_ATTRS = 2885 1145 2886 1146 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 2887 1147 # project's 2888 1148 # filter section matches. 2889 1149 # 2890 1150 # Qt Help Project / Filter Attributes. 2891 1151 2892 1152 QHP_SECT_FILTER_ATTRS = 2893 1153 2894 1154 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 2895 1155 # be used to specify the location of Qt's qhelpgenerator. 2896 1156 # If non-empty doxygen will try to run qhelpgenerator on the generated 2897 1157 # .qhp file. 2898 1158 2899 1159 QHG_LOCATION = 2900 1160 2901 1161 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 2902 1162 # will be generated, which together with the HTML files, form an Eclipse help 2903 1163 # plugin. To install this plugin and make it available under the help contents 2904 1164 # menu in Eclipse, the contents of the directory containing the HTML and XML 2905 1165 # files needs to be copied into the plugins directory of eclipse. The name of 2906 1166 # the directory within the plugins directory should be the same as 2907 1167 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 2908 1168 # the help appears. 2909 1169 2910 1170 GENERATE_ECLIPSEHELP = NO 2911 1171 2912 1172 # A unique identifier for the eclipse help plugin. When installing the plugin 2913 1173 # the directory name containing the HTML and XML files should also have 2914 1174 # this name. 2915 1175 2916 1176 ECLIPSE_DOC_ID = org.doxygen.Project 2917 1177 2918 1178 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 2919 1179 # at top of each HTML page. The value NO (the default) enables the index and 2920 1180 # the value YES disables it. Since the tabs have the same information as the 2921 1181 # navigation tree you can set this option to NO if you already set 2922 1182 # GENERATE_TREEVIEW to YES. 2923 1183 2924 1184 DISABLE_INDEX = NO 2925 1185 2926 1186 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 2927 1187 # structure should be generated to display hierarchical information. 2928 1188 # If the tag value is set to YES, a side panel will be generated 2929 1189 # containing a tree-like index structure (just like the one that 2930 1190 # is generated for HTML Help). For this to work a browser that supports 2931 1191 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 2932 1192 # Windows users are probably better off using the HTML help feature. 2933 1193 # Since the tree basically has the same information as the tab index you 2934 1194 # could consider to set DISABLE_INDEX to NO when enabling this option. 2935 1195 2936 1196 GENERATE_TREEVIEW = NO 2937 1197 2938 1198 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 2939 1199 # (range [0,1..20]) that doxygen will group on one line in the generated HTML 2940 1200 # documentation. Note that a value of 0 will completely suppress the enum 2941 1201 # values from appearing in the overview section. 2942 1202 2943 1203 ENUM_VALUES_PER_LINE = 4 2944 1204 2945 1205 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 2946 1206 # used to set the initial width (in pixels) of the frame in which the tree 2947 1207 # is shown. 2948 1208 2949 1209 TREEVIEW_WIDTH = 250 2950 1210 2951 1211 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 2952 1212 # links to external symbols imported via tag files in a separate window. 2953 1213 2954 1214 EXT_LINKS_IN_WINDOW = NO 2955 1215 2956 1216 # Use this tag to change the font size of Latex formulas included 2957 1217 # as images in the HTML documentation. The default is 10. Note that 2958 1218 # when you change the font size after a successful doxygen run you need 2959 1219 # to manually remove any form_*.png images from the HTML output directory 2960 1220 # to force them to be regenerated. 2961 1221 2962 1222 FORMULA_FONTSIZE = 10 2963 1223 2964 1224 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 2965 1225 # generated for formulas are transparent PNGs. Transparent PNGs are 2966 1226 # not supported properly for IE 6.0, but are supported on all modern browsers. 2967 1227 # Note that when changing this option you need to delete any form_*.png files 2968 1228 # in the HTML output before the changes have effect. 2969 1229 2970 1230 FORMULA_TRANSPARENT = YES 2971 1231 2972 1232 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 2973 1233 # (see http://www.mathjax.org) which uses client side Javascript for the 2974 1234 # rendering instead of using prerendered bitmaps. Use this if you do not 2975 1235 # have LaTeX installed or if you want to formulas look prettier in the HTML 2976 1236 # output. When enabled you may also need to install MathJax separately and 2977 1237 # configure the path to it using the MATHJAX_RELPATH option. 2978 1238 2979 1239 USE_MATHJAX = NO 2980 1240 2981 1241 # When MathJax is enabled you can set the default output format to be used for 2982 1242 # the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and 2983 1243 # SVG. The default value is HTML-CSS, which is slower, but has the best 2984 1244 # compatibility. 2985 1245 2986 1246 MATHJAX_FORMAT = HTML-CSS 2987 1247 2988 1248 # When MathJax is enabled you need to specify the location relative to the 2989 1249 # HTML output directory using the MATHJAX_RELPATH option. The destination 2990 1250 # directory should contain the MathJax.js script. For instance, if the mathjax 2991 1251 # directory is located at the same level as the HTML output directory, then 2992 1252 # MATHJAX_RELPATH should be ../mathjax. The default value points to 2993 1253 # the MathJax Content Delivery Network so you can quickly see the result without 2994 1254 # installing MathJax. 2995 1255 # However, it is strongly recommended to install a local 2996 1256 # copy of MathJax from http://www.mathjax.org before deployment. 2997 1257 2998 1258 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 2999 1259 3000 1260 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 3001 1261 # names that should be enabled during MathJax rendering. 3002 1262 3003 1263 MATHJAX_EXTENSIONS = 3004 1264 3005 1265 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript 3006 1266 # pieces of code that will be used on startup of the MathJax code. 3007 1267 3008 1268 MATHJAX_CODEFILE = 3009 1269 3010 1270 # When the SEARCHENGINE tag is enabled doxygen will generate a search box 3011 1271 # for the HTML output. The underlying search engine uses javascript 3012 1272 # and DHTML and should work on any modern browser. Note that when using 3013 1273 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 3014 1274 # (GENERATE_DOCSET) there is already a search function so this one should 3015 1275 # typically be disabled. For large projects the javascript based search engine 3016 1276 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 3017 1277 3018 1278 SEARCHENGINE = YES 3019 1279 3020 1280 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 3021 1281 # implemented using a web server instead of a web client using Javascript. 3022 1282 # There are two flavours of web server based search depending on the 3023 1283 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for 3024 1284 # searching and an index file used by the script. When EXTERNAL_SEARCH is 3025 1285 # enabled the indexing and searching needs to be provided by external tools. 3026 1286 # See the manual for details. 3027 1287 3028 1288 SERVER_BASED_SEARCH = NO 3029 1289 3030 1290 # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP 3031 1291 # script for searching. Instead the search results are written to an XML file 3032 1292 # which needs to be processed by an external indexer. Doxygen will invoke an 3033 1293 # external search engine pointed to by the SEARCHENGINE_URL option to obtain 3034 1294 # the search results. Doxygen ships with an example indexer (doxyindexer) and 3035 1295 # search engine (doxysearch.cgi) which are based on the open source search 3036 1296 # engine library Xapian. See the manual for configuration details. 3037 1297 3038 1298 EXTERNAL_SEARCH = NO 3039 1299 3040 1300 # The SEARCHENGINE_URL should point to a search engine hosted by a web server 3041 1301 # which will returned the search results when EXTERNAL_SEARCH is enabled. 3042 1302 # Doxygen ships with an example search engine (doxysearch) which is based on 3043 1303 # the open source search engine library Xapian. See the manual for configuration 3044 1304 # details. 3045 1305 3046 1306 SEARCHENGINE_URL = 3047 1307 3048 1308 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 3049 1309 # search data is written to a file for indexing by an external tool. With the 3050 1310 # SEARCHDATA_FILE tag the name of this file can be specified. 3051 1311 3052 1312 SEARCHDATA_FILE = searchdata.xml 3053 1313 3054 1314 # When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the 3055 1315 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 3056 1316 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 3057 1317 # projects and redirect the results back to the right project. 3058 1318 3059 1319 EXTERNAL_SEARCH_ID = 3060 1320 3061 1321 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 3062 1322 # projects other than the one defined by this configuration file, but that are 3063 1323 # all added to the same external search index. Each project needs to have a 3064 1324 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id 3065 1325 # of to a relative location where the documentation can be found. 3066 1326 # The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... 3067 1327 3068 1328 EXTRA_SEARCH_MAPPINGS = 3069 1329 3070 1330 #--------------------------------------------------------------------------- 3071 1331 # configuration options related to the LaTeX output 3072 1332 #--------------------------------------------------------------------------- 3073 1333 3074 1334 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 3075 1335 # generate Latex output. 3076 1336 3077 1337 GENERATE_LATEX = NO 3078 1338 3079 1339 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 3080 1340 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 3081 1341 # put in front of it. If left blank latex' will be used as the default path. 3082 1342 3083 1343 LATEX_OUTPUT = latex 3084 1344 3085 1345 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 3086 1346 # invoked. If left blank latex' will be used as the default command name. 3087 1347 # Note that when enabling USE_PDFLATEX this option is only used for 3088 1348 # generating bitmaps for formulas in the HTML output, but not in the 3089 1349 # Makefile that is written to the output directory. 3090 1350 3091 1351 LATEX_CMD_NAME = latex 3092 1352 3093 1353 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 3094 1354 # generate index for LaTeX. If left blank makeindex' will be used as the 3095 1355 # default command name. 3096 1356 3097 1357 MAKEINDEX_CMD_NAME = makeindex 3098 1358 3099 1359 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 3100 1360 # LaTeX documents. This may be useful for small projects and may help to 3101 1361 # save some trees in general. 3102 1362 3103 1363 COMPACT_LATEX = NO 3104 1364 3105 1365 # The PAPER_TYPE tag can be used to set the paper type that is used 3106 1366 # by the printer. Possible values are: a4, letter, legal and 3107 1367 # executive. If left blank a4 will be used. 3108 1368 3109 1369 PAPER_TYPE = a4 3110 1370 3111 1371 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 3112 1372 # packages that should be included in the LaTeX output. 3113 1373 3114 1374 EXTRA_PACKAGES = 3115 1375 3116 1376 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 3117 1377 # the generated latex document. The header should contain everything until 3118 1378 # the first chapter. If it is left blank doxygen will generate a 3119 1379 # standard header. Notice: only use this tag if you know what you are doing! 3120 1380 3121 1381 LATEX_HEADER = 3122 1382 3123 1383 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 3124 1384 # the generated latex document. The footer should contain everything after 3125 1385 # the last chapter. If it is left blank doxygen will generate a 3126 1386 # standard footer. Notice: only use this tag if you know what you are doing! 3127 1387 3128 1388 LATEX_FOOTER = 3129 1389 3130 1390 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images 3131 1391 # or other source files which should be copied to the LaTeX output directory. 3132 1392 # Note that the files will be copied as-is; there are no commands or markers 3133 1393 # available. 3134 1394 3135 1395 LATEX_EXTRA_FILES = 3136 1396 3137 1397 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 3138 1398 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 3139 1399 # contain links (just like the HTML output) instead of page references 3140 1400 # This makes the output suitable for online browsing using a pdf viewer. 3141 1401 3142 1402 PDF_HYPERLINKS = YES 3143 1403 3144 1404 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 3145 1405 # plain latex in the generated Makefile. Set this option to YES to get a 3146 1406 # higher quality PDF documentation. 3147 1407 3148 1408 USE_PDFLATEX = YES 3149 1409 3150 1410 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 3151 1411 # command to the generated LaTeX files. This will instruct LaTeX to keep 3152 1412 # running if errors occur, instead of asking the user for help. 3153 1413 # This option is also used when generating formulas in HTML. 3154 1414 3155 1415 LATEX_BATCHMODE = NO 3156 1416 3157 1417 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 3158 1418 # include the index chapters (such as File Index, Compound Index, etc.) 3159 1419 # in the output. 3160 1420 3161 1421 LATEX_HIDE_INDICES = NO 3162 1422 3163 1423 # If LATEX_SOURCE_CODE is set to YES then doxygen will include 3164 1424 # source code with syntax highlighting in the LaTeX output. 3165 1425 # Note that which sources are shown also depends on other settings 3166 1426 # such as SOURCE_BROWSER. 3167 1427 3168 1428 LATEX_SOURCE_CODE = NO 3169 1429 3170 1430 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 3171 1431 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 3172 1432 # http://en.wikipedia.org/wiki/BibTeX for more info. 3173 1433 3174 1434 LATEX_BIB_STYLE = plain 3175 1435 3176 1436 #--------------------------------------------------------------------------- 3177 1437 # configuration options related to the RTF output 3178 1438 #--------------------------------------------------------------------------- 3179 1439 3180 1440 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 3181 1441 # The RTF output is optimized for Word 97 and may not look very pretty with 3182 1442 # other RTF readers or editors. 3183 1443 3184 1444 GENERATE_RTF = NO 3185 1445 3186 1446 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 3187 1447 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 3188 1448 # put in front of it. If left blank rtf' will be used as the default path. 3189 1449 3190 1450 RTF_OUTPUT = rtf 3191 1451 3192 1452 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 3193 1453 # RTF documents. This may be useful for small projects and may help to 3194 1454 # save some trees in general. 3195 1455 3196 1456 COMPACT_RTF = NO 3197 1457 3198 1458 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 3199 1459 # will contain hyperlink fields. The RTF file will 3200 1460 # contain links (just like the HTML output) instead of page references. 3201 1461 # This makes the output suitable for online browsing using WORD or other 3202 1462 # programs which support those fields. 3203 1463 # Note: wordpad (write) and others do not support links. 3204 1464 3205 1465 RTF_HYPERLINKS = NO 3206 1466 3207 1467 # Load style sheet definitions from file. Syntax is similar to doxygen's 3208 1468 # config file, i.e. a series of assignments. You only have to provide 3209 1469 # replacements, missing definitions are set to their default value. 3210 1470 3211 1471 RTF_STYLESHEET_FILE = 3212 1472 3213 1473 # Set optional variables used in the generation of an rtf document. 3214 1474 # Syntax is similar to doxygen's config file. 3215 1475 3216 1476 RTF_EXTENSIONS_FILE = 3217 1477 3218 1478 #--------------------------------------------------------------------------- 3219 1479 # configuration options related to the man page output 3220 1480 #--------------------------------------------------------------------------- 3221 1481 3222 1482 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 3223 1483 # generate man pages 3224 1484 3225 1485 GENERATE_MAN = NO 3226 1486 3227 1487 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 3228 1488 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 3229 1489 # put in front of it. If left blank man' will be used as the default path. 3230 1490 3231 1491 MAN_OUTPUT = man 3232 1492 3233 1493 # The MAN_EXTENSION tag determines the extension that is added to 3234 1494 # the generated man pages (default is the subroutine's section .3) 3235 1495 3236 1496 MAN_EXTENSION = .3 3237 1497 3238 1498 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 3239 1499 # then it will generate one additional man file for each entity 3240 1500 # documented in the real man page(s). These additional files 3241 1501 # only source the real man page, but without them the man command 3242 1502 # would be unable to find the correct page. The default is NO. 3243 1503 3244 1504 MAN_LINKS = NO 3245 1505 3246 1506 #--------------------------------------------------------------------------- 3247 1507 # configuration options related to the XML output 3248 1508 #--------------------------------------------------------------------------- 3249 1509 3250 1510 # If the GENERATE_XML tag is set to YES Doxygen will 3251 1511 # generate an XML file that captures the structure of 3252 1512 # the code including all documentation. 3253 1513 3254 1514 GENERATE_XML = YES 3255 1515 3256 1516 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 3257 1517 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 3258 1518 # put in front of it. If left blank xml' will be used as the default path. 3259 1519 3260 1520 XML_OUTPUT = xml 3261 1521 3262 1522 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 3263 1523 # dump the program listings (including syntax highlighting 3264 1524 # and cross-referencing information) to the XML output. Note that 3265 1525 # enabling this will significantly increase the size of the XML output. 3266 1526 3267 1527 XML_PROGRAMLISTING = YES 3268 1528 3269 1529 #--------------------------------------------------------------------------- 3270 1530 # configuration options related to the DOCBOOK output 3271 1531 #--------------------------------------------------------------------------- 3272 1532 3273 1533 # If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files 3274 1534 # that can be used to generate PDF. 3275 1535 3276 1536 GENERATE_DOCBOOK = NO 3277 1537 3278 1538 # The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put. 3279 1539 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 3280 1540 # front of it. If left blank docbook will be used as the default path. 3281 1541 3282 1542 DOCBOOK_OUTPUT = docbook 3283 1543 3284 1544 #--------------------------------------------------------------------------- 3285 1545 # configuration options for the AutoGen Definitions output 3286 1546 #--------------------------------------------------------------------------- 3287 1547 3288 1548 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 3289 1549 # generate an AutoGen Definitions (see autogen.sf.net) file 3290 1550 # that captures the structure of the code including all 3291 1551 # documentation. Note that this feature is still experimental 3292 1552 # and incomplete at the moment. 3293 1553 3294 1554 GENERATE_AUTOGEN_DEF = NO 3295 1555 3296 1556 #--------------------------------------------------------------------------- 3297 1557 # configuration options related to the Perl module output 3298 1558 #--------------------------------------------------------------------------- 3299 1559 3300 1560 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 3301 1561 # generate a Perl module file that captures the structure of 3302 1562 # the code including all documentation. Note that this 3303 1563 # feature is still experimental and incomplete at the 3304 1564 # moment. 3305 1565 3306 1566 GENERATE_PERLMOD = NO 3307 1567 3308 1568 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 3309 1569 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 3310 1570 # to generate PDF and DVI output from the Perl module output. 3311 1571 3312 1572 PERLMOD_LATEX = NO 3313 1573 3314 1574 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 3315 1575 # nicely formatted so it can be parsed by a human reader. 3316 1576 # This is useful 3317 1577 # if you want to understand what is going on. 3318 1578 # On the other hand, if this 3319 1579 # tag is set to NO the size of the Perl module output will be much smaller 3320 1580 # and Perl will parse it just the same. 3321 1581 3322 1582 PERLMOD_PRETTY = YES 3323 1583 3324 1584 # The names of the make variables in the generated doxyrules.make file 3325 1585 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 3326 1586 # This is useful so different doxyrules.make files included by the same 3327 1587 # Makefile don't overwrite each other's variables. 3328 1588 3329 1589 PERLMOD_MAKEVAR_PREFIX = 3330 1590 3331 1591 #--------------------------------------------------------------------------- 3332 1592 # Configuration options related to the preprocessor 3333 1593 #--------------------------------------------------------------------------- 3334 1594 3335 1595 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 3336 1596 # evaluate all C-preprocessor directives found in the sources and include 3337 1597 # files. 3338 1598 3339 1599 ENABLE_PREPROCESSING = YES 3340 1600 3341 1601 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 3342 1602 # names in the source code. If set to NO (the default) only conditional 3343 1603 # compilation will be performed. Macro expansion can be done in a controlled 3344 1604 # way by setting EXPAND_ONLY_PREDEF to YES. 3345 1605 3346 1606 MACRO_EXPANSION = NO 3347 1607 3348 1608 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 3349 1609 # then the macro expansion is limited to the macros specified with the 3350 1610 # PREDEFINED and EXPAND_AS_DEFINED tags. 3351 1611 3352 1612 EXPAND_ONLY_PREDEF = NO 3353 1613 3354 1614 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 3355 1615 # pointed to by INCLUDE_PATH will be searched when a #include is found. 3356 1616 3357 1617 SEARCH_INCLUDES = YES 3358 1618 3359 1619 # The INCLUDE_PATH tag can be used to specify one or more directories that 3360 1620 # contain include files that are not input files but should be processed by 3361 1621 # the preprocessor. 3362 1622 3363 1623 INCLUDE_PATH = 3364 1624 3365 1625 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 3366 1626 # patterns (like *.h and *.hpp) to filter out the header-files in the 3367 1627 # directories. If left blank, the patterns specified with FILE_PATTERNS will 3368 1628 # be used. 3369 1629 3370 1630 INCLUDE_FILE_PATTERNS = 3371 1631 3372 1632 # The PREDEFINED tag can be used to specify one or more macro names that 3373 1633 # are defined before the preprocessor is started (similar to the -D option of 3374 1634 # gcc). The argument of the tag is a list of macros of the form: name 3375 1635 # or name=definition (no spaces). If the definition and the = are 3376 1636 # omitted =1 is assumed. To prevent a macro definition from being 3377 1637 # undefined via #undef or recursively expanded use the := operator 3378 1638 # instead of the = operator. 3379 1639 3380 1640 PREDEFINED = __cplusplus 3381 1641 3382 1642 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 3383 1643 # this tag can be used to specify a list of macro names that should be expanded. 3384 1644 # The macro definition that is found in the sources will be used. 3385 1645 # Use the PREDEFINED tag if you want to use a different macro definition that 3386 1646 # overrules the definition found in the source code. 3387 1647 3388 1648 EXPAND_AS_DEFINED = 3389 1649 3390 1650 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 3391 1651 # doxygen's preprocessor will remove all references to function-like macros 3392 1652 # that are alone on a line, have an all uppercase name, and do not end with a 3393 1653 # semicolon, because these will confuse the parser if not removed. 3394 1654 3395 1655 SKIP_FUNCTION_MACROS = YES 3396 1656 3397 1657 #--------------------------------------------------------------------------- 3398 1658 # Configuration::additions related to external references 3399 1659 #--------------------------------------------------------------------------- 3400 1660 3401 1661 # The TAGFILES option can be used to specify one or more tagfiles. For each 3402 1662 # tag file the location of the external documentation should be added. The 3403 1663 # format of a tag file without this location is as follows: 3404 1664 # 3405 1665 # TAGFILES = file1 file2 ... 3406 1666 # Adding location for the tag files is done as follows: 3407 1667 # 3408 1668 # TAGFILES = file1=loc1 "file2 = loc2" ... 3409 1669 # where "loc1" and "loc2" can be relative or absolute paths 3410 1670 # or URLs. Note that each tag file must have a unique name (where the name does 3411 1671 # NOT include the path). If a tag file is not located in the directory in which 3412 1672 # doxygen is run, you must also specify the path to the tagfile here. 3413 1673 3414 1674 TAGFILES = 3415 1675 3416 1676 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 3417 1677 # a tag file that is based on the input files it reads. 3418 1678 3419 1679 GENERATE_TAGFILE = 3420 1680 3421 1681 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 3422 1682 # in the class index. If set to NO only the inherited external classes 3423 1683 # will be listed. 3424 1684 3425 1685 ALLEXTERNALS = NO 3426 1686 3427 1687 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 3428 1688 # in the modules index. If set to NO, only the current project's groups will 3429 1689 # be listed. 3430 1690 3431 1691 EXTERNAL_GROUPS = YES 3432 1692 3433 1693 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed 3434 1694 # in the related pages index. If set to NO, only the current project's 3435 1695 # pages will be listed. 3436 1696 3437 1697 EXTERNAL_PAGES = YES 3438 1698 3439 1699 # The PERL_PATH should be the absolute path and name of the perl script 3440 1700 # interpreter (i.e. the result of `which perl'). 3441 1701 3442 1702 PERL_PATH = /usr/bin/perl 3443 1703 3444 1704 #--------------------------------------------------------------------------- 3445 1705 # Configuration options related to the dot tool 3446 1706 #--------------------------------------------------------------------------- 3447 1707 3448 1708 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 3449 1709 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 3450 1710 # or super classes. Setting the tag to NO turns the diagrams off. Note that 3451 1711 # this option also works with HAVE_DOT disabled, but it is recommended to 3452 1712 # install and use dot, since it yields more powerful graphs. 3453 1713 3454 1714 CLASS_DIAGRAMS = YES 3455 1715 3456 1716 # You can define message sequence charts within doxygen comments using the \msc 3457 1717 # command. Doxygen will then run the mscgen tool (see 3458 1718 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 3459 1719 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 3460 1720 # the mscgen tool resides. If left empty the tool is assumed to be found in the 3461 1721 # default search path. 3462 1722 3463 1723 MSCGEN_PATH = 3464 1724 3465 1725 # If set to YES, the inheritance and collaboration graphs will hide 3466 1726 # inheritance and usage relations if the target is undocumented 3467 1727 # or is not a class. 3468 1728 3469 1729 HIDE_UNDOC_RELATIONS = YES 3470 1730 3471 1731 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 3472 1732 # available from the path. This tool is part of Graphviz, a graph visualization 3473 1733 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 3474 1734 # have no effect if this option is set to NO (the default) 3475 1735 3476 1736 HAVE_DOT = @DOXYGEN_DOT_FOUND@ 3477 1737 3478 1738 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 3479 1739 # allowed to run in parallel. When set to 0 (the default) doxygen will 3480 1740 # base this on the number of processors available in the system. You can set it 3481 1741 # explicitly to a value larger than 0 to get control over the balance