├── .buildscript └── deploy_snapshot.sh ├── .gitignore ├── .travis.yml ├── CHANGELOG.md ├── LICENSE ├── README.md ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src ├── main └── groovy │ └── com │ └── vanniktech │ └── android │ └── javadoc │ ├── Generation.groovy │ └── extensions │ └── AndroidJavadocExtension.groovy └── test └── groovy └── com └── vanniktech └── android └── javadoc └── GenerationTest.groovy /.buildscript/deploy_snapshot.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | # Deploy a jar, source jar, and javadoc jar to Sonatype's snapshot repo. 4 | # 5 | # Adapted from https://coderwall.com/p/9b_lfq and 6 | # http://benlimmer.com/2013/12/26/automatically-publish-javadoc-to-gh-pages-with-travis-ci/ and 7 | # https://github.com/JakeWharton/RxBinding/blob/master/.buildscript/deploy_snapshot.sh 8 | 9 | SLUG="vanniktech/gradle-android-javadoc-plugin" 10 | JDK="oraclejdk8" 11 | BRANCH="master" 12 | 13 | set -e 14 | 15 | if [ "$TRAVIS_REPO_SLUG" != "$SLUG" ]; then 16 | echo "Skipping snapshot deployment: wrong repository. Expected '$SLUG' but was '$TRAVIS_REPO_SLUG'." 17 | elif [ "$TRAVIS_JDK_VERSION" != "$JDK" ]; then 18 | echo "Skipping snapshot deployment: wrong JDK. Expected '$JDK' but was '$TRAVIS_JDK_VERSION'." 19 | elif [ "$TRAVIS_PULL_REQUEST" != "false" ]; then 20 | echo "Skipping snapshot deployment: was pull request." 21 | elif [ "$TRAVIS_BRANCH" != "$BRANCH" ]; then 22 | echo "Skipping snapshot deployment: wrong branch. Expected '$BRANCH' but was '$TRAVIS_BRANCH'." 23 | else 24 | echo "Deploying snapshot..." 25 | ./gradlew uploadArchives 26 | echo "Snapshot deployed!" 27 | fi -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | build/ 3 | 4 | # Ignore Gradle GUI config 5 | gradle-app.setting 6 | 7 | # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) 8 | !gradle-wrapper.jar 9 | 10 | local.properties 11 | 12 | .idea/ 13 | *.iml 14 | .gradletasknamecache -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: android 2 | 3 | jdk: oraclejdk8 4 | 5 | before_install: 6 | # Download SDK 7 | - yes | sdkmanager "tools" &>/dev/null 8 | - yes | sdkmanager "platform-tools" &>/dev/null 9 | - yes | sdkmanager "build-tools;28.0.3" &>/dev/null 10 | - yes | sdkmanager "platforms;android-28" &>/dev/null 11 | # Update remaining dependencies and accept licenses 12 | - yes | sdkmanager --update &>/dev/null 13 | - yes | sdkmanager --licenses &>/dev/null 14 | 15 | script: ./gradlew clean build 16 | 17 | after_success: 18 | - bash <(curl -s https://codecov.io/bash) 19 | - .buildscript/deploy_snapshot.sh 20 | 21 | env: 22 | global: 23 | - secure: "MzOFFRAE6bEO5NzGQBFQ1am0lHwbsWqRdP/OTL/Ka/QgjryIETiLZdNUua23DwcJMuiMKVR0I03lqW5PCF0yT1+R8KECncF1P61YrHtATr0KhfXJ/z3DcqtxsBJ4gtVEJfuBXCgdHyYbMmS6UJVMgejCqv4YKYQggtOe/wgNm0PjwPOEQ7aktz47yEUbQOr9jxNwYDLNGzbgc9oBt+rFFYY+EfcbLQrrfq6sMyioc9c8UqNESRcAgapptwnywofd1fbgSvZ1kYpwD9scPcFgZFiG7KzNyxU0/GL2ojAT3buZFYKEToAFLTKFdHJTzwMMlUOMFoW4FB/aMlObvCcaguuMhkoD8ApaJg9Y3YLTkUzBDc6AvIvg4MwoujP6NawJJZEinG1EtuKc577WtXIpaA700s+m/go/Bsel27TUIFWnPQiPUyuyUoHvd/1xI2d1EWKZjudeaHTIhv5N8Y1W3Lb2AriSZ2ijK22I4QnrikDv1iWTaPYr8EGJbOOp4ifldLEpBJZSk8Eqv40ow5nSPNc8wmQ5Zd38wgp/qY0ZBgVOtKAUzi4t6K2hyTr7gIZ1fKyhYrIZuQFluLnQAzHQcNZM/Hlf5c9DS6tdJhSYBFbqzSlZ7UL3E98+3MZ9Bc15Z8HTlGrw1NTbLrAgpmE12PJN+oBR5U+Hay5VOJIpu+w=" 24 | - secure: "rhhkm3u4m9kZuDJQAtGIEW8kvwIb25bDnBJgmMR7HwCZhju1TT9nfe7kK630dj4fdVfyb9yBxHsdVRxyz8OeqxHMh0GfanJNs0rAH9aqIwXfGc8Qv7kFq9fjKojRIObvRR/0N/gJ2WXwmat7iM8AtUvNtj/hTXEcl1dd3Th9inLbuG57eS/5jT4n9czJ8Wg9nZfHXePlCFTJDEnyvmatAHvkR3CsvzUVclXGQAvw2MGA6QqXOnPDGYKX2z5scePsU0awOg0q2+H2zs2wHsyZnIf2Jn/gngWF8ij2GcVSxreX7hDBAaBhcm6KXejr81WT9sQaMCQUfFZhEo2+P86f0p2JkW1gub9h7VUQhMU1LZSHhFEWBfuNAYN2iboRJOxp7lBcTQEup+3L3mFhdwQe4f5rHyTK1t7doj+4+SLQoOmyaoTLIdZzafeQzv6JYMuJRbtDsTWSzPMzMtjzBBBC2qzVNuHiXxypNTjeOAJKDNwn5YhubTro5z5KeuM1D8/gb1TKFXOpOBUu1SJPu5CeuaP6U9D/0rny6QL2bC114qJNLTnWqEHk58lIVC/sVrWd3uxWFph6rUUEM0wgC9Uz2y2iye8OauamgfN5RP7e2ETR0NnI9USik/KuKD1MhVMh8A3q2GyaMMTEFg20dhJP40hRntb0sUxv0DW/sqIWp9I=" 25 | 26 | branches: 27 | except: 28 | - gh-pages 29 | 30 | notifications: 31 | email: false 32 | 33 | before_cache: 34 | - rm -f $HOME/.gradle/caches/modules-2/modules-2.lock 35 | - rm -fr $HOME/.gradle/caches/*/plugin-resolution/ 36 | cache: 37 | directories: 38 | - $HOME/.gradle/caches/ 39 | - $HOME/.gradle/wrapper/ 40 | - $HOME/.android/build-cache 41 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | Version 0.4.0 *(In development)* 4 | -------------------------------- 5 | 6 | Version 0.3.0 *(2018-07-16)* 7 | ---------------------------- 8 | 9 | - Unify setup, improve a few things and bump versions. [\#59](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/59) ([vanniktech](https://github.com/vanniktech)) 10 | - Use Gradle Maven Publish Plugin for publishing. [\#58](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/58) ([vanniktech](https://github.com/vanniktech)) 11 | - Remove need of project.afterEvaluate\(\) and add generateJavadoc macro task [\#57](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/57) ([bastienpaulfr](https://github.com/bastienpaulfr)) 12 | - Slight README modifications. [\#51](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/51) ([vanniktech](https://github.com/vanniktech)) 13 | - Travis after\_success: First codecov then SNAPSHOT publishing. [\#38](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/38) ([vanniktech](https://github.com/vanniktech)) 14 | - Delete codecov yml file. [\#37](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/37) ([vanniktech](https://github.com/vanniktech)) 15 | - \[FEATURE\] Add and improve javadoc tasks [\#33](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/33) ([bastienpaulfr](https://github.com/bastienpaulfr)) 16 | - Fix Travis after\_success. [\#26](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/26) ([vanniktech](https://github.com/vanniktech)) 17 | - Add Codecov file [\#24](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/24) ([vanniktech](https://github.com/vanniktech)) 18 | - Add Codecov Coverage [\#20](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/20) ([vanniktech](https://github.com/vanniktech)) 19 | - Add .m2 directory Travis Cache [\#19](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/19) ([vanniktech](https://github.com/vanniktech)) 20 | - Some more basic tests \(more tests need to be built upon them\) [\#14](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/14) ([vanniktech](https://github.com/vanniktech)) 21 | - Reuse upload properties from gradle.properties for Gradle Plugin upload [\#13](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/13) ([vanniktech](https://github.com/vanniktech)) 22 | - GenerateJavadoc tasks do have goup Documentation. Fixes \#8 [\#10](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/10) ([vanniktech](https://github.com/vanniktech)) 23 | - Add Java 1.7 source compatibility. Fixes \#7 [\#9](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/9) ([vanniktech](https://github.com/vanniktech)) 24 | - Configure Travis: branches, notifications & sudo [\#6](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/6) ([vanniktech](https://github.com/vanniktech)) 25 | - Add auto snapshot deployment. Fixes \#3 [\#5](https://github.com/vanniktech/gradle-android-javadoc-plugin/pull/5) ([vanniktech](https://github.com/vanniktech)) 26 | 27 | Version 0.2.1 *(2015-10-06)* 28 | ---------------------------- 29 | 30 | - Fix minor bug in plugin (Missing property) 31 | 32 | Version 0.2.0 *(2015-10-05)* 33 | ---------------------------- 34 | 35 | - Fix [\#1](https://github.com/vanniktech/gradle-android-javadoc-plugin/issues/1). New plugin which can handle app and library 36 | 37 | Version 0.1.0 *(2015-10-04)* 38 | ---------------------------- 39 | 40 | - Initial version -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gradle-android-javadoc-plugin 2 | 3 | Gradle plugin that generates Java Documentation from an Android Gradle project. 4 | 5 | # Set up 6 | 7 | **app/build.gradle** or **library/build.gradle** 8 | 9 | ```gradle 10 | buildscript { 11 | repositories { 12 | mavenCentral() 13 | } 14 | dependencies { 15 | classpath "com.vanniktech:gradle-android-javadoc-plugin:0.3.0" 16 | } 17 | } 18 | 19 | apply plugin: "com.vanniktech.android.javadoc" 20 | ``` 21 | 22 | Information: [This plugin is also available on Gradle plugins](https://plugins.gradle.org/plugin/com.vanniktech.android.javadoc) 23 | 24 | ### Snapshot 25 | 26 | ```gradle 27 | buildscript { 28 | repositories { 29 | maven { url "https://oss.sonatype.org/content/repositories/snapshots" } 30 | } 31 | dependencies { 32 | classpath "com.vanniktech:gradle-android-javadoc-plugin:0.4.0-SNAPSHOT" 33 | } 34 | } 35 | 36 | apply plugin: "com.vanniktech.android.javadoc" 37 | ``` 38 | 39 | ## Get Javadoc 40 | 41 | ```gradle 42 | ./gradlew generateDebugJavadoc 43 | ./gradlew generateReleaseJavadoc 44 | ``` 45 | 46 | or to run javadoc task for all variants : 47 | 48 | ```gradle 49 | ./gradlew generateJavadoc 50 | ``` 51 | 52 | **HTML reports** 53 | 54 | ``` 55 | /build/docs/javadoc/debug/index.html 56 | /build/docs/javadoc/release/index.html 57 | ``` 58 | 59 | ## Get Javadoc archive 60 | 61 | ``` 62 | ./gradlew generateDebugJavadocJar 63 | ./gradlew generateReleaseJavadocJar 64 | ``` 65 | 66 | or to run javadoc archive task for all variants : 67 | 68 | ```gradle 69 | ./gradlew generateJavadocJar 70 | ``` 71 | 72 | ## Customize Plugin 73 | 74 | ```groovy 75 | androidJavadoc { 76 | // variantFilter takes a closure that received an Android variant as parameter. 77 | // Return true to generate javadoc task for this variant, false to do nothing 78 | // This is the default closure : 79 | variantFilter { variant -> 80 | if (variant) { 81 | return true 82 | } else { 83 | return false 84 | } 85 | } 86 | 87 | // taskNameTransformer takes a closure to customise the task name. 88 | // Task name pattern is "generate${taskNameTransformer(variant).capitalize()}Javadoc" 89 | // This is the default implementation : 90 | taskNameTransformer { variant -> 91 | variant.name 92 | } 93 | 94 | // outputDir return the documentation output dir 95 | // Default implementation : 96 | outputDir = { Project project -> 97 | "${project.buildDir}/docs/javadoc/" 98 | } 99 | } 100 | ``` 101 | 102 | # License 103 | 104 | Copyright (C) 2015 Vanniktech - Niklas Baudy 105 | 106 | Licensed under the Apache License, Version 2.0 -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | GROUP=com.vanniktech 2 | VERSION_NAME=0.4.0-SNAPSHOT 3 | 4 | POM_ARTIFACT_ID=gradle-android-javadoc-plugin 5 | POM_NAME=Gradle Android Javadoc Plugin 6 | POM_PACKAGING=jar 7 | 8 | POM_DESCRIPTION=Gradle plugin that generates Java Documentation from an Android Gradle project. 9 | POM_INCEPTION_YEAR=2015 10 | 11 | POM_URL=http://github.com/vanniktech/gradle-android-javadoc-plugin/ 12 | POM_SCM_URL=http://github.com/vanniktech/gradle-android-javadoc-plugin/ 13 | POM_SCM_CONNECTION=scm:git:git://github.com/vanniktech/gradle-android-javadoc-plugin.git 14 | POM_SCM_DEV_CONNECTION=scm:git:ssh://git@github.com/vanniktech/gradle-android-javadoc-plugin.git 15 | 16 | POM_LICENCE_NAME=The Apache Software License, Version 2.0 17 | POM_LICENCE_URL=http://www.apache.org/licenses/LICENSE-2.0.txt 18 | POM_LICENCE_DIST=repo 19 | 20 | POM_DEVELOPER_ID=vanniktech 21 | POM_DEVELOPER_NAME=Niklas Baudy -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vanniktech/gradle-android-javadoc-plugin/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.1-all.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 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 | rootProject.name = 'gradle-android-javadoc-plugin' -------------------------------------------------------------------------------- /src/main/groovy/com/vanniktech/android/javadoc/Generation.groovy: -------------------------------------------------------------------------------- 1 | package com.vanniktech.android.javadoc 2 | 3 | import com.android.build.gradle.BasePlugin 4 | import com.android.build.gradle.api.BaseVariant 5 | import com.vanniktech.android.javadoc.extensions.AndroidJavadocExtension 6 | import org.gradle.api.DomainObjectCollection 7 | import org.gradle.api.JavaVersion 8 | import org.gradle.api.Plugin 9 | import org.gradle.api.Project 10 | import org.gradle.api.logging.Logger 11 | import org.gradle.api.tasks.Delete 12 | import org.gradle.api.tasks.TaskProvider 13 | import org.gradle.api.tasks.bundling.Jar 14 | import org.gradle.api.tasks.javadoc.Javadoc 15 | import org.gradle.external.javadoc.JavadocMemberLevel 16 | 17 | import javax.annotation.Nullable 18 | 19 | class Generation implements Plugin { 20 | 21 | private static final String JAVADOC_TASK = "generateJavadoc" 22 | private static final String JAVADOC_JAR_TASK = "generateJavadocJar" 23 | 24 | Logger logger 25 | 26 | @Override 27 | void apply(final Project project) { 28 | if (!project) { 29 | throw new UnsupportedOperationException("Project is null") 30 | } 31 | logger = project.getLogger() 32 | 33 | project.extensions.create("androidJavadoc", AndroidJavadocExtension) 34 | 35 | def hasSubProjects = project.subprojects.size() > 0 36 | 37 | if (hasSubProjects) { 38 | project.subprojects { subProject -> 39 | applyPlugin(subProject) 40 | } 41 | } else { 42 | applyPlugin(project) 43 | } 44 | } 45 | 46 | private void applyPlugin(Project project) { 47 | if (project.hasProperty('android')) { 48 | applyPluginToProject(project) 49 | } else { 50 | // Waiting for android plugin to be applied 51 | project.plugins.whenPluginAdded { Plugin plugin -> 52 | if (plugin instanceof BasePlugin) { 53 | applyPluginToProject(project) 54 | } 55 | } 56 | } 57 | } 58 | 59 | private void applyPluginToProject(Project project) { 60 | if (project.android.hasProperty('applicationVariants')) { 61 | createRootTask(project) 62 | addJavaTaskToProjectWith(project, (DomainObjectCollection) project.android.applicationVariants) 63 | } else if (project.android.hasProperty('libraryVariants')) { 64 | createRootTask(project) 65 | addJavaTaskToProjectWith(project, (DomainObjectCollection) project.android.libraryVariants) 66 | } else { 67 | // Do not throw exception anymore to support big projects with a lot of modules that not all of them are android. 68 | logger.info "${project.name} has no application or library variant - plugin is not applied" 69 | } 70 | } 71 | 72 | private void createRootTask(Project project) { 73 | def javadoc 74 | try { 75 | javadoc = project.tasks.named(JAVADOC_TASK) 76 | logger.debug "task $JAVADOC_TASK already exists" 77 | } catch (Exception ignored) { 78 | javadoc = project.tasks.register(JAVADOC_TASK) { 79 | description = "Generates javadoc for ${project.name}" 80 | group = 'Documentation' 81 | } 82 | } 83 | 84 | def javadocJar 85 | try { 86 | javadocJar = project.tasks.named(JAVADOC_JAR_TASK) 87 | logger.debug "task $JAVADOC_JAR_TASK already exists" 88 | } catch (Exception ignored) { 89 | javadocJar = project.tasks.register(JAVADOC_JAR_TASK) { 90 | description = "Generates javadoc for ${project.name}" 91 | group = 'Documentation' 92 | } 93 | } 94 | 95 | javadocJar.configure { 96 | dependsOn javadoc 97 | } 98 | } 99 | 100 | private void addJavaTaskToProjectWith(final Project project, final DomainObjectCollection variants) { 101 | variants.all { variant -> 102 | // Apply a filter because javadoc could be configured for only some particular variants. 103 | if (project.androidJavadoc.variantFilter(variant)) { 104 | createTask(project, variant) 105 | addDeleteJavadocTaskToCleanTaskIn(project, variant) 106 | } else { 107 | logger.debug "Do not create task for ${variant.name} because it has been filtered out" 108 | } 109 | } 110 | } 111 | 112 | private void createTask(final Project project, variant) { 113 | // Get task's name according to android variant. 114 | String taskName = genJavadocTaskName(project, variant) 115 | 116 | logger.debug "Create task ${taskName} for project ${project.name}, variant ${variant.name}" 117 | // We are creating the task with the same name only once. This is a protection if task already exists 118 | // because the name of the task is configurable and can be the same for several variants. 119 | if (findTask(project, taskName)) { 120 | logger.debug "task $taskName already exists" 121 | } else { 122 | TaskProvider javadocTask = createJavadocTask(project, variant, taskName) 123 | TaskProvider javadocArchiveTask = createJavadocArchiveTask(project, variant, genJavadocJarTaskName(project, variant)) 124 | javadocArchiveTask.configure { 125 | dependsOn javadocTask 126 | } 127 | findTask(project, JAVADOC_TASK).configure { 128 | dependsOn javadocTask 129 | } 130 | findTask(project, JAVADOC_JAR_TASK).configure { 131 | dependsOn javadocArchiveTask 132 | } 133 | } 134 | } 135 | 136 | private TaskProvider createJavadocTask(final Project project, variant, String taskName) { 137 | project.tasks.register(taskName, Javadoc) { 138 | title = "Documentation for ${project.name} at version ${project.android.defaultConfig.versionName}" 139 | description = "Generates javadoc for $variant.name variant." 140 | group = 'Documentation' 141 | 142 | destinationDir = getJavadocFolder(project, variant) 143 | source = variant.sourceSets.collect { it.java.sourceFiles }.inject { m, i -> m + i } 144 | 145 | // Fix issue : Error: Can not create variant 'android-lint' after configuration ': library: debugRuntimeElements' has been resolved 146 | doFirst { 147 | classpath = project.files(variant.javaCompileProvider.get().classpath.files, 148 | project.android.getBootClasspath()) 149 | } 150 | 151 | if (JavaVersion.current().isJava8Compatible()) { 152 | options.addStringOption('Xdoclint:none', '-quiet') 153 | } 154 | options.memberLevel = JavadocMemberLevel.PROTECTED 155 | options.links("http://docs.oracle.com/javase/7/docs/api/") 156 | options.links("http://developer.android.com/reference/") 157 | exclude '**/BuildConfig.java' 158 | exclude '**/R.java' 159 | } 160 | } 161 | 162 | private TaskProvider createJavadocArchiveTask(Project project, variant, String taskName) { 163 | project.tasks.register(taskName, Jar) { 164 | description = "Compress javadoc for $variant.name variant." 165 | group = "Documentation" 166 | classifier = 'javadoc' 167 | from getJavadocFolder(project, variant) 168 | into "" 169 | baseName = "${project.name}-${project.android.defaultConfig.versionName}-${getBaseTaskName(project, variant)}" 170 | extension = "jar" 171 | manifest = null 172 | } 173 | } 174 | 175 | private void addDeleteJavadocTaskToCleanTaskIn(final Project project, variant) { 176 | String taskName = genDeleteTaskName(project, variant) 177 | if (findTask(project, taskName)) { 178 | logger.debug "task $taskName already exists" 179 | } else { 180 | def del = project.tasks.register(taskName, Delete) { 181 | delete getJavadocFolder(project, variant) 182 | } 183 | project.tasks.named("clean").configure { 184 | dependsOn del 185 | } 186 | } 187 | } 188 | 189 | private static String getBaseTaskName(final Project project, variant) { 190 | return "${project.androidJavadoc.taskNameTransformer(variant).capitalize()}" 191 | } 192 | 193 | static String genJavadocTaskName(final Project project, variant) { 194 | return "generate${getBaseTaskName(project, variant)}Javadoc" 195 | } 196 | 197 | static String genDeleteTaskName(final Project project, variant) { 198 | return "delete${getBaseTaskName(project, variant)}Javadoc" 199 | } 200 | 201 | static String genJavadocJarTaskName(final Project project, variant) { 202 | return "${genJavadocTaskName(project, variant)}Jar" 203 | } 204 | 205 | private static File getJavadocFolder(final Project project, variant) { 206 | return new File("${project.androidJavadoc.outputDir(project)}", "${project.androidJavadoc.taskNameTransformer(variant)}") 207 | } 208 | 209 | @Nullable 210 | private TaskProvider findTask(final Project project, String taskName) { 211 | TaskProvider ret = null 212 | try { 213 | ret = project.tasks.named(taskName) 214 | } catch (Exception ignored) { 215 | logger.debug ignored.toString() 216 | } 217 | return ret 218 | } 219 | } 220 | -------------------------------------------------------------------------------- /src/main/groovy/com/vanniktech/android/javadoc/extensions/AndroidJavadocExtension.groovy: -------------------------------------------------------------------------------- 1 | package com.vanniktech.android.javadoc.extensions 2 | 3 | import org.gradle.api.Project 4 | 5 | class AndroidJavadocExtension { 6 | /** 7 | * Closure used for filter some variant out 8 | */ 9 | Closure variantFilter = { variant -> 10 | if (variant) { 11 | return true 12 | } else { 13 | return false 14 | } 15 | } 16 | 17 | /** 18 | * Closure used for customizing the task name generation. 19 | *

It is always following the pattern : generate{{ClosureOutput}.capitalize()}Javadoc 20 | */ 21 | Closure taskNameTransformer = { variant -> 22 | return variant.name 23 | } 24 | 25 | /** 26 | * Closure used for changing the output folder of the documentation 27 | */ 28 | Closure outputDir = { Project project -> 29 | "${project.buildDir}/docs/javadoc/" 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/test/groovy/com/vanniktech/android/javadoc/GenerationTest.groovy: -------------------------------------------------------------------------------- 1 | package com.vanniktech.android.javadoc 2 | 3 | import com.vanniktech.android.javadoc.extensions.AndroidJavadocExtension 4 | import org.gradle.api.Task 5 | import org.gradle.api.tasks.bundling.Jar 6 | import org.gradle.api.tasks.javadoc.Javadoc 7 | import org.gradle.testfixtures.ProjectBuilder 8 | import org.junit.Before 9 | import org.junit.Rule 10 | import org.junit.Test 11 | import org.junit.rules.ExpectedException 12 | 13 | class GenerationTest { 14 | @Rule public ExpectedException expectedException = ExpectedException.none() 15 | 16 | def generation 17 | def project 18 | 19 | @Before 20 | void setUp() { 21 | generation = new Generation() 22 | project = ProjectBuilder.builder().withName('project').build() 23 | 24 | def manifestFile = new File(project.projectDir, "src/main/AndroidManifest.xml") 25 | manifestFile.parentFile.mkdirs() 26 | manifestFile.setText('') 27 | } 28 | 29 | @Test 30 | void testNullProject() throws Exception { 31 | expectedException.expect(UnsupportedOperationException.class) 32 | expectedException.expectMessage('Project is null') 33 | 34 | generation.apply(null) 35 | } 36 | 37 | @Test 38 | void testThatExtensionIsAdded() { 39 | project.plugins.apply('com.android.application') 40 | generation.apply(project) 41 | 42 | assert project.androidJavadoc instanceof AndroidJavadocExtension 43 | assert project.androidJavadoc.variantFilter instanceof Closure 44 | assert project.androidJavadoc.taskNameTransformer instanceof Closure 45 | assert project.androidJavadoc.outputDir instanceof Closure 46 | } 47 | 48 | @Test 49 | void testNotAndroidProject() { 50 | generation.apply(project) 51 | 52 | assert !project.hasProperty("generateReleaseJavadoc") 53 | assert !project.hasProperty("generateDebugJavadoc") 54 | assert !project.hasProperty("generateReleaseJavadocJar") 55 | assert !project.hasProperty("generateDebugJavadocJar") 56 | assert !project.hasProperty("generateJavadoc") 57 | assert !project.hasProperty("generateJavadocJar") 58 | } 59 | 60 | @Test 61 | void testJavaProject() { 62 | project.plugins.apply('java') 63 | generation.apply(project) 64 | 65 | assert !project.hasProperty("generateReleaseJavadoc") 66 | assert !project.hasProperty("generateDebugJavadoc") 67 | assert !project.hasProperty("generateReleaseJavadocJar") 68 | assert !project.hasProperty("generateDebugJavadocJar") 69 | assert !project.hasProperty("generateJavadoc") 70 | assert !project.hasProperty("generateJavadocJar") 71 | } 72 | 73 | @Test 74 | void testAndroidAppProject() { 75 | withAndroidAppProject() 76 | 77 | // These tasks are only added after project.afterEvaluated() is called. 78 | assert !project.hasProperty("generateReleaseJavadoc") 79 | assert !project.hasProperty("generateDebugJavadoc") 80 | assert !project.hasProperty("generateReleaseJavadocJar") 81 | assert !project.hasProperty("generateDebugJavadocJar") 82 | 83 | project.evaluate() 84 | 85 | assert project.generateReleaseJavadoc instanceof Javadoc 86 | assert project.generateDebugJavadoc instanceof Javadoc 87 | assert project.generateReleaseJavadocJar instanceof Jar 88 | assert project.generateDebugJavadocJar instanceof Jar 89 | assert project.generateJavadoc instanceof Task 90 | assert project.generateJavadocJar instanceof Task 91 | } 92 | 93 | @Test 94 | void testAndroidAppProjectInverseApply() { 95 | 96 | // Apply javadoc plugin first 97 | generation.apply(project) 98 | applyAndroidPlugin('com.android.application') 99 | 100 | // These tasks are only added after project.afterEvaluated() is called. 101 | assert !project.hasProperty("generateReleaseJavadoc") 102 | assert !project.hasProperty("generateDebugJavadoc") 103 | assert !project.hasProperty("generateReleaseJavadocJar") 104 | assert !project.hasProperty("generateDebugJavadocJar") 105 | 106 | project.evaluate() 107 | 108 | assert project.generateReleaseJavadoc instanceof Javadoc 109 | assert project.generateDebugJavadoc instanceof Javadoc 110 | assert project.generateReleaseJavadocJar instanceof Jar 111 | assert project.generateDebugJavadocJar instanceof Jar 112 | assert project.generateJavadoc instanceof Task 113 | assert project.generateJavadocJar instanceof Task 114 | } 115 | 116 | @Test 117 | void testAndroidLibraryProject() { 118 | withAndroidLibProject() 119 | 120 | // These tasks are only added after project.afterEvaluated() is called. 121 | assert !project.hasProperty("generateReleaseJavadoc") 122 | assert !project.hasProperty("generateDebugJavadoc") 123 | assert !project.hasProperty("generateReleaseJavadocJar") 124 | assert !project.hasProperty("generateDebugJavadocJar") 125 | 126 | project.evaluate() 127 | 128 | assert project.generateReleaseJavadoc instanceof Javadoc 129 | assert project.generateDebugJavadoc instanceof Javadoc 130 | assert project.generateReleaseJavadocJar instanceof Jar 131 | assert project.generateDebugJavadocJar instanceof Jar 132 | assert project.generateJavadoc instanceof Task 133 | assert project.generateJavadocJar instanceof Task 134 | } 135 | 136 | @Test 137 | void filterVariant() { 138 | withAndroidAppProject() 139 | 140 | project.androidJavadoc.variantFilter { variant -> 141 | variant.buildType.name == "release" 142 | } 143 | 144 | project.evaluate() 145 | 146 | assert !project.hasProperty("generateDebugJavadoc") 147 | assert !project.hasProperty("generateDebugJavadocJar") 148 | assert project.generateReleaseJavadoc instanceof Javadoc 149 | assert project.generateReleaseJavadocJar instanceof Jar 150 | assert project.generateJavadoc instanceof Task 151 | assert project.generateJavadocJar instanceof Task 152 | } 153 | 154 | @Test 155 | void transformTaskName() { 156 | withAndroidAppProject() 157 | 158 | project.androidJavadoc.taskNameTransformer { variant -> 159 | "yeah" 160 | } 161 | 162 | project.evaluate() 163 | 164 | assert !project.hasProperty("generateReleaseJavadoc") 165 | assert !project.hasProperty("generateDebugJavadoc") 166 | assert !project.hasProperty("generateReleaseJavadocJar") 167 | assert !project.hasProperty("generateDebugJavadocJar") 168 | assert project.generateYeahJavadoc instanceof Javadoc 169 | assert project.generateYeahJavadocJar instanceof Jar 170 | assert project.generateJavadoc instanceof Task 171 | assert project.generateJavadocJar instanceof Task 172 | } 173 | 174 | private void withAndroidAppProject() { 175 | applyAndroidPlugin('com.android.application') 176 | generation.apply(project) 177 | } 178 | 179 | private void withAndroidLibProject() { 180 | applyAndroidPlugin('com.android.library') 181 | generation.apply(project) 182 | } 183 | 184 | private void applyAndroidPlugin(String plugin) { 185 | project.plugins.apply(plugin) 186 | project.android.compileSdkVersion 28 187 | project.android.buildToolsVersion "28.0.3" 188 | project.android.defaultConfig { 189 | minSdkVersion 17 190 | targetSdkVersion 28 191 | versionCode 1 192 | versionName "dev" 193 | } 194 | } 195 | } 196 | --------------------------------------------------------------------------------