Build improvements (#2426)

* Update Gradle version to latest

* Fix typo in dependency name (Gradle was resolving support-annotations:{26})

* Bump Android Gradle Plugin version to latest stable

* Remove deprecation warning during compile.
(@SuppressWarnings("deprecation") has no effect on imports)

* Force LF as the line separator to make sure checkstyle is runnable on Windows

* Constrain deprecation of GlideModule to a single method (suppresses javac warning)

* Make sure compiledJar's output is unique.
archivePath was the same as jar's archivePath, which triggered a rebuild and re-proguard every time, even on incremental builds.

* Move quality tool initializations near the tasks
Extract version constant for PMD

* Minor gradle improvements: warnings, Java compatiblity

* Extract test JVM memory size to gradle.properties

* Enable auto-completion in IDEA by using tasks.create instead of task shorthand

* Reduce amount of hard-coded paths

* Reduce amount of missing files when running findbugs

* Add missing test for setMemoryCategory return value

* Simplify JavaDoc classpath calculation

* Change JavaDoc {@link}s to {@code} as they're not linkable.
This reduces the noise during build.

* Fix invalid missing references in JavaDoc.
The equals/hashCode method doesn't exist in the classes, so need to reference the super-class.

* Fix checkstyle, javadoc alignment, typo and codify class-name-like concepts.

Author: TWiStErRob

annotation/compiler/build.gradle

@@ -22,10 +22,13 @@ dependencies {
     compile files(Jvm.current().getToolsJar())
 }
 
-def repackagedJar = file("$buildDir/intermediates/repackaged.jar")
-def proguardedJar = file("$buildDir/intermediates/proguarded.jar")
+def packagingFolder = file("${buildDir}/intermediates")
+def repackagedJar = file("${packagingFolder}/repackaged.jar")
+def proguardedJar = file("${packagingFolder}/proguarded.jar")
 
 task compiledJar(type: Jar, dependsOn: classes) {
+    destinationDir = packagingFolder
+    archiveName = 'compiled.jar'
     from sourceSets.main.output
 }
 
@@ -49,7 +52,7 @@ task jarjar(dependsOn: [tasks.compiledJar, configurations.compileOnly]) {
                         'META-INF/services/javax.annotation.processing.Processor'
                     ].join(','))
                 }
-                zipfileset(src: tasks.jar.archivePath)
+                zipfileset(src: tasks.compiledJar.archivePath)
                 def repackageIntoGlide = 'com.bumptech.glide.repackaged.@0'
                 rule result: repackageIntoGlide, pattern: 'com.squareup.javapoet.**'
                 rule result: repackageIntoGlide, pattern: 'com.google.auto.**'
@@ -71,7 +74,7 @@ task proguard(type: ProGuardTask, dependsOn: tasks.jarjar) {
     libraryjars "${System.getProperty('java.home')}/lib/rt.jar"
 }
 
-// Create the standard jar artifact based on our repackaged and proguarded jar.
+// Create the standard jar artifact based on our compiled, repackaged and proguarded jar.
 jar {
     dependsOn proguard
     from zipTree(proguardedJar)

annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/AppModuleProcessor.java

@@ -15,9 +15,9 @@
 
 /**
  * Runs the final steps of Glide's annotation process and generates the combined
- * {@link AppGlideModule}, {@link com.bumptech.glide.Glide},
- * {@link com.bumptech.glide.RequestManager}, and
- * {@link com.bumptech.glide.request.RequestOptions} classes.
+ * {@code AppGlideModule}, {@code com.bumptech.glide.Glide},
+ * {@code com.bumptech.glide.RequestManager}, and
+ * {@code com.bumptech.glide.request.RequestOptions} classes.
  */
 final class AppModuleProcessor {
   private static final String COMPILER_PACKAGE_NAME =

annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/GlideAnnotationProcessor.java

@@ -16,8 +16,8 @@
  * Generates classes based on Glide's annotations that configure Glide, add support for additional
  * resource types, and/or extend Glide's API.
  *
- * <p>This processor discovers all {@link AppGlideModule} and
- * {@link LibraryGlideModule} implementations that are
+ * <p>This processor discovers all {@code AppGlideModule} and
+ * {@code LibraryGlideModule} implementations that are
  * annotated with {@link com.bumptech.glide.annotation.GlideModule}. Any implementations missing the
  * annotation will be ignored.
  *
@@ -26,42 +26,42 @@
  *
  * <p>Multiple classes are generated by this processor:
  * <ul>
- *   <li>For {@link LibraryGlideModule}s - A GlideIndexer class in a
+ *   <li>For {@code LibraryGlideModule}s - A GlideIndexer class in a
  *      specific package that will later be used by the processor to discover all
- *      {@link LibraryGlideModule} classes.
- *   <li>For {@link AppGlideModule}s - A single
- *      {@link AppGlideModule} implementation
- *     ({@link com.bumptech.glide.GeneratedAppGlideModule}) that calls all
- *     {@link LibraryGlideModule}s and the
- *     original {@link AppGlideModule} in the correct order when Glide is
+ *      {@code LibraryGlideModule} classes.
+ *   <li>For {@code AppGlideModule}s - A single
+ *      {@code AppGlideModule} implementation
+ *     ({@code com.bumptech.glide.GeneratedAppGlideModule}) that calls all
+ *     {@code LibraryGlideModule}s and the
+ *     original {@code AppGlideModule} in the correct order when Glide is
  *     initialized.
  *   <li>{@link com.bumptech.glide.annotation.GlideExtension}s -
  *   <ul>
- *     <li>A {@link com.bumptech.glide.request.RequestOptions} implementation that contains
+ *     <li>A {@code com.bumptech.glide.request.RequestOptions} implementation that contains
  *     static versions of all builder methods in the base class and both static and instance
  *     versions of methods in all {@link com.bumptech.glide.annotation.GlideExtension}s.
  *     <li>If one or more methods in one or more
  *     {@link com.bumptech.glide.annotation.GlideExtension} annotated classes are annotated with
  *     {@link GlideType}:
  *     <ul>
- *       <li>A {@link com.bumptech.glide.RequestManager} implementation containing a generated
+ *       <li>A {@code com.bumptech.glide.RequestManager} implementation containing a generated
  *       method for each method annotated with
  *       {@link GlideType}.
- *       <li>A {@link com.bumptech.glide.manager.RequestManagerRetriever.RequestManagerFactory}
- *       implementation that produces the generated {@link com.bumptech.glide.RequestManager}s.
- *       <li>A {@link com.bumptech.glide.Glide} look-alike that implements all static methods in
- *       the {@link com.bumptech.glide.Glide} singleton and returns the generated
- *       {@link com.bumptech.glide.RequestManager} implementation when appropriate.
+ *       <li>A {@code com.bumptech.glide.manager.RequestManagerRetriever.RequestManagerFactory}
+ *       implementation that produces the generated {@code com.bumptech.glide.RequestManager}s.
+ *       <li>A {@code com.bumptech.glide.Glide} look-alike that implements all static methods in
+ *       the {@code com.bumptech.glide.Glide} singleton and returns the generated
+ *       {@code com.bumptech.glide.RequestManager} implementation when appropriate.
  *     </ul>
  *   </ul>
  * </ul>
  *
- * <p>{@link AppGlideModule} implementations must only be included in
+ * <p>{@code AppGlideModule} implementations must only be included in
  * applications, not in libraries. There must be exactly one
- * {@link AppGlideModule} implementation per
- * Application. The {@link AppGlideModule} class is
+ * {@code AppGlideModule} implementation per
+ * Application. The {@code AppGlideModule} class is
  * used as a signal that all modules have been found and that the final merged
- * {@link com.bumptech.glide.GeneratedAppGlideModule} impl can be created.
+ * {@code com.bumptech.glide.GeneratedAppGlideModule} impl can be created.
  */
 @AutoService(Processor.class)
 public final class GlideAnnotationProcessor extends AbstractProcessor {
@@ -96,17 +96,19 @@ public SourceVersion getSupportedSourceVersion() {
   }
 
    /**
-   * Each round we do the following:
-   * <ol>
-   *   <li>Find all AppGlideModules and save them to an instance variable (throw if > 1).
-   *   <li>Find all LibraryGlideModules
-   *   <li>For each LibraryGlideModule, write an Indexer with an Annotation with the class name.
-   *   <li>If we wrote any Indexers, return and wait for the next round.
-   *   <li>If we didn't write any Indexers and there is a AppGlideModule, write the
-   *   GeneratedAppGlideModule. Once the GeneratedAppGlideModule is written, we expect to be
-   *   finished. Any further generation of related classes will result in errors.
-   * </ol>
-   */
+    * Each round we do the following:
+    * <ol>
+    *   <li>Find all {@code AppGlideModule}s and save them to an instance variable (throw if > 1).
+    *   <li>Find all {@code LibraryGlideModule}s
+    *   <li>For each {@code LibraryGlideModule},
+    *       write an {@code Indexer} with an Annotation with the class name.
+    *   <li>If we wrote any {@code Indexer}s, return and wait for the next round.
+    *   <li>If we didn't write any {@code Indexer}s and there is a {@code AppGlideModule},
+    *       write the {@code GeneratedAppGlideModule}.
+    *       Once the {@code GeneratedAppGlideModule} is written, we expect to be finished.
+    *       Any further generation of related classes will result in errors.
+    * </ol>
+    */
   @Override
   public boolean process(Set<? extends TypeElement> set, RoundEnvironment env) {
     processorUtil.process();

annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/GlideGenerator.java

@@ -23,7 +23,7 @@
  * Generates a Glide look-alike that acts as the entry point to the generated API
  * (GlideApp.with(...)).
  *
- * <p>>Generated {@link com.bumptech.glide.Glide} look-alikes look like this (note that the name
+ * <p>>Generated {@code com.bumptech.glide.Glide} look-alikes look like this (note that the name
  * is configurable in {@link com.bumptech.glide.annotation.GlideModule}):
  * <pre>
  * <code>

annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/LibraryModuleProcessor.java

@@ -11,7 +11,7 @@
 
 /**
  * Generates Indexer classes annotated with {@link Index} for all
- * {@link LibraryGlideModule}s.
+ * {@code LibraryGlideModule}s.
  */
 final class LibraryModuleProcessor {
   private ProcessorUtil processorUtil;

annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/RequestBuilderGenerator.java

@@ -33,8 +33,8 @@
 import javax.lang.model.type.TypeMirror;
 
 /**
- * Generates a {@link com.bumptech.glide.RequestBuilder} subclass containing all methods from
- * the base class, all methods from {@link com.bumptech.glide.request.RequestOptions} and all
+ * Generates a {@code com.bumptech.glide.RequestBuilder} subclass containing all methods from
+ * the base class, all methods from {@code com.bumptech.glide.request.RequestOptions} and all
  * non-override {@link GlideOption} annotated methods in {@link GlideExtension} annotated
  * classes.
  *
@@ -177,8 +177,8 @@ TypeSpec generate(String generatedCodePackageName, @Nullable TypeSpec generatedO
   }
 
   /**
-   * Generates overrides of all methods in {@link com.bumptech.glide.RequestBuilder} that return
-   * {@link com.bumptech.glide.RequestBuilder} so that they return our generated subclass instead.
+   * Generates overrides of all methods in {@code com.bumptech.glide.RequestBuilder} that return
+   * {@code com.bumptech.glide.RequestBuilder} so that they return our generated subclass instead.
    */
   private List<MethodSpec> generateRequestBuilderOverrides() {
     TypeMirror rawRequestBuilderType =
@@ -194,8 +194,8 @@ public MethodSpec apply(ExecutableElement input) {
   }
 
   /**
-   * Generates an override of a particular method in {@link com.bumptech.glide.RequestBuilder} that
-   * returns {@link com.bumptech.glide.RequestBuilder} so that it returns our generated subclass
+   * Generates an override of a particular method in {@code com.bumptech.glide.RequestBuilder} that
+   * returns {@code com.bumptech.glide.RequestBuilder} so that it returns our generated subclass
    * instead.
    */
   private MethodSpec generateRequestBuilderOverride(ExecutableElement methodToOverride) {
@@ -234,7 +234,7 @@ public String apply(VariableElement input) {
    * Generates methods with equivalent names and arguments to methods annotated with
    * {@link GlideOption} in
    * {@link com.bumptech.glide.annotation.GlideExtension}s that return our generated
-   * {@link com.bumptech.glide.RequestBuilder} subclass.
+   * {@code com.bumptech.glide.RequestBuilder} subclass.
    */
   private List<MethodSpec> generateGeneratedRequestOptionsEquivalents(
       @Nullable final TypeSpec generatedOptions) {
@@ -260,10 +260,10 @@ public MethodSpec apply(MethodSpec input) {
 
   /**
    * Returns {@code true} if the given {@link MethodSpec} is a useful method to have in our
-   * {@link com.bumptech.glide.RequestBuilder} subclass.
+   * {@code com.bumptech.glide.RequestBuilder} subclass.
    *
    * <p>Only newly generated methods will be included in the generated
-   * {@link com.bumptech.glide.request.BaseRequestBuilder} subclass, so we only have to filter out
+   * {@code com.bumptech.glide.request.BaseRequestBuilder} subclass, so we only have to filter out
    * methods that override other methods to avoid duplicates.
    */
   private boolean isUsefulGeneratedRequestOption(MethodSpec requestOptionMethod) {
@@ -277,7 +277,7 @@ private boolean isUsefulGeneratedRequestOption(MethodSpec requestOptionMethod) {
 
    /**
    * Generates a particular method with  an equivalent name and arguments to the given method
-   * from the generated {@link com.bumptech.glide.request.BaseRequestBuilder} subclass.
+   * from the generated {@code com.bumptech.glide.request.BaseRequestBuilder} subclass.
    */
   private MethodSpec generateGeneratedRequestOptionEquivalent(MethodSpec requestOptionMethod) {
     CodeBlock callRequestOptionsMethod = CodeBlock.builder()
@@ -369,7 +369,7 @@ private List<MethodSpec> generateConstructors() {
   }
 
   /**
-   * Overrides the protected downloadOnly method in {@link com.bumptech.glide.RequestBuilder} to
+   * Overrides the protected downloadOnly method in {@code com.bumptech.glide.RequestBuilder} to
    * return our generated subclass instead.
    */
   private MethodSpec generateDownloadOnlyRequestMethod() {

annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/RequestManagerFactoryGenerator.java

@@ -10,10 +10,10 @@
 
 /**
  * Generates an implementation of
- * {@link com.bumptech.glide.manager.RequestManagerRetriever.RequestManagerFactory} that returns a
- * generated {@link com.bumptech.glide.RequestManager} implementation.
+ * {@code com.bumptech.glide.manager.RequestManagerRetriever.RequestManagerFactory} that returns a
+ * generated {@code com.bumptech.glide.RequestManager} implementation.
  *
- * <p>Generated {@link com.bumptech.glide.manager.RequestManagerRetriever.RequestManagerFactory}
+ * <p>Generated {@code com.bumptech.glide.manager.RequestManagerRetriever.RequestManagerFactory}
  * classes look like this:
  * <pre>
  * <code>

annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/RequestManagerGenerator.java

@@ -30,10 +30,10 @@
 import javax.lang.model.util.Elements;
 
 /**
- * Generates an implementation of {@link com.bumptech.glide.RequestManager} that contains generated
+ * Generates an implementation of {@code com.bumptech.glide.RequestManager} that contains generated
  * methods from {@link GlideExtension}s and {@link GlideType}.
  *
- * <p>Generated {@link com.bumptech.glide.RequestManager} implementations look like this:
+ * <p>Generated {@code com.bumptech.glide.RequestManager} implementations look like this:
  * <pre>
  * <code>
  * public final class GeneratedRequestManager extends RequestManager {

annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/RequestOptionsGenerator.java

@@ -38,7 +38,7 @@
 import javax.lang.model.element.VariableElement;
 
 /**
- * Generates a new implementation of {@link com.bumptech.glide.request.RequestOptions}
+ * Generates a new implementation of {@code com.bumptech.glide.request.RequestOptions}
  * containing static versions of methods included in the base class and static and instance versions
  * of all methods annotated with {@link GlideOption} in classes annotated with
  * {@link GlideExtension}.
@@ -327,7 +327,7 @@ private List<MethodAndStaticVar> generateStaticMethodOverridesForRequestOptions(
    * an existing method in RequestOptions.
    *
    * <p>The string names here just map between the static methods in
-   * {@link com.bumptech.glide.request.RequestOptions} and the instance methods they call.
+   * {@code com.bumptech.glide.request.RequestOptions} and the instance methods they call.
    */
   private static String getInstanceMethodNameFromStaticMethodName(String staticMethodName) {
     String equivalentInstanceMethodName;

annotation/src/main/java/com/bumptech/glide/annotation/GlideModule.java

@@ -16,7 +16,7 @@
 public @interface GlideModule {
   /**
    * Returns the name of the class that will be used as a replacement for
-   * {@link com.bumptech.glide.Glide} in Applications that depend on Glide's generated code.
+   * {@code com.bumptech.glide.Glide} in Applications that depend on Glide's generated code.
    */
   String glideName() default "GlideApp";
 }

annotation/src/main/java/com/bumptech/glide/annotation/GlideOption.java

@@ -7,10 +7,10 @@
 
 /**
  * Identifies methods in {@link GlideExtension} annotated classes that extend
- * {@link com.bumptech.glide.request.RequestOptions}.
+ * {@code com.bumptech.glide.request.RequestOptions}.
  *
  * <p>All annotated methods will be added to a single
- * {@link com.bumptech.glide.request.RequestOptions} implementation generated per application.
+ * {@code com.bumptech.glide.request.RequestOptions} implementation generated per application.
  * Overlapping method names in different extensions may cause errors at compile time.
  *
  * <p>Static equivalents of annotated methods will also be generated.
@@ -51,7 +51,7 @@
 
   /**
    * {@code true} to indicate that it's safe to statically memoize the result of this method using
-   * {@link com.bumptech.glide.request.RequestOptions#autoClone()}.
+   * {@code com.bumptech.glide.request.RequestOptions#autoClone()}.
    *
    * <p>This method should only be used for no-arg methods where there's only a single possible
    * value.
@@ -65,8 +65,8 @@
    *
    * <p>By default static methods are generated for all methods annotated with
    * {@link GlideOption}. These static factory methods allow for a cleaner API when used
-   * with {@link com.bumptech.glide.RequestBuilder#apply}. The static factory method by default
-   * simply creates a new {@link com.bumptech.glide.request.RequestOptions} object, calls the
+   * with {@code com.bumptech.glide.RequestBuilder#apply}. The static factory method by default
+   * simply creates a new {@code com.bumptech.glide.request.RequestOptions} object, calls the
    * instance version of the method on it and returns it. For example:
    * <pre>
    * <code>

annotation/src/main/java/com/bumptech/glide/annotation/GlideType.java

@@ -7,10 +7,10 @@
 
 /**
  * Identifies methods in {@link GlideExtension} annotated classes that extend
- * {@link com.bumptech.glide.RequestManager}.
+ * {@code com.bumptech.glide.RequestManager}.
  *
  * <p>If one or more method is found with this annotation, an additional API entry point that
- * exposes a generated {@link com.bumptech.glide.RequestManager} subclass will be created. The
+ * exposes a generated {@code com.bumptech.glide.RequestManager} subclass will be created. The
  * generated API entry point acts as a drop in replacement for Glide. Glide.with(fragment) becomes
  * GlideApp.with(fragment). Although the Glide.with variant will still be available, only the new
  * API entry point will provide access to these additional methods.
@@ -22,7 +22,7 @@
  * with {@link GlideExtension}.
  *
  * <p>Methods annotated with GlideType must have a single parameter. The type of the
- * single parameter must be {@link com.bumptech.glide.request.RequestOptions}, with a type
+ * single parameter must be {@code com.bumptech.glide.request.RequestOptions}, with a type
  * matching the value of {@link #value()}.
  */
 @Target(ElementType.METHOD)
@@ -33,7 +33,7 @@
   /**
    * A Resource class name, like GifDrawable.class, Bitmap.class etc.
    *
-   * <p>Must match the type of the {@link com.bumptech.glide.request.RequestOptions} parameter.
+   * <p>Must match the type of the {@code com.bumptech.glide.request.RequestOptions} parameter.
    */
   Class<?> value();
 }

checkstyle.xml

@@ -15,7 +15,9 @@
     </module>
 
     <!-- Ensure trailling newline for compatibility -->
-    <module name="NewlineAtEndOfFile" />
+    <module name="NewlineAtEndOfFile">
+        <property name="lineSeparator" value="lf"/>
+    </module>
 
     <!-- Space after 'for' and 'if' -->
     <module name="RegexpSingleline">