Merge lp:~gary-wzl77/storage-provider-onedrive/merge-devel into lp:storage-provider-onedrive

Proposed by Gary.Wang
Reviewer Review Type Date Requested Status
onedrive-team Pending

Commit message

First release of storage provider onedrive.

Description of the change

First release of storage provider onedrive.

4. By Gary.Wang

merge from devel.

5. By Gary.Wang

merge from master to resolve the conflict.

Unmerged revisions

5. By Gary.Wang

merge from master to resolve the conflict.

4. By Gary.Wang

merge from devel.

3. By Gary.Wang

The implementation of provider and regarding test cases writing with storagw-fw client v2 API.

Approved by James Henstridge, unity-api-1-bot.

2. By Gary.Wang

debian file fixes.

Preview Diff

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