├── .gitignore ├── .travis.yml ├── CHANGELOG.adoc ├── LICENSE.txt ├── README.adoc ├── appveyor.yml ├── build.gradle ├── config └── HEADER ├── gradle.properties ├── gradle ├── download-tests.gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src ├── downloadTest ├── groovy │ └── org │ │ └── ysb33r │ │ └── gradle │ │ └── doxygen │ │ ├── DoxygenExecutableSpec.groovy │ │ ├── helper │ │ └── DownloadTestSpecification.groovy │ │ └── impl │ │ └── DownloaderSpec.groovy └── resources │ └── sample-cpp │ └── sample.cpp ├── gradleTest ├── buildBasicDoc │ ├── build.gradle │ └── src │ │ └── main │ │ └── cpp │ │ └── sample.cpp ├── doxygen_1_8_12 │ ├── athena │ │ └── src │ │ │ └── sample.cpp │ ├── build.gradle │ ├── ntSourceDir │ │ └── src │ │ │ └── sample.cpp │ └── shared │ │ └── src │ │ └── sample.cpp └── fakeRunner │ ├── build.gradle │ ├── fake-doxygen.bat │ ├── fake-doxygen.sh │ └── src │ ├── docs │ └── doxygen │ │ └── Doxyfile.template │ └── main │ └── cpp │ └── empty.cpp ├── main ├── groovy │ └── org │ │ └── ysb33r │ │ └── gradle │ │ └── doxygen │ │ ├── Doxygen.groovy │ │ ├── DoxygenException.groovy │ │ ├── DoxygenPlugin.groovy │ │ ├── DoxygenTemplateFiles.groovy │ │ └── impl │ │ ├── Downloader.groovy │ │ ├── DoxyfileEditor.groovy │ │ ├── DoxygenProperties.groovy │ │ └── Executables.groovy └── resources │ ├── META-INF │ └── gradle-plugins │ │ └── org.ysb33r.doxygen.properties │ └── doxyfile-template.dox └── test ├── groovy └── org │ └── ysb33r │ └── gradle │ └── doxygen │ ├── DoxygenPluginSpec.groovy │ ├── DoxygenTaskSpec.groovy │ └── impl │ ├── DoxyfileEditorSpec.groovy │ └── DoxygenPropertiesSpec.groovy └── resources └── DoxyfileEditor.dox /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | .classpath 3 | .project 4 | .settings 5 | build 6 | .DS_Store 7 | .idea 8 | *.iml 9 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: groovy 2 | script: ./gradlew clean build --info --no-daemon --scan 3 | jdk: 4 | - openjdk8 5 | os: 6 | - linux 7 | env: TERM=dumb 8 | before_cache: 9 | - rm -f $HOME/.gradle/caches/modules-2/modules-2.lock 10 | - rm -fr $HOME/.gradle/caches/*/plugin-resolution/ 11 | - rm -fr $HOME/.gradle/caches/*/scripts/ 12 | cache: 13 | directories: 14 | - "$HOME/.gradle" 15 | -------------------------------------------------------------------------------- /CHANGELOG.adoc: -------------------------------------------------------------------------------- 1 | = CHANGELOG 2 | 3 | == Version 0.6 4 | 5 | === Bugs 6 | 7 | * https://github.com/ysb33r/doxygen-gradle-plugin/issues/17[#17] - `ALIASES` property. 8 | * https://github.com/ysb33r/doxygen-gradle-plugin/issues/25[#25] - NoSuchMethodError: `org.gradle.api.internal.TaskInputsInternal.dir` with Gradle 6.0.1 9 | 10 | == Version 0.5 11 | 12 | === Bugs 13 | 14 | * https://github.com/ysb33r/doxygen-gradle-plugin/issues/20[#20] - Use SourceForge site to download Doxygen binaries 15 | 16 | === Breaking changes 17 | 18 | * Minimum required Gradle version is 3.0 19 | 20 | === Other 21 | 22 | * https://github.com/ysb33r/doxygen-gradle-plugin/issues/15[#15] - Replace DMG unpack code with that in Grolifant 0.6 23 | * Upgradled to Grolifant 0.10 24 | * https://github.com/ysb33r/doxygen-gradle-plugin/issues/21[#21] - README corrections. (Thank you @albert-github). 25 | 26 | == Version 0.4 27 | 28 | * Upgradled to Grolifant 0.5.1. 29 | 30 | == Version 0.3.2 31 | 32 | * https://github.com/ysb33r/doxygen-gradle-plugin/issues/11[#11] - Set version for default `doxygen` task. 33 | 34 | == Version 0.3.1 35 | 36 | * https://github.com/ysb33r/doxygen-gradle-plugin/issues/8[#8] - `NoSuchMethodError` when using own template with Gradle 3.5, 4.0. 37 | 38 | == Version 0.3 39 | 40 | === Breaking changes 41 | 42 | * `executables.doxygen` no longer will just accept a single string. It is now a map-based method. If you hard-coded paths to Doxygen installations before you will need to change it to read `doxygen path : '/path/to/doxygen'`. 43 | 44 | === Features 45 | 46 | * Minimum supported JDK is 1.7 47 | * https://github.com/ysb33r/doxygen-gradle-plugin/issues/3[#3] - No need to install Doxygen on Linux, MacOsX and Windows. 48 | * https://github.com/ysb33r/doxygen-gradle-plugin/issues/2[#2] - Deprecated XML_SCHEMA, XML_DTD removed from template Doxyfile. 49 | 50 | === Bugs 51 | 52 | * https://github.com/ysb33r/doxygen-gradle-plugin/issues/5[#5] - Parse continuation backslashes correctly. 53 | * https://github.com/ysb33r/doxygen-gradle-plugin/issues/6[#6] - Investigate potential Doxygen 1.8.12 issue. 54 | 55 | == Version 0.2 56 | * https://github.com/ysb33r/Gradle/issues/8[#8] - `template` not recognised as configuration option] 57 | * https://github.com/ysb33r/Gradle/issues/9[#9] - Change id to 'org.ysb33r.doxygen` 58 | 59 | == Version 0.1 60 | 61 | * Initial release -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | = Doxygen Plugin for Gradle 2 | 3 | This project has moved to https://gitlab.com/ysb33rOrg/doxygen-gradle-plugin 4 | -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | version: "{branch} {build}" 2 | 3 | build: 4 | verbosity: detailed 5 | 6 | build_script: 7 | - gradlew.bat assemble --info --no-daemon -PbintrayUserName -PbintrayApiKey 8 | 9 | test_script: 10 | - gradlew.bat check --info --no-daemon -PDO_NOT_RUN_DOXYGEN_EXE_TESTS=1 -PbintrayUserName -PbintrayApiKey 11 | 12 | branches: 13 | only: 14 | - master 15 | - development 16 | 17 | cache: 18 | - C:\Users\appveyor\.gradle 19 | 20 | environment: 21 | matrix: 22 | - JAVA_HOME: C:\Program Files\Java\jdk1.8.0 23 | - JAVA_HOME: C:\Program Files (x86)\Java\jdk1.8.0 24 | 25 | matrix: 26 | fast_finish: true 27 | 28 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.gradle.build-scan' version '1.16' 3 | id 'groovy' 4 | id 'maven' 5 | id 'org.ysb33r.os' version '0.9' 6 | id 'org.ysb33r.bintray' version '1.5' 7 | id 'org.ysb33r.cloudci' version '2.2' 8 | id 'org.ysb33r.gradletest' version '2.0' 9 | id 'com.jfrog.artifactory' version '3.0.1' 10 | id 'com.github.hierynomus.license' version '0.14.0' 11 | id 'com.gradle.plugin-publish' version '0.9.7' 12 | } 13 | 14 | buildScan { 15 | termsOfServiceUrl = 'https://gradle.com/terms-of-service' 16 | termsOfServiceAgree = 'yes' 17 | } 18 | 19 | apply from : 'gradle/download-tests.gradle' 20 | 21 | import org.ysb33r.gradle.bintray.BintraySignVersion 22 | 23 | 24 | group = 'org.ysb33r.gradle' 25 | archivesBaseName = 'doxygen' 26 | version = '0.6' 27 | sourceCompatibility = 1.7 28 | targetCompatibility = 1.7 29 | 30 | ext { 31 | moduleName = rootProject.name 32 | bintrayOwner = 'ysb33r' 33 | bintrayRepo = 'grysb33r' 34 | doxygenDownloadDir = new File(buildDir,'doxygen') 35 | spockGroovyVer = GroovySystem.version.replaceAll(/\.\d+$/,'') 36 | notSnapshot = {!version.endsWith("SNAPSHOT")} 37 | } 38 | 39 | repositories { 40 | jcenter() 41 | 42 | ivy { 43 | name 'Downloader for Doxygen distributions' 44 | url 'https://netix.dl.sourceforge.net/project/doxygen' 45 | resolve.dynamicMode = false 46 | layout 'pattern', { 47 | artifact 'rel-[revision]/[artifact]-[revision].[ext]' 48 | } 49 | } 50 | 51 | ivy { 52 | name 'Downloader for Doxygen distributions' 53 | url 'https://downloads.sourceforge.net/project/doxygen' 54 | resolve.dynamicMode = false 55 | layout 'pattern', { 56 | artifact 'rel-[revision]/[artifact]-[revision].[ext]' 57 | } 58 | } 59 | } 60 | 61 | jar { 62 | manifest { 63 | attributes 'Implementation-Title': moduleName, 'Implementation-Version': version 64 | } 65 | } 66 | 67 | test { 68 | systemProperties 'TESTFSREADROOT' : new File(projectDir,'src/test/resources').absolutePath 69 | systemProperties 'TESTFSWRITEROOT' : new File(buildDir,'tmp/test/doxygen').absolutePath 70 | } 71 | 72 | task sourcesJar(type: Jar, dependsOn: classes) { 73 | classifier = 'sources' 74 | from sourceSets.main.allSource 75 | } 76 | 77 | task javadocJar(type: Jar) { 78 | description "An archive of the JavaDocs for Maven Central" 79 | classifier "javadoc" 80 | from javadoc 81 | } 82 | 83 | artifacts { 84 | archives sourcesJar 85 | archives javadocJar 86 | } 87 | 88 | 89 | dependencies { 90 | compile gradleApi() 91 | compile localGroovy() 92 | compile 'org.ysb33r.gradle:grolifant:0.14' 93 | testCompile ("org.spockframework:spock-core:1.3-groovy-${spockGroovyVer}") { 94 | exclude module : 'groovy-all' 95 | } 96 | } 97 | 98 | artifactory { 99 | publish { 100 | contextUrl = 'http://oss.jfrog.org' 101 | repository { 102 | repoKey = 'oss-snapshot-local' 103 | username = project.properties.bintrayUserName 104 | password = project.properties.bintrayApiKey 105 | } 106 | } 107 | } 108 | 109 | artifactoryPublish { 110 | onlyIf { version.endsWith("SNAPSHOT") } 111 | } 112 | 113 | task signArchives (type:BintraySignVersion ) { 114 | username project.properties.bintrayUserName 115 | apiKey project.properties.bintrayApiKey 116 | repoOwner bintrayOwner 117 | repoName bintrayRepo 118 | packageName moduleName 119 | gpgPassphrase project.properties.bintrayGpgPassphrase 120 | } 121 | 122 | 123 | uploadArchives { 124 | repositories { 125 | bintrayMavenDeployer { 126 | username project.properties.bintrayUserName 127 | apiKey project.properties.bintrayApiKey 128 | repoOwner bintrayOwner 129 | repoName bintrayRepo 130 | packageName moduleName 131 | description 'This is a plugin for Gradle that allows Doxygen (www.doxygen.org) to be used to generate documentation' 132 | tags 'gradle','doxygen','documentation' 133 | licenses 'Apache-2.0' 134 | vcsUrl 'https://github.com/ysb33r/doxygen-gradle-plugin.git' 135 | autoCreatePackage true 136 | updatePackage true 137 | versionAttributes 'gradle-plugin' : "org.ysb33r.doxygen:${group}:${archivesBaseName}" 138 | } 139 | } 140 | 141 | onlyIf notSnapshot 142 | } 143 | 144 | pluginBundle { 145 | description = 'Doxygen plugin for Gradle' 146 | website = 'https://github.com/ysb33r/doxygen-gradle-plugin' 147 | vcsUrl = 'https://github.com/ysb33r/doxygen-gradle-plugin.git' 148 | 149 | tags = ['doxygen','documentation','native','cpp','c','c++'] 150 | 151 | plugins { 152 | gradletestPlugin { 153 | id = 'org.ysb33r.doxygen' 154 | displayName = 'This is a plugin for Gradle that allows Doxygen (www.doxygen.org) to be used to generate documentation' 155 | } 156 | } 157 | 158 | mavenCoordinates { 159 | groupId = project.group 160 | artifactId = 'doxygen-gradle-plugin' 161 | } 162 | 163 | } 164 | publishPlugins { 165 | onlyIf notSnapshot 166 | mustRunAfter check 167 | } 168 | 169 | license { 170 | header = rootProject.file('config/HEADER') 171 | strictCheck = true 172 | ignoreFailures = false 173 | mapping { 174 | groovy ='DOUBLESLASH_STYLE' 175 | } 176 | ext.year = '2013-2018' 177 | excludes([ 178 | '**/*.adoc', '**/*.md', 179 | '**/*.properties', 180 | '**/*.dox', 181 | '**/*dsl.groovySpec.groovy', 182 | '**/*dsl.kotlinSpec.groovy' 183 | ]) 184 | } 185 | 186 | gradleTest { 187 | versions '3.0', '3.5', '4.0', '4.2.1', '4.10.2', '5.0', '6.0.1' 188 | systemProperties DOX_VERSION : doxygenTestVersions[0] 189 | systemProperties DOX_REPO : cacheDoxygenBinaries.destinationDir 190 | dependsOn cacheDoxygenBinaries 191 | } 192 | 193 | cloudci { 194 | 195 | appveyor { 196 | gradleTest { 197 | maxParallelForks = 4 198 | } 199 | } 200 | 201 | travisci { 202 | gradleTest { 203 | maxParallelForks = 1 204 | } 205 | } 206 | } 207 | 208 | task release { 209 | dependsOn build, uploadArchives, publishPlugins 210 | onlyIf notSnapshot 211 | } 212 | -------------------------------------------------------------------------------- /config/HEADER: -------------------------------------------------------------------------------- 1 | ============================================================================ 2 | (C) Copyright Schalk W. Cronje ${year} 3 | 4 | This software is licensed under the Apache License 2.0 5 | See http://www.apache.org/licenses/LICENSE-2.0 for license details 6 | 7 | Unless required by applicable law or agreed to in writing, software distributed under the License is 8 | distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 9 | See the License for the specific language governing permissions and limitations under the License. 10 | 11 | ============================================================================ 12 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | org.gradle.daemon = true 2 | org.gradle.caching = true 3 | org.gradle.parallel = true 4 | -------------------------------------------------------------------------------- /gradle/download-tests.gradle: -------------------------------------------------------------------------------- 1 | // This is based upon what Rob Fletcher has done at 2 | // https://raw.githubusercontent.com/robfletcher/gradle-compass/master/gradle/download-tests.gradle 3 | import org.gradle.util.GradleVersion 4 | 5 | ext { 6 | currentOS = org.gradle.internal.os.OperatingSystem.current() 7 | doxygenCacheDir = "${buildDir}/doxygen-binaries" 8 | 9 | // Always list the primary test version as the first one in this list. 10 | doxygenTestVersions = [ '1.8.16','1.8.12' ] 11 | 12 | } 13 | 14 | configurations { 15 | downloadTestCompile { 16 | extendsFrom testCompile 17 | } 18 | downloadTestRuntime { 19 | extendsFrom downloadTestCompile, testRuntime 20 | } 21 | 22 | doxygenTestVersions.each { ver -> 23 | create "downloadTestCache${ver}" 24 | } 25 | 26 | } 27 | 28 | dependencies { 29 | doxygenTestVersions.each { ver -> 30 | def doxygenModuleName = 'doxygen' 31 | def doxygenExt 32 | 33 | if(currentOS.windows) { 34 | if (GradleVersion.version(ver) >= GradleVersion.version('1.8.0') && System.getProperty('os.arch').contains('64')) { 35 | doxygenExt = 'windows.x64.bin.zip' 36 | } else { 37 | doxygenExt = 'windows.bin.zip' 38 | } 39 | } else if (currentOS.linux) { 40 | doxygenExt = 'linux.bin.tar.gz' 41 | } else if (currentOS.macOsX) { 42 | doxygenModuleName = 'Doxygen' 43 | doxygenExt = 'dmg' 44 | } 45 | 46 | add "downloadTestCache${ver}", ":${doxygenModuleName}:${ver}@${doxygenExt}" 47 | } 48 | } 49 | 50 | sourceSets { 51 | downloadTest { 52 | java.srcDir file("src/downloadTest/java") 53 | groovy.srcDir file("src/downloadTest/groovy") 54 | resources.srcDir file("src/downloadTest/resources") 55 | compileClasspath = sourceSets.main.output + configurations.downloadTestCompile 56 | runtimeClasspath = output + compileClasspath + configurations.downloadTestRuntime 57 | } 58 | } 59 | 60 | task cacheDoxygenBinaries( type : Copy ) { 61 | doxygenTestVersions.each { ver -> 62 | from configurations.getByName("downloadTestCache${ver}"), { 63 | into "rel-${ver}" 64 | } 65 | } 66 | into doxygenCacheDir 67 | } 68 | 69 | task downloadTest(type: Test, dependsOn: jar) { 70 | testClassesDirs = sourceSets.downloadTest.output.classesDirs 71 | classpath = sourceSets.downloadTest.runtimeClasspath 72 | reports.html.destination = file("${reporting.baseDir}/downloadTest") 73 | 74 | systemProperties DOXYGEN_CACHE_DIR : cacheDoxygenBinaries.destinationDir.absolutePath 75 | systemProperties DOX_VERSION : doxygenTestVersions[0] 76 | systemProperties 'TESTFSREADROOT' : file("${projectDir}/src/downloadTest/resources").absolutePath 77 | systemProperties 'TESTFSWRITEROOT' : file("${buildDir}/tmp/downloadTest").absolutePath 78 | systemProperties 'DOXY_TEMPLATE' : file("${projectDir}/src/main/resources/doxyfile-template.dox").absolutePath 79 | 80 | mustRunAfter test 81 | dependsOn cacheDoxygenBinaries 82 | } 83 | 84 | 85 | check.dependsOn downloadTest 86 | 87 | 88 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ysb33r/doxygen-gradle-plugin/ccfcd121f16fa9b668b227d2a59070d46aebbefc/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | zipStoreBase=GRADLE_USER_HOME 4 | zipStorePath=wrapper/dists 5 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-bin.zip 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | // ============================================================================ 2 | // (C) Copyright Schalk W. Cronje 2013 3 | // 4 | // This software is licensed under the Apache License 2.0 5 | // See http://www.apache.org/licenses/LICENSE-2.0 for license details 6 | // 7 | // Unless required by applicable law or agreed to in writing, software distributed under the License is 8 | // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 9 | // See the License for the specific language governing permissions and limitations under the License. 10 | // 11 | // ============================================================================ 12 | 13 | rootProject.name = 'doxygen-gradle-plugin' 14 | 15 | 16 | -------------------------------------------------------------------------------- /src/downloadTest/groovy/org/ysb33r/gradle/doxygen/DoxygenExecutableSpec.groovy: -------------------------------------------------------------------------------- 1 | // 2 | // ============================================================================ 3 | // (C) Copyright Schalk W. Cronje 2013-2018 4 | // 5 | // This software is licensed under the Apache License 2.0 6 | // See http://www.apache.org/licenses/LICENSE-2.0 for license details 7 | // 8 | // Unless required by applicable law or agreed to in writing, software distributed under the License is 9 | // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 | // See the License for the specific language governing permissions and limitations under the License. 11 | // 12 | // ============================================================================ 13 | // 14 | 15 | package org.ysb33r.gradle.doxygen 16 | 17 | import org.gradle.api.Project 18 | import org.gradle.api.Task 19 | import org.gradle.testfixtures.ProjectBuilder 20 | import org.ysb33r.gradle.doxygen.helper.DownloadTestSpecification 21 | import spock.lang.IgnoreIf 22 | import spock.lang.Stepwise 23 | 24 | /** 25 | * @author Schalk W. Cronjé 26 | */ 27 | @Stepwise 28 | class DoxygenExecutableSpec extends DownloadTestSpecification { 29 | 30 | static final File TESTFSREADROOT = new File(System.getProperty('TESTFSREADROOT') ?: 'src/downloadTest/resources') 31 | static final File TESTFSWRITEROOT = new File(System.getProperty('TESTFSWRITEROOT') ?: 'build/tmp/downloadTest', 'DoxygenExecutableSpec') 32 | static final File DOXY_TEMPLATE = new File(System.getProperty('DOXY_TEMPLATE') ?: 'src/main/resources/doxyfile-template.dox') 33 | 34 | Project project = ProjectBuilder.builder().withName('DoxygenExecutableSpec').build() 35 | Task dox = project.task('doxygen', type: Doxygen) 36 | File downloadRoot = new File(project.buildDir, 'download') 37 | 38 | void setup() { 39 | if (TESTFSWRITEROOT.exists()) { 40 | TESTFSWRITEROOT.deleteDir() 41 | } 42 | 43 | TESTFSWRITEROOT.mkdirs() 44 | 45 | dox.configure { 46 | executables { 47 | doxygen version: DOX_VERSION, baseURI: DOXYGEN_CACHE_DIR.toURI(), downloadRoot: downloadRoot 48 | } 49 | } 50 | } 51 | 52 | @IgnoreIf({ DownloadTestSpecification.SKIP_TESTS }) 53 | def "Must be able to set doxygen executable using a version"() { 54 | given: 55 | dox.configure { 56 | executables { 57 | mscgen '/path/to/mscgen' 58 | } 59 | } 60 | 61 | when: 62 | String doxPath = dox.executables.doxygen.call() 63 | 64 | then: 65 | doxPath.contains(downloadRoot.absolutePath) 66 | doxPath.contains(DOX_VERSION) 67 | dox.executables.mscgen == '/path/to/mscgen' 68 | 69 | } 70 | 71 | @IgnoreIf({ DownloadTestSpecification.SKIP_TESTS }) 72 | def "Run Doxygen to generate simple documentation with a default template"() { 73 | given: 74 | dox.configure { 75 | source new File(TESTFSREADROOT, 'sample-cpp') 76 | outputDir new File(TESTFSWRITEROOT, 'docs') 77 | 78 | generate_xml false 79 | generate_latex false 80 | generate_html true 81 | have_dot false 82 | 83 | aliases 'ChangeLog=\\xrefitem ChangeLogs \"ChangeLog\" \"ChangeLogs\" ' 84 | 85 | executables { 86 | dot OS.windows ? 'C:/path/to/dot' : '/path/to/dot' 87 | } 88 | } 89 | 90 | dox.exec() 91 | 92 | expect: 93 | new File(TESTFSWRITEROOT, 'docs/html').exists() 94 | new File(TESTFSWRITEROOT, 'docs/html/index.html').exists() 95 | dox.doxygenProperties['DOT_PATH'] == new File(OS.windows ? 'C:/path/to/dot' : '/path/to/dot').absolutePath 96 | } 97 | 98 | 99 | @IgnoreIf({ DownloadTestSpecification.SKIP_TESTS }) 100 | def "When 'template' is supplied as a string, configuration should still work"() { 101 | given: 'A task configured with a custom template which is supplied as a string' 102 | dox.configure { 103 | source "${TESTFSREADROOT}/sample-cpp" 104 | outputDir "${TESTFSWRITEROOT}/docs" 105 | 106 | generate_xml false 107 | generate_latex false 108 | generate_html true 109 | have_dot false 110 | 111 | template DOXY_TEMPLATE.absolutePath 112 | } 113 | 114 | when: 'The task is executed' 115 | dox.exec() 116 | def lines = new File(project.buildDir, 'tmp/DoxygenExecutableSpec.doxyfile').text.readLines() 117 | 118 | then: 'The HTML files should have been created' 119 | new File(TESTFSWRITEROOT, 'docs/html').exists() 120 | new File(TESTFSWRITEROOT, 'docs/html/index.html').exists() 121 | 122 | and: 'Lines from the custom template should have been used' 123 | lines.find { 'FILE_PATTERNS =' } 124 | 125 | and: 'The custom template should be one of the task input files' 126 | dox.inputs.files.contains(DOXY_TEMPLATE) 127 | } 128 | 129 | } -------------------------------------------------------------------------------- /src/downloadTest/groovy/org/ysb33r/gradle/doxygen/helper/DownloadTestSpecification.groovy: -------------------------------------------------------------------------------- 1 | // 2 | // ============================================================================ 3 | // (C) Copyright Schalk W. Cronje 2013-2018 4 | // 5 | // This software is licensed under the Apache License 2.0 6 | // See http://www.apache.org/licenses/LICENSE-2.0 for license details 7 | // 8 | // Unless required by applicable law or agreed to in writing, software distributed under the License is 9 | // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 | // See the License for the specific language governing permissions and limitations under the License. 11 | // 12 | // ============================================================================ 13 | // 14 | 15 | package org.ysb33r.gradle.doxygen.helper 16 | 17 | import org.gradle.internal.os.OperatingSystem 18 | import spock.lang.Specification 19 | 20 | 21 | /** 22 | * @author Schalk W. Cronjé 23 | */ 24 | class DownloadTestSpecification extends Specification { 25 | static final String DOX_VERSION = System.getProperty('DOX_VERSION') ?: '1.8.8' 26 | static final File DOXYGEN_CACHE_DIR = new File(System.getProperty('DOXYGEN_CACHE_DIR') ?: './build/doxygen-binaries').absoluteFile 27 | static final OperatingSystem OS = OperatingSystem.current() 28 | static final boolean SKIP_TESTS = !(OS.isMacOsX() || OS.isLinux() || OS.isWindows()) 29 | } -------------------------------------------------------------------------------- /src/downloadTest/groovy/org/ysb33r/gradle/doxygen/impl/DownloaderSpec.groovy: -------------------------------------------------------------------------------- 1 | // 2 | // ============================================================================ 3 | // (C) Copyright Schalk W. Cronje 2013-2018 4 | // 5 | // This software is licensed under the Apache License 2.0 6 | // See http://www.apache.org/licenses/LICENSE-2.0 for license details 7 | // 8 | // Unless required by applicable law or agreed to in writing, software distributed under the License is 9 | // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 | // See the License for the specific language governing permissions and limitations under the License. 11 | // 12 | // ============================================================================ 13 | // 14 | 15 | package org.ysb33r.gradle.doxygen.impl 16 | 17 | import org.gradle.api.Project 18 | import org.gradle.testfixtures.ProjectBuilder 19 | import org.ysb33r.gradle.doxygen.helper.DownloadTestSpecification 20 | import spock.lang.IgnoreIf 21 | 22 | /** 23 | */ 24 | class DownloaderSpec extends DownloadTestSpecification { 25 | 26 | Project project = ProjectBuilder.builder().build() 27 | 28 | @IgnoreIf({ DownloadTestSpecification.SKIP_TESTS }) 29 | def "Download a Doxygen executable"() { 30 | given: "A requirement to download Doxygen #DOX_VERSION" 31 | Downloader dwn = new Downloader(DOX_VERSION, project) 32 | dwn.downloadRoot = new File(project.buildDir, 'download') 33 | dwn.baseURI = DOXYGEN_CACHE_DIR.toURI() 34 | 35 | when: "The distribution root is requested" 36 | File gotIt = dwn.distributionRoot 37 | 38 | then: "The distribution is downloaded and unpacked" 39 | gotIt != null 40 | if (OS.windows) { 41 | new File(gotIt, 'doxygen.exe').exists() 42 | } else if (OS.linux) { 43 | new File(gotIt, 'bin').exists() 44 | } else if (OS.macOsX) { 45 | new File(gotIt, 'Contents').exists() 46 | } 47 | 48 | when: "The doxygen executable is run to display the help page" 49 | project.exec { 50 | executable dwn.doxygenExecutablePath 51 | args '-h' 52 | } 53 | 54 | then: "No runtime error is expected" 55 | true 56 | } 57 | } -------------------------------------------------------------------------------- /src/downloadTest/resources/sample-cpp/sample.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * ============================================================================ 3 | * (C) Copyright Schalk W. Cronje 2013-2018 4 | * 5 | * This software is licensed under the Apache License 2.0 6 | * See http://www.apache.org/licenses/LICENSE-2.0 for license details 7 | * 8 | * Unless required by applicable law or agreed to in writing, software distributed under the License is 9 | * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 | * See the License for the specific language governing permissions and limitations under the License. 11 | * 12 | * ============================================================================ 13 | */ 14 | /** This is a class description 15 | * 16 | */ 17 | class DoxygenTestExample { 18 | public: 19 | /** This is a simple function that does not do anything 20 | */ 21 | void test() { 22 | } 23 | } -------------------------------------------------------------------------------- /src/gradleTest/buildBasicDoc/build.gradle: -------------------------------------------------------------------------------- 1 | 2 | apply plugin : 'org.ysb33r.doxygen' 3 | 4 | doxygen { 5 | 6 | source 'src/main/cpp' 7 | 8 | executables { 9 | doxygen version : System.getProperty('DOX_VERSION'), 10 | baseURI : project.file(System.getProperty('DOX_REPO')).toURI() 11 | } 12 | 13 | doLast { 14 | File html = project.file("${buildDir}/docs/doxygen/html/index.html") 15 | if(!html.exists()) { 16 | throw new GradleException("Documentation not found at ${html}") 17 | } 18 | } 19 | } 20 | 21 | task runGradleTest { 22 | dependsOn doxygen 23 | } -------------------------------------------------------------------------------- /src/gradleTest/buildBasicDoc/src/main/cpp/sample.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * ============================================================================ 3 | * (C) Copyright Schalk W. Cronje 2013-2015 4 | * 5 | * This software is licensed under the Apache License 2.0 6 | * See http://www.apache.org/licenses/LICENSE-2.0 for license details 7 | * 8 | * Unless required by applicable law or agreed to in writing, software distributed under the License is 9 | * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 | * See the License for the specific language governing permissions and limitations under the License. 11 | * 12 | * ============================================================================ 13 | */ 14 | 15 | /** This is a class description 16 | * 17 | */ 18 | class DoxygenTestExample { 19 | public: 20 | /** This is a simple function that does not do anything 21 | */ 22 | void test() { 23 | } 24 | } -------------------------------------------------------------------------------- /src/gradleTest/doxygen_1_8_12/athena/src/sample.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * ============================================================================ 3 | * (C) Copyright Schalk W. Cronje 2013-2015 4 | * 5 | * This software is licensed under the Apache License 2.0 6 | * See http://www.apache.org/licenses/LICENSE-2.0 for license details 7 | * 8 | * Unless required by applicable law or agreed to in writing, software distributed under the License is 9 | * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 | * See the License for the specific language governing permissions and limitations under the License. 11 | * 12 | * ============================================================================ 13 | */ 14 | 15 | /** This is a class description 16 | * 17 | */ 18 | class AthenaTestExample { 19 | public: 20 | /** This is a simple function that does not do anything 21 | */ 22 | void test() { 23 | } 24 | } -------------------------------------------------------------------------------- /src/gradleTest/doxygen_1_8_12/build.gradle: -------------------------------------------------------------------------------- 1 | // See https://github.com/ysb33r/doxygen-gradle-plugin/issues/6 2 | 3 | apply plugin : 'org.ysb33r.doxygen' 4 | 5 | version = '1.999' 6 | 7 | ext { 8 | shared = file('shared') 9 | athena = file('athena') 10 | ntSourceDir = file('ntSourceDir') 11 | halLocation = file('../hal') 12 | } 13 | 14 | doxygen { 15 | 16 | 17 | executables { 18 | doxygen version : '1.8.12', 19 | baseURI : project.file(System.getProperty('DOX_REPO')).toURI() 20 | } 21 | 22 | source new File("${project.shared}/src") 23 | source new File("${project.shared}/include") 24 | source new File("${project.athena}/src") 25 | source new File("${project.athena}/include") 26 | source new File("$ntSourceDir/src") 27 | source new File("$ntSourceDir/include") 28 | source new File("$halLocation/shared") 29 | source new File("$halLocation/athena") 30 | source new File("$halLocation/include") 31 | 32 | exclude 'nivision.h' 33 | extension_mapping 'inc=C++' 34 | project_name 'WPILibC++' 35 | javadoc_autobrief true 36 | recursive true 37 | quiet true 38 | warnings false 39 | warn_if_doc_error false 40 | warn_no_paramdoc false 41 | warn_format false 42 | warn_logfile false 43 | warn_if_undocumented false 44 | generate_latex false 45 | html_timestamp true 46 | generate_treeview true 47 | 48 | outputDir new File("$buildDir/docs") 49 | 50 | doLast { 51 | File html = project.file("${buildDir}/docs/html/index.html") 52 | if(!html.exists()) { 53 | throw new GradleException("Documentation not found at ${html}") 54 | } 55 | } 56 | 57 | 58 | } 59 | 60 | task runGradleTest { 61 | dependsOn doxygen 62 | 63 | doLast { 64 | assert tasks.doxygen.doxygenProperties['PROJECT_NUMBER'] == project.version 65 | } 66 | } 67 | 68 | -------------------------------------------------------------------------------- /src/gradleTest/doxygen_1_8_12/ntSourceDir/src/sample.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * ============================================================================ 3 | * (C) Copyright Schalk W. Cronje 2013-2015 4 | * 5 | * This software is licensed under the Apache License 2.0 6 | * See http://www.apache.org/licenses/LICENSE-2.0 for license details 7 | * 8 | * Unless required by applicable law or agreed to in writing, software distributed under the License is 9 | * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 | * See the License for the specific language governing permissions and limitations under the License. 11 | * 12 | * ============================================================================ 13 | */ 14 | 15 | /** This is a class description 16 | * 17 | */ 18 | class NtSourceDirTestExample { 19 | public: 20 | /** This is a simple function that does not do anything 21 | */ 22 | void test() { 23 | } 24 | } -------------------------------------------------------------------------------- /src/gradleTest/doxygen_1_8_12/shared/src/sample.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * ============================================================================ 3 | * (C) Copyright Schalk W. Cronje 2013-2015 4 | * 5 | * This software is licensed under the Apache License 2.0 6 | * See http://www.apache.org/licenses/LICENSE-2.0 for license details 7 | * 8 | * Unless required by applicable law or agreed to in writing, software distributed under the License is 9 | * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 | * See the License for the specific language governing permissions and limitations under the License. 11 | * 12 | * ============================================================================ 13 | */ 14 | 15 | /** This is a class description 16 | * 17 | */ 18 | class SharedTestExample { 19 | public: 20 | /** This is a simple function that does not do anything 21 | */ 22 | void test() { 23 | } 24 | } -------------------------------------------------------------------------------- /src/gradleTest/fakeRunner/build.gradle: -------------------------------------------------------------------------------- 1 | import org.gradle.internal.os.OperatingSystem 2 | 3 | apply plugin: 'org.ysb33r.doxygen' 4 | 5 | version = '1.999' 6 | 7 | doxygen { 8 | executables { 9 | doxygen path: project.file("fake-doxygen${OperatingSystem.current().isWindows() ? '.bat' : '.sh'}") 10 | } 11 | 12 | source project.file('src/main/cpp') 13 | template 'src/docs/doxygen/Doxyfile.template' 14 | 15 | } 16 | 17 | task runGradleTest { 18 | dependsOn doxygen 19 | } 20 | 21 | // Work around a bug in GradleTest (https://gitlab.com/ysb33rOrg/gradleTest/issues/76) 22 | if (!OperatingSystem.current().isWindows()) { 23 | doxygen.doFirst { 24 | def script = file('fake-doxygen.sh').toPath() 25 | def perms = java.nio.file.Files.getPosixFilePermissions(script) 26 | perms.add(java.nio.file.attribute.PosixFilePermission.OWNER_EXECUTE) 27 | java.nio.file.Files.setPosixFilePermissions(script, perms) 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /src/gradleTest/fakeRunner/fake-doxygen.bat: -------------------------------------------------------------------------------- 1 | @REM 2 | @REM ============================================================================ 3 | @REM (C) Copyright Schalk W. Cronje 2013-2016 4 | @REM 5 | @REM This software is licensed under the Apache License 2.0 6 | @REM See http://www.apache.org/licenses/LICENSE-2.0 for license details 7 | @REM 8 | @REM Unless required by applicable law or agreed to in writing, software distributed under the License is 9 | @REM distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 | @REM See the License for the specific language governing permissions and limitations under the License. 11 | @REM 12 | @REM ============================================================================ 13 | @REM 14 | 15 | @echo off 16 | echo fake-doygen %1 %2 %3 %4 %5 %6 %7 %8 %9 -------------------------------------------------------------------------------- /src/gradleTest/fakeRunner/fake-doxygen.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # 3 | # ============================================================================ 4 | # (C) Copyright Schalk W. Cronje 2013-2016 5 | # 6 | # This software is licensed under the Apache License 2.0 7 | # See http://www.apache.org/licenses/LICENSE-2.0 for license details 8 | # 9 | # Unless required by applicable law or agreed to in writing, software distributed under the License is 10 | # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | # See the License for the specific language governing permissions and limitations under the License. 12 | # 13 | # ============================================================================ 14 | # 15 | 16 | echo fake-dxygeb $@ 17 | -------------------------------------------------------------------------------- /src/gradleTest/fakeRunner/src/docs/doxygen/Doxyfile.template: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.5 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "My Project" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify an logo or icon that is included in 50 | # the documentation. The maximum height of the logo should not exceed 55 pixels 51 | # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 52 | # to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 74 | # documentation generated by doxygen is written. Doxygen will use this 75 | # information to generate all constant output in the proper language. 76 | # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese- 77 | # Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, 78 | # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, 79 | # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, 80 | # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 81 | # Turkish, Ukrainian and Vietnamese. 82 | # The default value is: English. 83 | 84 | OUTPUT_LANGUAGE = English 85 | 86 | # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 87 | # descriptions after the members that are listed in the file and class 88 | # documentation (similar to Javadoc). Set to NO to disable this. 89 | # The default value is: YES. 90 | 91 | BRIEF_MEMBER_DESC = YES 92 | 93 | # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 94 | # description of a member or function before the detailed description 95 | # 96 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 97 | # brief descriptions will be completely suppressed. 98 | # The default value is: YES. 99 | 100 | REPEAT_BRIEF = YES 101 | 102 | # This tag implements a quasi-intelligent brief description abbreviator that is 103 | # used to form the text in various listings. Each string in this list, if found 104 | # as the leading text of the brief description, will be stripped from the text 105 | # and the result, after processing the whole list, is used as the annotated 106 | # text. Otherwise, the brief description is used as-is. If left blank, the 107 | # following values are used ($name is automatically replaced with the name of 108 | # the entity):The $name class, The $name widget, The $name file, is, provides, 109 | # specifies, contains, represents, a, an and the. 110 | 111 | ABBREVIATE_BRIEF = 112 | 113 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 114 | # doxygen will generate a detailed section even if there is only a brief 115 | # description. 116 | # The default value is: NO. 117 | 118 | ALWAYS_DETAILED_SEC = NO 119 | 120 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 121 | # inherited members of a class in the documentation of that class as if those 122 | # members were ordinary class members. Constructors, destructors and assignment 123 | # operators of the base classes will not be shown. 124 | # The default value is: NO. 125 | 126 | INLINE_INHERITED_MEMB = NO 127 | 128 | # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 129 | # before files name in the file list and in the header files. If set to NO the 130 | # shortest path that makes the file name unique will be used 131 | # The default value is: YES. 132 | 133 | FULL_PATH_NAMES = YES 134 | 135 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 136 | # Stripping is only done if one of the specified strings matches the left-hand 137 | # part of the path. The tag can be used to show relative paths in the file list. 138 | # If left blank the directory from which doxygen is run is used as the path to 139 | # strip. 140 | # 141 | # Note that you can specify absolute paths here, but also relative paths, which 142 | # will be relative from the directory where doxygen is started. 143 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 144 | 145 | STRIP_FROM_PATH = 146 | 147 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 148 | # path mentioned in the documentation of a class, which tells the reader which 149 | # header file to include in order to use a class. If left blank only the name of 150 | # the header file containing the class definition is used. Otherwise one should 151 | # specify the list of include paths that are normally passed to the compiler 152 | # using the -I flag. 153 | 154 | STRIP_FROM_INC_PATH = 155 | 156 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 157 | # less readable) file names. This can be useful is your file systems doesn't 158 | # support long names like on DOS, Mac, or CD-ROM. 159 | # The default value is: NO. 160 | 161 | SHORT_NAMES = NO 162 | 163 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 164 | # first line (until the first dot) of a Javadoc-style comment as the brief 165 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 166 | # style comments (thus requiring an explicit @brief command for a brief 167 | # description.) 168 | # The default value is: NO. 169 | 170 | JAVADOC_AUTOBRIEF = NO 171 | 172 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 173 | # line (until the first dot) of a Qt-style comment as the brief description. If 174 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 175 | # requiring an explicit \brief command for a brief description.) 176 | # The default value is: NO. 177 | 178 | QT_AUTOBRIEF = NO 179 | 180 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 181 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 182 | # a brief description. This used to be the default behavior. The new default is 183 | # to treat a multi-line C++ comment block as a detailed description. Set this 184 | # tag to YES if you prefer the old behavior instead. 185 | # 186 | # Note that setting this tag to YES also means that rational rose comments are 187 | # not recognized any more. 188 | # The default value is: NO. 189 | 190 | MULTILINE_CPP_IS_BRIEF = NO 191 | 192 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 193 | # documentation from any documented member that it re-implements. 194 | # The default value is: YES. 195 | 196 | INHERIT_DOCS = YES 197 | 198 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 199 | # new page for each member. If set to NO, the documentation of a member will be 200 | # part of the file/class/namespace that contains it. 201 | # The default value is: NO. 202 | 203 | SEPARATE_MEMBER_PAGES = NO 204 | 205 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 206 | # uses this value to replace tabs by spaces in code fragments. 207 | # Minimum value: 1, maximum value: 16, default value: 4. 208 | 209 | TAB_SIZE = 4 210 | 211 | # This tag can be used to specify a number of aliases that act as commands in 212 | # the documentation. An alias has the form: 213 | # name=value 214 | # For example adding 215 | # "sideeffect=@par Side Effects:\n" 216 | # will allow you to put the command \sideeffect (or @sideeffect) in the 217 | # documentation, which will result in a user-defined paragraph with heading 218 | # "Side Effects:". You can put \n's in the value part of an alias to insert 219 | # newlines. 220 | 221 | ALIASES = 222 | 223 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 224 | # A mapping has the form "name=value". For example adding "class=itcl::class" 225 | # will allow you to use the command class in the itcl::class meaning. 226 | 227 | TCL_SUBST = 228 | 229 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 230 | # only. Doxygen will then generate output that is more tailored for C. For 231 | # instance, some of the names that are used will be different. The list of all 232 | # members will be omitted, etc. 233 | # The default value is: NO. 234 | 235 | OPTIMIZE_OUTPUT_FOR_C = NO 236 | 237 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 238 | # Python sources only. Doxygen will then generate output that is more tailored 239 | # for that language. For instance, namespaces will be presented as packages, 240 | # qualified scopes will look different, etc. 241 | # The default value is: NO. 242 | 243 | OPTIMIZE_OUTPUT_JAVA = NO 244 | 245 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 246 | # sources. Doxygen will then generate output that is tailored for Fortran. 247 | # The default value is: NO. 248 | 249 | OPTIMIZE_FOR_FORTRAN = NO 250 | 251 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 252 | # sources. Doxygen will then generate output that is tailored for VHDL. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_VHDL = NO 256 | 257 | # Doxygen selects the parser to use depending on the extension of the files it 258 | # parses. With this tag you can assign which parser to use for a given 259 | # extension. Doxygen has a built-in mapping, but you can override or extend it 260 | # using this tag. The format is ext=language, where ext is a file extension, and 261 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 262 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make 263 | # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 264 | # (default is Fortran), use: inc=Fortran f=C. 265 | # 266 | # Note For files without extension you can use no_extension as a placeholder. 267 | # 268 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 269 | # the files are not read by doxygen. 270 | 271 | EXTENSION_MAPPING = 272 | 273 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 274 | # according to the Markdown format, which allows for more readable 275 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 276 | # The output of markdown processing is further processed by doxygen, so you can 277 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 278 | # case of backward compatibilities issues. 279 | # The default value is: YES. 280 | 281 | MARKDOWN_SUPPORT = YES 282 | 283 | # When enabled doxygen tries to link words that correspond to documented 284 | # classes, or namespaces to their corresponding documentation. Such a link can 285 | # be prevented in individual cases by by putting a % sign in front of the word 286 | # or globally by setting AUTOLINK_SUPPORT to NO. 287 | # The default value is: YES. 288 | 289 | AUTOLINK_SUPPORT = YES 290 | 291 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 292 | # to include (a tag file for) the STL sources as input, then you should set this 293 | # tag to YES in order to let doxygen match functions declarations and 294 | # definitions whose arguments contain STL classes (e.g. func(std::string); 295 | # versus func(std::string) {}). This also make the inheritance and collaboration 296 | # diagrams that involve STL classes more complete and accurate. 297 | # The default value is: NO. 298 | 299 | BUILTIN_STL_SUPPORT = NO 300 | 301 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 302 | # enable parsing support. 303 | # The default value is: NO. 304 | 305 | CPP_CLI_SUPPORT = NO 306 | 307 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 308 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 309 | # will parse them like normal C++ but will assume all classes use public instead 310 | # of private inheritance when no explicit protection keyword is present. 311 | # The default value is: NO. 312 | 313 | SIP_SUPPORT = NO 314 | 315 | # For Microsoft's IDL there are propget and propput attributes to indicate 316 | # getter and setter methods for a property. Setting this option to YES will make 317 | # doxygen to replace the get and set methods by a property in the documentation. 318 | # This will only work if the methods are indeed getting or setting a simple 319 | # type. If this is not the case, or you want to show the methods anyway, you 320 | # should set this option to NO. 321 | # The default value is: YES. 322 | 323 | IDL_PROPERTY_SUPPORT = YES 324 | 325 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 326 | # tag is set to YES, then doxygen will reuse the documentation of the first 327 | # member in the group (if any) for the other members of the group. By default 328 | # all members of a group must be documented explicitly. 329 | # The default value is: NO. 330 | 331 | DISTRIBUTE_GROUP_DOC = NO 332 | 333 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 334 | # (for instance a group of public functions) to be put as a subgroup of that 335 | # type (e.g. under the Public Functions section). Set it to NO to prevent 336 | # subgrouping. Alternatively, this can be done per class using the 337 | # \nosubgrouping command. 338 | # The default value is: YES. 339 | 340 | SUBGROUPING = YES 341 | 342 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 343 | # are shown inside the group in which they are included (e.g. using \ingroup) 344 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 345 | # and RTF). 346 | # 347 | # Note that this feature does not work in combination with 348 | # SEPARATE_MEMBER_PAGES. 349 | # The default value is: NO. 350 | 351 | INLINE_GROUPED_CLASSES = NO 352 | 353 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 354 | # with only public data fields or simple typedef fields will be shown inline in 355 | # the documentation of the scope in which they are defined (i.e. file, 356 | # namespace, or group documentation), provided this scope is documented. If set 357 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 358 | # Man pages) or section (for LaTeX and RTF). 359 | # The default value is: NO. 360 | 361 | INLINE_SIMPLE_STRUCTS = NO 362 | 363 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 364 | # enum is documented as struct, union, or enum with the name of the typedef. So 365 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 366 | # with name TypeT. When disabled the typedef will appear as a member of a file, 367 | # namespace, or class. And the struct will be named TypeS. This can typically be 368 | # useful for C code in case the coding convention dictates that all compound 369 | # types are typedef'ed and only the typedef is referenced, never the tag name. 370 | # The default value is: NO. 371 | 372 | TYPEDEF_HIDES_STRUCT = NO 373 | 374 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 375 | # cache is used to resolve symbols given their name and scope. Since this can be 376 | # an expensive process and often the same symbol appears multiple times in the 377 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 378 | # doxygen will become slower. If the cache is too large, memory is wasted. The 379 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 380 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 381 | # symbols. At the end of a run doxygen will report the cache usage and suggest 382 | # the optimal cache size from a speed point of view. 383 | # Minimum value: 0, maximum value: 9, default value: 0. 384 | 385 | LOOKUP_CACHE_SIZE = 0 386 | 387 | #--------------------------------------------------------------------------- 388 | # Build related configuration options 389 | #--------------------------------------------------------------------------- 390 | 391 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 392 | # documentation are documented, even if no documentation was available. Private 393 | # class members and static file members will be hidden unless the 394 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 395 | # Note: This will also disable the warnings about undocumented members that are 396 | # normally produced when WARNINGS is set to YES. 397 | # The default value is: NO. 398 | 399 | EXTRACT_ALL = NO 400 | 401 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 402 | # be included in the documentation. 403 | # The default value is: NO. 404 | 405 | EXTRACT_PRIVATE = NO 406 | 407 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 408 | # scope will be included in the documentation. 409 | # The default value is: NO. 410 | 411 | EXTRACT_PACKAGE = NO 412 | 413 | # If the EXTRACT_STATIC tag is set to YES all static members of a file will be 414 | # included in the documentation. 415 | # The default value is: NO. 416 | 417 | EXTRACT_STATIC = NO 418 | 419 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 420 | # locally in source files will be included in the documentation. If set to NO 421 | # only classes defined in header files are included. Does not have any effect 422 | # for Java sources. 423 | # The default value is: YES. 424 | 425 | EXTRACT_LOCAL_CLASSES = YES 426 | 427 | # This flag is only useful for Objective-C code. When set to YES local methods, 428 | # which are defined in the implementation section but not in the interface are 429 | # included in the documentation. If set to NO only methods in the interface are 430 | # included. 431 | # The default value is: NO. 432 | 433 | EXTRACT_LOCAL_METHODS = NO 434 | 435 | # If this flag is set to YES, the members of anonymous namespaces will be 436 | # extracted and appear in the documentation as a namespace called 437 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 438 | # the file that contains the anonymous namespace. By default anonymous namespace 439 | # are hidden. 440 | # The default value is: NO. 441 | 442 | EXTRACT_ANON_NSPACES = NO 443 | 444 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 445 | # undocumented members inside documented classes or files. If set to NO these 446 | # members will be included in the various overviews, but no documentation 447 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 448 | # The default value is: NO. 449 | 450 | HIDE_UNDOC_MEMBERS = NO 451 | 452 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 453 | # undocumented classes that are normally visible in the class hierarchy. If set 454 | # to NO these classes will be included in the various overviews. This option has 455 | # no effect if EXTRACT_ALL is enabled. 456 | # The default value is: NO. 457 | 458 | HIDE_UNDOC_CLASSES = NO 459 | 460 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 461 | # (class|struct|union) declarations. If set to NO these declarations will be 462 | # included in the documentation. 463 | # The default value is: NO. 464 | 465 | HIDE_FRIEND_COMPOUNDS = NO 466 | 467 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 468 | # documentation blocks found inside the body of a function. If set to NO these 469 | # blocks will be appended to the function's detailed documentation block. 470 | # The default value is: NO. 471 | 472 | HIDE_IN_BODY_DOCS = NO 473 | 474 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 475 | # \internal command is included. If the tag is set to NO then the documentation 476 | # will be excluded. Set it to YES to include the internal documentation. 477 | # The default value is: NO. 478 | 479 | INTERNAL_DOCS = NO 480 | 481 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 482 | # names in lower-case letters. If set to YES upper-case letters are also 483 | # allowed. This is useful if you have classes or files whose names only differ 484 | # in case and if your file system supports case sensitive file names. Windows 485 | # and Mac users are advised to set this option to NO. 486 | # The default value is: system dependent. 487 | 488 | CASE_SENSE_NAMES = NO 489 | 490 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 491 | # their full class and namespace scopes in the documentation. If set to YES the 492 | # scope will be hidden. 493 | # The default value is: NO. 494 | 495 | HIDE_SCOPE_NAMES = NO 496 | 497 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 498 | # the files that are included by a file in the documentation of that file. 499 | # The default value is: YES. 500 | 501 | SHOW_INCLUDE_FILES = YES 502 | 503 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 504 | # files with double quotes in the documentation rather than with sharp brackets. 505 | # The default value is: NO. 506 | 507 | FORCE_LOCAL_INCLUDES = NO 508 | 509 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 510 | # documentation for inline members. 511 | # The default value is: YES. 512 | 513 | INLINE_INFO = YES 514 | 515 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 516 | # (detailed) documentation of file and class members alphabetically by member 517 | # name. If set to NO the members will appear in declaration order. 518 | # The default value is: YES. 519 | 520 | SORT_MEMBER_DOCS = YES 521 | 522 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 523 | # descriptions of file, namespace and class members alphabetically by member 524 | # name. If set to NO the members will appear in declaration order. 525 | # The default value is: NO. 526 | 527 | SORT_BRIEF_DOCS = NO 528 | 529 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 530 | # (brief and detailed) documentation of class members so that constructors and 531 | # destructors are listed first. If set to NO the constructors will appear in the 532 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 533 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 534 | # member documentation. 535 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 536 | # detailed member documentation. 537 | # The default value is: NO. 538 | 539 | SORT_MEMBERS_CTORS_1ST = NO 540 | 541 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 542 | # of group names into alphabetical order. If set to NO the group names will 543 | # appear in their defined order. 544 | # The default value is: NO. 545 | 546 | SORT_GROUP_NAMES = NO 547 | 548 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 549 | # fully-qualified names, including namespaces. If set to NO, the class list will 550 | # be sorted only by class name, not including the namespace part. 551 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 552 | # Note: This option applies only to the class list, not to the alphabetical 553 | # list. 554 | # The default value is: NO. 555 | 556 | SORT_BY_SCOPE_NAME = NO 557 | 558 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 559 | # type resolution of all parameters of a function it will reject a match between 560 | # the prototype and the implementation of a member function even if there is 561 | # only one candidate or it is obvious which candidate to choose by doing a 562 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 563 | # accept a match between prototype and implementation in such cases. 564 | # The default value is: NO. 565 | 566 | STRICT_PROTO_MATCHING = NO 567 | 568 | # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 569 | # todo list. This list is created by putting \todo commands in the 570 | # documentation. 571 | # The default value is: YES. 572 | 573 | GENERATE_TODOLIST = YES 574 | 575 | # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 576 | # test list. This list is created by putting \test commands in the 577 | # documentation. 578 | # The default value is: YES. 579 | 580 | GENERATE_TESTLIST = YES 581 | 582 | # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 583 | # list. This list is created by putting \bug commands in the documentation. 584 | # The default value is: YES. 585 | 586 | GENERATE_BUGLIST = YES 587 | 588 | # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 589 | # the deprecated list. This list is created by putting \deprecated commands in 590 | # the documentation. 591 | # The default value is: YES. 592 | 593 | GENERATE_DEPRECATEDLIST= YES 594 | 595 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 596 | # sections, marked by \if ... \endif and \cond 597 | # ... \endcond blocks. 598 | 599 | ENABLED_SECTIONS = 600 | 601 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 602 | # initial value of a variable or macro / define can have for it to appear in the 603 | # documentation. If the initializer consists of more lines than specified here 604 | # it will be hidden. Use a value of 0 to hide initializers completely. The 605 | # appearance of the value of individual variables and macros / defines can be 606 | # controlled using \showinitializer or \hideinitializer command in the 607 | # documentation regardless of this setting. 608 | # Minimum value: 0, maximum value: 10000, default value: 30. 609 | 610 | MAX_INITIALIZER_LINES = 30 611 | 612 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 613 | # the bottom of the documentation of classes and structs. If set to YES the list 614 | # will mention the files that were used to generate the documentation. 615 | # The default value is: YES. 616 | 617 | SHOW_USED_FILES = YES 618 | 619 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 620 | # will remove the Files entry from the Quick Index and from the Folder Tree View 621 | # (if specified). 622 | # The default value is: YES. 623 | 624 | SHOW_FILES = YES 625 | 626 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 627 | # page. This will remove the Namespaces entry from the Quick Index and from the 628 | # Folder Tree View (if specified). 629 | # The default value is: YES. 630 | 631 | SHOW_NAMESPACES = YES 632 | 633 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 634 | # doxygen should invoke to get the current version for each file (typically from 635 | # the version control system). Doxygen will invoke the program by executing (via 636 | # popen()) the command command input-file, where command is the value of the 637 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 638 | # by doxygen. Whatever the program writes to standard output is used as the file 639 | # version. For an example see the documentation. 640 | 641 | FILE_VERSION_FILTER = 642 | 643 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 644 | # by doxygen. The layout file controls the global structure of the generated 645 | # output files in an output format independent way. To create the layout file 646 | # that represents doxygen's defaults, run doxygen with the -l option. You can 647 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 648 | # will be used as the name of the layout file. 649 | # 650 | # Note that if you run doxygen from a directory containing a file called 651 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 652 | # tag is left empty. 653 | 654 | LAYOUT_FILE = 655 | 656 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 657 | # the reference definitions. This must be a list of .bib files. The .bib 658 | # extension is automatically appended if omitted. This requires the bibtex tool 659 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 660 | # For LaTeX the style of the bibliography can be controlled using 661 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 662 | # search path. Do not use file names with spaces, bibtex cannot handle them. See 663 | # also \cite for info how to create references. 664 | 665 | CITE_BIB_FILES = 666 | 667 | #--------------------------------------------------------------------------- 668 | # Configuration options related to warning and progress messages 669 | #--------------------------------------------------------------------------- 670 | 671 | # The QUIET tag can be used to turn on/off the messages that are generated to 672 | # standard output by doxygen. If QUIET is set to YES this implies that the 673 | # messages are off. 674 | # The default value is: NO. 675 | 676 | QUIET = NO 677 | 678 | # The WARNINGS tag can be used to turn on/off the warning messages that are 679 | # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 680 | # this implies that the warnings are on. 681 | # 682 | # Tip: Turn warnings on while writing the documentation. 683 | # The default value is: YES. 684 | 685 | WARNINGS = YES 686 | 687 | # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 688 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 689 | # will automatically be disabled. 690 | # The default value is: YES. 691 | 692 | WARN_IF_UNDOCUMENTED = YES 693 | 694 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 695 | # potential errors in the documentation, such as not documenting some parameters 696 | # in a documented function, or documenting parameters that don't exist or using 697 | # markup commands wrongly. 698 | # The default value is: YES. 699 | 700 | WARN_IF_DOC_ERROR = YES 701 | 702 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 703 | # are documented, but have no documentation for their parameters or return 704 | # value. If set to NO doxygen will only warn about wrong or incomplete parameter 705 | # documentation, but not about the absence of documentation. 706 | # The default value is: NO. 707 | 708 | WARN_NO_PARAMDOC = NO 709 | 710 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 711 | # can produce. The string should contain the $file, $line, and $text tags, which 712 | # will be replaced by the file and line number from which the warning originated 713 | # and the warning text. Optionally the format may contain $version, which will 714 | # be replaced by the version of the file (if it could be obtained via 715 | # FILE_VERSION_FILTER) 716 | # The default value is: $file:$line: $text. 717 | 718 | WARN_FORMAT = "$file:$line: $text" 719 | 720 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 721 | # messages should be written. If left blank the output is written to standard 722 | # error (stderr). 723 | 724 | WARN_LOGFILE = 725 | 726 | #--------------------------------------------------------------------------- 727 | # Configuration options related to the input files 728 | #--------------------------------------------------------------------------- 729 | 730 | # The INPUT tag is used to specify the files and/or directories that contain 731 | # documented source files. You may enter file names like myfile.cpp or 732 | # directories like /usr/src/myproject. Separate the files or directories with 733 | # spaces. 734 | # Note: If this tag is empty the current directory is searched. 735 | 736 | INPUT = 737 | 738 | # This tag can be used to specify the character encoding of the source files 739 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 740 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 741 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 742 | # possible encodings. 743 | # The default value is: UTF-8. 744 | 745 | INPUT_ENCODING = UTF-8 746 | 747 | # If the value of the INPUT tag contains directories, you can use the 748 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 749 | # *.h) to filter out the source-files in the directories. If left blank the 750 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 751 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 752 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 753 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 754 | # *.qsf, *.as and *.js. 755 | 756 | FILE_PATTERNS = 757 | 758 | 759 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 760 | # be searched for input files as well. 761 | # The default value is: NO. 762 | 763 | RECURSIVE = NO 764 | 765 | # The EXCLUDE tag can be used to specify files and/or directories that should be 766 | # excluded from the INPUT source files. This way you can easily exclude a 767 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 768 | # 769 | # Note that relative paths are relative to the directory from which doxygen is 770 | # run. 771 | 772 | EXCLUDE = 773 | 774 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 775 | # directories that are symbolic links (a Unix file system feature) are excluded 776 | # from the input. 777 | # The default value is: NO. 778 | 779 | EXCLUDE_SYMLINKS = NO 780 | 781 | # If the value of the INPUT tag contains directories, you can use the 782 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 783 | # certain files from those directories. 784 | # 785 | # Note that the wildcards are matched against the file with absolute path, so to 786 | # exclude all test directories for example use the pattern */test/* 787 | 788 | EXCLUDE_PATTERNS = 789 | 790 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 791 | # (namespaces, classes, functions, etc.) that should be excluded from the 792 | # output. The symbol name can be a fully qualified name, a word, or if the 793 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 794 | # AClass::ANamespace, ANamespace::*Test 795 | # 796 | # Note that the wildcards are matched against the file with absolute path, so to 797 | # exclude all test directories use the pattern */test/* 798 | 799 | EXCLUDE_SYMBOLS = 800 | 801 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 802 | # that contain example code fragments that are included (see the \include 803 | # command). 804 | 805 | EXAMPLE_PATH = 806 | 807 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 808 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 809 | # *.h) to filter out the source-files in the directories. If left blank all 810 | # files are included. 811 | 812 | EXAMPLE_PATTERNS = 813 | 814 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 815 | # searched for input files to be used with the \include or \dontinclude commands 816 | # irrespective of the value of the RECURSIVE tag. 817 | # The default value is: NO. 818 | 819 | EXAMPLE_RECURSIVE = NO 820 | 821 | # The IMAGE_PATH tag can be used to specify one or more files or directories 822 | # that contain images that are to be included in the documentation (see the 823 | # \image command). 824 | 825 | IMAGE_PATH = 826 | 827 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 828 | # invoke to filter for each input file. Doxygen will invoke the filter program 829 | # by executing (via popen()) the command: 830 | # 831 | # 832 | # 833 | # where is the value of the INPUT_FILTER tag, and is the 834 | # name of an input file. Doxygen will then use the output that the filter 835 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 836 | # will be ignored. 837 | # 838 | # Note that the filter must not add or remove lines; it is applied before the 839 | # code is scanned, but not when the output code is generated. If lines are added 840 | # or removed, the anchors will not be placed correctly. 841 | 842 | INPUT_FILTER = 843 | 844 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 845 | # basis. Doxygen will compare the file name with each pattern and apply the 846 | # filter if there is a match. The filters are a list of the form: pattern=filter 847 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 848 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 849 | # patterns match the file name, INPUT_FILTER is applied. 850 | 851 | FILTER_PATTERNS = 852 | 853 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 854 | # INPUT_FILTER ) will also be used to filter the input files that are used for 855 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 856 | # The default value is: NO. 857 | 858 | FILTER_SOURCE_FILES = NO 859 | 860 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 861 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 862 | # it is also possible to disable source filtering for a specific pattern using 863 | # *.ext= (so without naming a filter). 864 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 865 | 866 | FILTER_SOURCE_PATTERNS = 867 | 868 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 869 | # is part of the input, its contents will be placed on the main page 870 | # (index.html). This can be useful if you have a project on for instance GitHub 871 | # and want to reuse the introduction page also for the doxygen output. 872 | 873 | USE_MDFILE_AS_MAINPAGE = 874 | 875 | #--------------------------------------------------------------------------- 876 | # Configuration options related to source browsing 877 | #--------------------------------------------------------------------------- 878 | 879 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 880 | # generated. Documented entities will be cross-referenced with these sources. 881 | # 882 | # Note: To get rid of all source code in the generated output, make sure that 883 | # also VERBATIM_HEADERS is set to NO. 884 | # The default value is: NO. 885 | 886 | SOURCE_BROWSER = NO 887 | 888 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 889 | # classes and enums directly into the documentation. 890 | # The default value is: NO. 891 | 892 | INLINE_SOURCES = NO 893 | 894 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 895 | # special comment blocks from generated source code fragments. Normal C, C++ and 896 | # Fortran comments will always remain visible. 897 | # The default value is: YES. 898 | 899 | STRIP_CODE_COMMENTS = YES 900 | 901 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 902 | # function all documented functions referencing it will be listed. 903 | # The default value is: NO. 904 | 905 | REFERENCED_BY_RELATION = NO 906 | 907 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 908 | # all documented entities called/used by that function will be listed. 909 | # The default value is: NO. 910 | 911 | REFERENCES_RELATION = NO 912 | 913 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 914 | # to YES, then the hyperlinks from functions in REFERENCES_RELATION and 915 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 916 | # link to the documentation. 917 | # The default value is: YES. 918 | 919 | REFERENCES_LINK_SOURCE = YES 920 | 921 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 922 | # source code will show a tooltip with additional information such as prototype, 923 | # brief description and links to the definition and documentation. Since this 924 | # will make the HTML file larger and loading of large files a bit slower, you 925 | # can opt to disable this feature. 926 | # The default value is: YES. 927 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 928 | 929 | SOURCE_TOOLTIPS = YES 930 | 931 | # If the USE_HTAGS tag is set to YES then the references to source code will 932 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 933 | # source browser. The htags tool is part of GNU's global source tagging system 934 | # (see http://www.gnu.org/software/global/global.html). You will need version 935 | # 4.8.6 or higher. 936 | # 937 | # To use it do the following: 938 | # - Install the latest version of global 939 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 940 | # - Make sure the INPUT points to the root of the source tree 941 | # - Run doxygen as normal 942 | # 943 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 944 | # tools must be available from the command line (i.e. in the search path). 945 | # 946 | # The result: instead of the source browser generated by doxygen, the links to 947 | # source code will now point to the output of htags. 948 | # The default value is: NO. 949 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 950 | 951 | USE_HTAGS = NO 952 | 953 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 954 | # verbatim copy of the header file for each class for which an include is 955 | # specified. Set to NO to disable this. 956 | # See also: Section \class. 957 | # The default value is: YES. 958 | 959 | VERBATIM_HEADERS = YES 960 | 961 | #--------------------------------------------------------------------------- 962 | # Configuration options related to the alphabetical class index 963 | #--------------------------------------------------------------------------- 964 | 965 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 966 | # compounds will be generated. Enable this if the project contains a lot of 967 | # classes, structs, unions or interfaces. 968 | # The default value is: YES. 969 | 970 | ALPHABETICAL_INDEX = YES 971 | 972 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 973 | # which the alphabetical index list will be split. 974 | # Minimum value: 1, maximum value: 20, default value: 5. 975 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 976 | 977 | COLS_IN_ALPHA_INDEX = 5 978 | 979 | # In case all classes in a project start with a common prefix, all classes will 980 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 981 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 982 | # while generating the index headers. 983 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 984 | 985 | IGNORE_PREFIX = 986 | 987 | #--------------------------------------------------------------------------- 988 | # Configuration options related to the HTML output 989 | #--------------------------------------------------------------------------- 990 | 991 | # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 992 | # The default value is: YES. 993 | 994 | GENERATE_HTML = YES 995 | 996 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 997 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 998 | # it. 999 | # The default directory is: html. 1000 | # This tag requires that the tag GENERATE_HTML is set to YES. 1001 | 1002 | HTML_OUTPUT = html 1003 | 1004 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1005 | # generated HTML page (for example: .htm, .php, .asp). 1006 | # The default value is: .html. 1007 | # This tag requires that the tag GENERATE_HTML is set to YES. 1008 | 1009 | HTML_FILE_EXTENSION = .html 1010 | 1011 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1012 | # each generated HTML page. If the tag is left blank doxygen will generate a 1013 | # standard header. 1014 | # 1015 | # To get valid HTML the header file that includes any scripts and style sheets 1016 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1017 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1018 | # default header using 1019 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1020 | # YourConfigFile 1021 | # and then modify the file new_header.html. See also section "Doxygen usage" 1022 | # for information on how to generate the default header that doxygen normally 1023 | # uses. 1024 | # Note: The header is subject to change so you typically have to regenerate the 1025 | # default header when upgrading to a newer version of doxygen. For a description 1026 | # of the possible markers and block names see the documentation. 1027 | # This tag requires that the tag GENERATE_HTML is set to YES. 1028 | 1029 | HTML_HEADER = 1030 | 1031 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1032 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1033 | # footer. See HTML_HEADER for more information on how to generate a default 1034 | # footer and what special commands can be used inside the footer. See also 1035 | # section "Doxygen usage" for information on how to generate the default footer 1036 | # that doxygen normally uses. 1037 | # This tag requires that the tag GENERATE_HTML is set to YES. 1038 | 1039 | HTML_FOOTER = 1040 | 1041 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1042 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1043 | # the HTML output. If left blank doxygen will generate a default style sheet. 1044 | # See also section "Doxygen usage" for information on how to generate the style 1045 | # sheet that doxygen normally uses. 1046 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1047 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1048 | # obsolete. 1049 | # This tag requires that the tag GENERATE_HTML is set to YES. 1050 | 1051 | HTML_STYLESHEET = 1052 | 1053 | # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- 1054 | # defined cascading style sheet that is included after the standard style sheets 1055 | # created by doxygen. Using this option one can overrule certain style aspects. 1056 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1057 | # standard style sheet and is therefor more robust against future updates. 1058 | # Doxygen will copy the style sheet file to the output directory. For an example 1059 | # see the documentation. 1060 | # This tag requires that the tag GENERATE_HTML is set to YES. 1061 | 1062 | HTML_EXTRA_STYLESHEET = 1063 | 1064 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1065 | # other source files which should be copied to the HTML output directory. Note 1066 | # that these files will be copied to the base HTML output directory. Use the 1067 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1068 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1069 | # files will be copied as-is; there are no commands or markers available. 1070 | # This tag requires that the tag GENERATE_HTML is set to YES. 1071 | 1072 | HTML_EXTRA_FILES = 1073 | 1074 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1075 | # will adjust the colors in the stylesheet and background images according to 1076 | # this color. Hue is specified as an angle on a colorwheel, see 1077 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1078 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1079 | # purple, and 360 is red again. 1080 | # Minimum value: 0, maximum value: 359, default value: 220. 1081 | # This tag requires that the tag GENERATE_HTML is set to YES. 1082 | 1083 | HTML_COLORSTYLE_HUE = 220 1084 | 1085 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1086 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1087 | # value of 255 will produce the most vivid colors. 1088 | # Minimum value: 0, maximum value: 255, default value: 100. 1089 | # This tag requires that the tag GENERATE_HTML is set to YES. 1090 | 1091 | HTML_COLORSTYLE_SAT = 100 1092 | 1093 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1094 | # luminance component of the colors in the HTML output. Values below 100 1095 | # gradually make the output lighter, whereas values above 100 make the output 1096 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1097 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1098 | # change the gamma. 1099 | # Minimum value: 40, maximum value: 240, default value: 80. 1100 | # This tag requires that the tag GENERATE_HTML is set to YES. 1101 | 1102 | HTML_COLORSTYLE_GAMMA = 80 1103 | 1104 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1105 | # page will contain the date and time when the page was generated. Setting this 1106 | # to NO can help when comparing the output of multiple runs. 1107 | # The default value is: YES. 1108 | # This tag requires that the tag GENERATE_HTML is set to YES. 1109 | 1110 | HTML_TIMESTAMP = YES 1111 | 1112 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1113 | # documentation will contain sections that can be hidden and shown after the 1114 | # page has loaded. 1115 | # The default value is: NO. 1116 | # This tag requires that the tag GENERATE_HTML is set to YES. 1117 | 1118 | HTML_DYNAMIC_SECTIONS = NO 1119 | 1120 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1121 | # shown in the various tree structured indices initially; the user can expand 1122 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1123 | # such a level that at most the specified number of entries are visible (unless 1124 | # a fully collapsed tree already exceeds this amount). So setting the number of 1125 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1126 | # representing an infinite number of entries and will result in a full expanded 1127 | # tree by default. 1128 | # Minimum value: 0, maximum value: 9999, default value: 100. 1129 | # This tag requires that the tag GENERATE_HTML is set to YES. 1130 | 1131 | HTML_INDEX_NUM_ENTRIES = 100 1132 | 1133 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1134 | # generated that can be used as input for Apple's Xcode 3 integrated development 1135 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1136 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1137 | # Makefile in the HTML output directory. Running make will produce the docset in 1138 | # that directory and running make install will install the docset in 1139 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1140 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1141 | # for more information. 1142 | # The default value is: NO. 1143 | # This tag requires that the tag GENERATE_HTML is set to YES. 1144 | 1145 | GENERATE_DOCSET = NO 1146 | 1147 | # This tag determines the name of the docset feed. A documentation feed provides 1148 | # an umbrella under which multiple documentation sets from a single provider 1149 | # (such as a company or product suite) can be grouped. 1150 | # The default value is: Doxygen generated docs. 1151 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1152 | 1153 | DOCSET_FEEDNAME = "Doxygen generated docs" 1154 | 1155 | # This tag specifies a string that should uniquely identify the documentation 1156 | # set bundle. This should be a reverse domain-name style string, e.g. 1157 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1158 | # The default value is: org.doxygen.Project. 1159 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1160 | 1161 | DOCSET_BUNDLE_ID = org.doxygen.Project 1162 | 1163 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1164 | # the documentation publisher. This should be a reverse domain-name style 1165 | # string, e.g. com.mycompany.MyDocSet.documentation. 1166 | # The default value is: org.doxygen.Publisher. 1167 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1168 | 1169 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1170 | 1171 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1172 | # The default value is: Publisher. 1173 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1174 | 1175 | DOCSET_PUBLISHER_NAME = Publisher 1176 | 1177 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1178 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1179 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1180 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1181 | # Windows. 1182 | # 1183 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1184 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1185 | # files are now used as the Windows 98 help format, and will replace the old 1186 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1187 | # HTML files also contain an index, a table of contents, and you can search for 1188 | # words in the documentation. The HTML workshop also contains a viewer for 1189 | # compressed HTML files. 1190 | # The default value is: NO. 1191 | # This tag requires that the tag GENERATE_HTML is set to YES. 1192 | 1193 | GENERATE_HTMLHELP = NO 1194 | 1195 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1196 | # file. You can add a path in front of the file if the result should not be 1197 | # written to the html output directory. 1198 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1199 | 1200 | CHM_FILE = 1201 | 1202 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1203 | # including file name) of the HTML help compiler ( hhc.exe). If non-empty 1204 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1205 | # The file has to be specified with full path. 1206 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1207 | 1208 | HHC_LOCATION = 1209 | 1210 | # The GENERATE_CHI flag controls if a separate .chi index file is generated ( 1211 | # YES) or that it should be included in the master .chm file ( NO). 1212 | # The default value is: NO. 1213 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1214 | 1215 | GENERATE_CHI = NO 1216 | 1217 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) 1218 | # and project file content. 1219 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1220 | 1221 | CHM_INDEX_ENCODING = 1222 | 1223 | # The BINARY_TOC flag controls whether a binary table of contents is generated ( 1224 | # YES) or a normal table of contents ( NO) in the .chm file. 1225 | # The default value is: NO. 1226 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1227 | 1228 | BINARY_TOC = NO 1229 | 1230 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1231 | # the table of contents of the HTML help documentation and to the tree view. 1232 | # The default value is: NO. 1233 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1234 | 1235 | TOC_EXPAND = NO 1236 | 1237 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1238 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1239 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1240 | # (.qch) of the generated HTML documentation. 1241 | # The default value is: NO. 1242 | # This tag requires that the tag GENERATE_HTML is set to YES. 1243 | 1244 | GENERATE_QHP = NO 1245 | 1246 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1247 | # the file name of the resulting .qch file. The path specified is relative to 1248 | # the HTML output folder. 1249 | # This tag requires that the tag GENERATE_QHP is set to YES. 1250 | 1251 | QCH_FILE = 1252 | 1253 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1254 | # Project output. For more information please see Qt Help Project / Namespace 1255 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1256 | # The default value is: org.doxygen.Project. 1257 | # This tag requires that the tag GENERATE_QHP is set to YES. 1258 | 1259 | QHP_NAMESPACE = org.doxygen.Project 1260 | 1261 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1262 | # Help Project output. For more information please see Qt Help Project / Virtual 1263 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1264 | # folders). 1265 | # The default value is: doc. 1266 | # This tag requires that the tag GENERATE_QHP is set to YES. 1267 | 1268 | QHP_VIRTUAL_FOLDER = doc 1269 | 1270 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1271 | # filter to add. For more information please see Qt Help Project / Custom 1272 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1273 | # filters). 1274 | # This tag requires that the tag GENERATE_QHP is set to YES. 1275 | 1276 | QHP_CUST_FILTER_NAME = 1277 | 1278 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1279 | # custom filter to add. For more information please see Qt Help Project / Custom 1280 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1281 | # filters). 1282 | # This tag requires that the tag GENERATE_QHP is set to YES. 1283 | 1284 | QHP_CUST_FILTER_ATTRS = 1285 | 1286 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1287 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1288 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1289 | # This tag requires that the tag GENERATE_QHP is set to YES. 1290 | 1291 | QHP_SECT_FILTER_ATTRS = 1292 | 1293 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1294 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1295 | # generated .qhp file. 1296 | # This tag requires that the tag GENERATE_QHP is set to YES. 1297 | 1298 | QHG_LOCATION = 1299 | 1300 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1301 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1302 | # install this plugin and make it available under the help contents menu in 1303 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1304 | # to be copied into the plugins directory of eclipse. The name of the directory 1305 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1306 | # After copying Eclipse needs to be restarted before the help appears. 1307 | # The default value is: NO. 1308 | # This tag requires that the tag GENERATE_HTML is set to YES. 1309 | 1310 | GENERATE_ECLIPSEHELP = NO 1311 | 1312 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1313 | # the directory name containing the HTML and XML files should also have this 1314 | # name. Each documentation set should have its own identifier. 1315 | # The default value is: org.doxygen.Project. 1316 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1317 | 1318 | ECLIPSE_DOC_ID = org.doxygen.Project 1319 | 1320 | # If you want full control over the layout of the generated HTML pages it might 1321 | # be necessary to disable the index and replace it with your own. The 1322 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1323 | # of each HTML page. A value of NO enables the index and the value YES disables 1324 | # it. Since the tabs in the index contain the same information as the navigation 1325 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1326 | # The default value is: NO. 1327 | # This tag requires that the tag GENERATE_HTML is set to YES. 1328 | 1329 | DISABLE_INDEX = NO 1330 | 1331 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1332 | # structure should be generated to display hierarchical information. If the tag 1333 | # value is set to YES, a side panel will be generated containing a tree-like 1334 | # index structure (just like the one that is generated for HTML Help). For this 1335 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1336 | # (i.e. any modern browser). Windows users are probably better off using the 1337 | # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can 1338 | # further fine-tune the look of the index. As an example, the default style 1339 | # sheet generated by doxygen has an example that shows how to put an image at 1340 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1341 | # the same information as the tab index, you could consider setting 1342 | # DISABLE_INDEX to YES when enabling this option. 1343 | # The default value is: NO. 1344 | # This tag requires that the tag GENERATE_HTML is set to YES. 1345 | 1346 | GENERATE_TREEVIEW = NO 1347 | 1348 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1349 | # doxygen will group on one line in the generated HTML documentation. 1350 | # 1351 | # Note that a value of 0 will completely suppress the enum values from appearing 1352 | # in the overview section. 1353 | # Minimum value: 0, maximum value: 20, default value: 4. 1354 | # This tag requires that the tag GENERATE_HTML is set to YES. 1355 | 1356 | ENUM_VALUES_PER_LINE = 4 1357 | 1358 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1359 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1360 | # Minimum value: 0, maximum value: 1500, default value: 250. 1361 | # This tag requires that the tag GENERATE_HTML is set to YES. 1362 | 1363 | TREEVIEW_WIDTH = 250 1364 | 1365 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to 1366 | # external symbols imported via tag files in a separate window. 1367 | # The default value is: NO. 1368 | # This tag requires that the tag GENERATE_HTML is set to YES. 1369 | 1370 | EXT_LINKS_IN_WINDOW = NO 1371 | 1372 | # Use this tag to change the font size of LaTeX formulas included as images in 1373 | # the HTML documentation. When you change the font size after a successful 1374 | # doxygen run you need to manually remove any form_*.png images from the HTML 1375 | # output directory to force them to be regenerated. 1376 | # Minimum value: 8, maximum value: 50, default value: 10. 1377 | # This tag requires that the tag GENERATE_HTML is set to YES. 1378 | 1379 | FORMULA_FONTSIZE = 10 1380 | 1381 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1382 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1383 | # supported properly for IE 6.0, but are supported on all modern browsers. 1384 | # 1385 | # Note that when changing this option you need to delete any form_*.png files in 1386 | # the HTML output directory before the changes have effect. 1387 | # The default value is: YES. 1388 | # This tag requires that the tag GENERATE_HTML is set to YES. 1389 | 1390 | FORMULA_TRANSPARENT = YES 1391 | 1392 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1393 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1394 | # instead of using prerendered bitmaps. Use this if you do not have LaTeX 1395 | # installed or if you want to formulas look prettier in the HTML output. When 1396 | # enabled you may also need to install MathJax separately and configure the path 1397 | # to it using the MATHJAX_RELPATH option. 1398 | # The default value is: NO. 1399 | # This tag requires that the tag GENERATE_HTML is set to YES. 1400 | 1401 | USE_MATHJAX = NO 1402 | 1403 | # When MathJax is enabled you can set the default output format to be used for 1404 | # the MathJax output. See the MathJax site (see: 1405 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1406 | # Possible values are: HTML-CSS (which is slower, but has the best 1407 | # compatibility), NativeMML (i.e. MathML) and SVG. 1408 | # The default value is: HTML-CSS. 1409 | # This tag requires that the tag USE_MATHJAX is set to YES. 1410 | 1411 | MATHJAX_FORMAT = HTML-CSS 1412 | 1413 | # When MathJax is enabled you need to specify the location relative to the HTML 1414 | # output directory using the MATHJAX_RELPATH option. The destination directory 1415 | # should contain the MathJax.js script. For instance, if the mathjax directory 1416 | # is located at the same level as the HTML output directory, then 1417 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1418 | # Content Delivery Network so you can quickly see the result without installing 1419 | # MathJax. However, it is strongly recommended to install a local copy of 1420 | # MathJax from http://www.mathjax.org before deployment. 1421 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1422 | # This tag requires that the tag USE_MATHJAX is set to YES. 1423 | 1424 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1425 | 1426 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1427 | # extension names that should be enabled during MathJax rendering. For example 1428 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1429 | # This tag requires that the tag USE_MATHJAX is set to YES. 1430 | 1431 | MATHJAX_EXTENSIONS = 1432 | 1433 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1434 | # of code that will be used on startup of the MathJax code. See the MathJax site 1435 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1436 | # example see the documentation. 1437 | # This tag requires that the tag USE_MATHJAX is set to YES. 1438 | 1439 | MATHJAX_CODEFILE = 1440 | 1441 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1442 | # the HTML output. The underlying search engine uses javascript and DHTML and 1443 | # should work on any modern browser. Note that when using HTML help 1444 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1445 | # there is already a search function so this one should typically be disabled. 1446 | # For large projects the javascript based search engine can be slow, then 1447 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1448 | # search using the keyboard; to jump to the search box use + S 1449 | # (what the is depends on the OS and browser, but it is typically 1450 | # , /