[FEATURE] Add and improve javadoc tasks #33

bastienpaulfr · 2017-06-23T14:58:40Z

Hi,

You have made a great job in creating this plugin that I was looking for !
I have made some addition to your plugin based on some experience I have.

First I have removed some exception throwing to be able to apply this plugin in big project containing modules that are not Android application
I have added an archive task
I have added a androidJavadoc project extension to customize task name, filter variant and specify javadoc output dir
I have added a javadoc option to be able to generate javadoc with comments comming from java 7 wold

Please consider my changes and feel free to comment or improve them.

Best regards,

Bastien

vanniktech

I like the changes overall.

Could you also convert all of your comments to sentences?

Plus for the new behavior can you add unit tests?

vanniktech · 2017-06-24T13:11:13Z

README.md

@@ -19,7 +19,7 @@ buildscript {
        mavenCentral()
    }
    dependencies {
-        classpath 'com.vanniktech:gradle-android-javadoc-plugin:0.2.1'
+        classpath 'com.vanniktech:gradle-android-javadoc-plugin:0.3.0'


We'll need this to be 0.2.1 as it won't get released automatically.

vanniktech · 2017-06-24T13:12:58Z

src/main/groovy/com/vanniktech/android/javadoc/Generation.groovy

-                title = "Documentation for Android $project.android.defaultConfig.versionName v$project.android.defaultConfig.versionCode"
-                description = "Generates Javadoc for $variant.name."
-                group = 'Documentation'
+            // apply a filter because use can configure javadoc for some variants but not all of them


use can should it be you can ?

vanniktech · 2017-06-24T13:13:34Z

src/main/groovy/com/vanniktech/android/javadoc/extensions/Options.groovy

+    Closure outputDir = { Project project ->
+        "${project.buildDir}/docs/javadoc/"
+    }
+


nit: remove

I don't want to remove this one because I would like it to be the default. By default, javadoc generated by java plugin is stored in build/docs/javadoc.

vanniktech · 2017-06-24T13:13:49Z

src/test/groovy/com/vanniktech/android/javadoc/GenerationTest.groovy

@@ -38,8 +38,8 @@ class GenerationTest {
    public void testJavaProject() {
        project.plugins.apply('java')

-        expectedException.expect(UnsupportedOperationException.class)
-        expectedException.expectMessage('Project is not an Android project')
+        //expectedException.expect(UnsupportedOperationException.class)


just remove this then

vanniktech · 2017-06-24T13:13:52Z

src/test/groovy/com/vanniktech/android/javadoc/GenerationTest.groovy

-        expectedException.expect(UnsupportedOperationException.class)
-        expectedException.expectMessage('Project is not an Android project')
+        //expectedException.expect(UnsupportedOperationException.class)
+        //expectedException.expectMessage('Project is not an Android project')


just remove this then

vanniktech · 2017-06-24T13:14:48Z

gradle.properties

@@ -1,5 +1,4 @@
-GROUP=com.vanniktech
-VERSION_NAME=0.2.2-SNAPSHOT
+VERSION_NAME=0.3.0-SNAPSHOT


please add the group back

vanniktech · 2017-06-24T13:15:06Z

src/main/groovy/com/vanniktech/android/javadoc/Generation.groovy

-import org.gradle.api.Project
-import org.gradle.api.Task
+import com.vanniktech.android.javadoc.extensions.Options
+import org.gradle.api.*


please don't use star imports

vanniktech · 2017-06-24T13:15:10Z

src/main/groovy/com/vanniktech/android/javadoc/Generation.groovy

 import org.gradle.api.tasks.javadoc.Javadoc
 import org.gradle.external.javadoc.JavadocMemberLevel

 class Generation implements Plugin<Project> {
+


nit: remove

vanniktech · 2017-06-24T13:15:25Z

src/main/groovy/com/vanniktech/android/javadoc/Generation.groovy

+        }
+        logger = project.getLogger()
+
+        createExtensions(project)


just inline this one

vanniktech · 2017-06-24T13:16:56Z

src/main/groovy/com/vanniktech/android/javadoc/extensions/Options.groovy

+ *
+ * @author Bastien Paul
+ */
+public class Options {


Rename it to AndroidJavaDocExtension

- Create task for all projects and subprojects - Create archive task - Add compatibility for javadoc 7 comments - Add customization

bastienpaulfr · 2017-06-26T11:30:08Z

Hi,

You can review changes I've made.

Thanks

vanniktech

Few more small things. Once they're resolved I'll merge this

vanniktech · 2017-06-26T15:27:35Z

src/main/groovy/com/vanniktech/android/javadoc/Generation.groovy

+        String taskName = genJavadocTaskName(project, variant)
+
+        logger.debug "Create task ${taskName} for project ${project.name}, variant ${variant.name}"
+        // protection if a task already exists because the name of the task is configurable


This one still needs to be transformed.

vanniktech · 2017-06-26T15:28:16Z

src/main/groovy/com/vanniktech/android/javadoc/Generation.groovy

+            logger.debug "task $taskName already exists"
+            return project.tasks.findByPath(taskName)
+        } else {
+            Task t1 = createJavadocTask(project, variant, taskName)


javadocTask instead of t1?

vanniktech · 2017-06-26T15:28:27Z

src/main/groovy/com/vanniktech/android/javadoc/Generation.groovy

+            return project.tasks.findByPath(taskName)
+        } else {
+            Task t1 = createJavadocTask(project, variant, taskName)
+            Task t2 = createJavadocArchiveTask(project, variant, genJavadocJarTaskName(project, variant))


javadocArchieveTask instead of t2

vanniktech · 2017-06-26T15:28:43Z

src/main/groovy/com/vanniktech/android/javadoc/extensions/AndroidJavadocExtension.groovy

+    Closure outputDir = { Project project ->
+        "${project.buildDir}/docs/javadoc/"
+    }
+


nit: remove

vanniktech · 2017-06-26T15:29:16Z

src/main/groovy/com/vanniktech/android/javadoc/extensions/AndroidJavadocExtension.groovy

+import org.gradle.api.Project
+
+/**
+ * <p>Created on 23/06/17


Can you go and remove this alltogether? No file has proper date / authors. You'll still get credited in the release notes for the feature.

vanniktech · 2017-06-26T15:29:27Z

src/test/groovy/com/vanniktech/android/javadoc/GenerationTest.groovy

 class GenerationTest {
-    @Rule public ExpectedException expectedException = ExpectedException.none()
+    @Rule
+    public ExpectedException expectedException = ExpectedException.none()


nit: restore on same line

bastienpaulfr · 2017-06-27T06:30:43Z

Hi,

I hope this one is the good one !

Thanks,

vanniktech

Thanks for the contribution !

vanniktech suggested changes Jun 24, 2017

View reviewed changes

bastienpaulfr force-pushed the dev-bastien branch 9 times, most recently from 7581f01 to 9682bbf Compare June 26, 2017 10:43

[FEATURE] Add and improve javadoc tasks

8c6d26b

- Create task for all projects and subprojects - Create archive task - Add compatibility for javadoc 7 comments - Add customization

bastienpaulfr force-pushed the dev-bastien branch from 9682bbf to 8c6d26b Compare June 26, 2017 10:47

Merge branch 'master' into dev-bastien

e593dbb

vanniktech suggested changes Jun 26, 2017

View reviewed changes

[MINOR] Little changes for pull request.

bc170ec

vanniktech approved these changes Jun 27, 2017

View reviewed changes

vanniktech merged commit 65f38de into vanniktech:master Jun 27, 2017

bastienpaulfr deleted the dev-bastien branch June 27, 2017 11:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEATURE] Add and improve javadoc tasks #33

[FEATURE] Add and improve javadoc tasks #33

bastienpaulfr commented Jun 23, 2017

vanniktech left a comment •

edited

Loading

vanniktech Jun 24, 2017

vanniktech Jun 24, 2017

vanniktech Jun 24, 2017

bastienpaulfr Jun 26, 2017

vanniktech Jun 24, 2017

vanniktech Jun 24, 2017

vanniktech Jun 24, 2017

vanniktech Jun 24, 2017

vanniktech Jun 24, 2017

vanniktech Jun 24, 2017

vanniktech Jun 24, 2017

bastienpaulfr commented Jun 26, 2017

vanniktech left a comment

vanniktech Jun 26, 2017

vanniktech Jun 26, 2017

vanniktech Jun 26, 2017

vanniktech Jun 26, 2017

vanniktech Jun 26, 2017

vanniktech Jun 26, 2017

bastienpaulfr commented Jun 27, 2017

vanniktech left a comment

[FEATURE] Add and improve javadoc tasks #33

[FEATURE] Add and improve javadoc tasks #33

Conversation

bastienpaulfr commented Jun 23, 2017

vanniktech left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bastienpaulfr commented Jun 26, 2017

vanniktech left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bastienpaulfr commented Jun 27, 2017

vanniktech left a comment

Choose a reason for hiding this comment

vanniktech left a comment •

edited

Loading