Merge pull request #197 from DavidWhitlock/issue-175-javadoc-for-all-…

…visibility

Address issue #175 so that when generating the Grader javadocs for projects, include class members with all visibilities. Also, add integration tests that generate and verify the Grader javadoc.

gwt-parent/gwt-originals-parent/airline-gwt/pom.xml

@@ -184,6 +184,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>
@@ -198,6 +201,7 @@
                 <version>Summer2017</version>
               </docletArtifact>
               <useStandardDocletOptions>false</useStandardDocletOptions>
+              <show>private</show>
             </configuration>
           </plugin>
         </plugins>

gwt-parent/gwt-originals-parent/apptbook-gwt/pom.xml

@@ -185,6 +185,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>
@@ -199,6 +202,7 @@
                 <version>Summer2017</version>
               </docletArtifact>
               <useStandardDocletOptions>false</useStandardDocletOptions>
+              <show>private</show>
             </configuration>
           </plugin>
         </plugins>

gwt-parent/gwt-originals-parent/phonebill-gwt/pom.xml

@@ -184,6 +184,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>
@@ -198,6 +201,7 @@
                 <version>Summer2017</version>
               </docletArtifact>
               <useStandardDocletOptions>false</useStandardDocletOptions>
+              <show>private</show>
             </configuration>
           </plugin>
         </plugins>

projects-parent/archetypes-parent/airline-archetype/src/main/resources/archetype-resources/pom.xml

@@ -127,6 +127,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>
@@ -141,6 +144,7 @@
                 <version>Summer2017</version>
               </docletArtifact>
               <useStandardDocletOptions>false</useStandardDocletOptions>
+              <show>private</show>
             </configuration>
           </plugin>
         </plugins>

projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/archetype.properties

@@ -0,0 +1,5 @@
+package=it.pkg.javadoc
+version=0.1-SNAPSHOT
+groupId=javadoc.archetype.it
+artifactId=javadoc
+grader=true

projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/goal.txt

@@ -0,0 +1 @@
+javadoc:javadoc

projects-parent/archetypes-parent/airline-archetype/src/test/resources/projects/javadoc/verify.groovy

@@ -0,0 +1,11 @@
+File buildLog = new File(basedir, "project/javadoc/build.log");
+if (!buildLog.isFile()) {
+  throw new FileNotFoundException("Couldn't find build log: " + buildLog)
+}
+
+String logText = buildLog.text
+
+def expectedJavaDoc = "The main class for the CS410J airline Project"
+if (!logText.contains(expectedJavaDoc)) {
+  throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc)
+}

projects-parent/archetypes-parent/airline-gwt-archetype/src/main/resources/archetype-resources/pom.xml

@@ -183,6 +183,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>
@@ -197,6 +200,7 @@
                 <version>Summer2017</version>
               </docletArtifact>
               <useStandardDocletOptions>false</useStandardDocletOptions>
+              <show>private</show>
             </configuration>
           </plugin>
         </plugins>

projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties

@@ -0,0 +1,5 @@
+package=it.pkg.javadoc
+version=0.1-SNAPSHOT
+groupId=javadoc.archetype.it
+artifactId=javadoc
+grader=true

projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/goal.txt

@@ -0,0 +1 @@
+javadoc:javadoc

projects-parent/archetypes-parent/airline-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy

@@ -0,0 +1,11 @@
+File buildLog = new File(basedir, "project/javadoc/build.log");
+if (!buildLog.isFile()) {
+  throw new FileNotFoundException("Couldn't find build log: " + buildLog)
+}
+
+String logText = buildLog.text
+
+def expectedJavaDoc = "A basic GWT class that makes sure that we can send an airline back"
+if (!logText.contains(expectedJavaDoc)) {
+  throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc)
+}

projects-parent/archetypes-parent/airline-web-archetype/src/main/resources/archetype-resources/pom.xml

@@ -188,6 +188,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>
@@ -202,6 +205,7 @@
                 <version>Summer2017</version>
               </docletArtifact>
               <useStandardDocletOptions>false</useStandardDocletOptions>
+              <show>private</show>
             </configuration>
           </plugin>
         </plugins>

projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/archetype.properties

@@ -0,0 +1,5 @@
+package=it.pkg.javadoc
+version=0.1-SNAPSHOT
+groupId=javadoc.archetype.it
+artifactId=javadoc
+grader=true

projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/goal.txt

@@ -0,0 +1 @@
+javadoc:javadoc

projects-parent/archetypes-parent/airline-web-archetype/src/test/resources/projects/javadoc/verify.groovy

@@ -0,0 +1,11 @@
+File buildLog = new File(basedir, "project/javadoc/build.log");
+if (!buildLog.isFile()) {
+  throw new FileNotFoundException("Couldn't find build log: " + buildLog)
+}
+
+String logText = buildLog.text
+
+def expectedJavaDoc = "A helper class for accessing the rest client."
+if (!logText.contains(expectedJavaDoc)) {
+  throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc)
+}

projects-parent/archetypes-parent/apptbook-archetype/src/main/resources/archetype-resources/pom.xml

@@ -127,6 +127,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>

projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/archetype.properties

@@ -0,0 +1,5 @@
+package=it.pkg.javadoc
+version=0.1-SNAPSHOT
+groupId=javadoc.archetype.it
+artifactId=javadoc
+grader=true

projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/goal.txt

@@ -0,0 +1 @@
+javadoc:javadoc

projects-parent/archetypes-parent/apptbook-archetype/src/test/resources/projects/javadoc/verify.groovy

@@ -0,0 +1,13 @@
+package projects.javadoc
+
+File buildLog = new File(basedir, "project/javadoc/build.log");
+if (!buildLog.isFile()) {
+  throw new FileNotFoundException("Couldn't find build log: " + buildLog)
+}
+
+String logText = buildLog.text
+
+def expectedJavaDoc = "The main class for the CS410J appointment book Project"
+if (!logText.contains(expectedJavaDoc)) {
+  throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc)
+}

projects-parent/archetypes-parent/apptbook-gwt-archetype/src/main/resources/archetype-resources/pom.xml

@@ -197,6 +197,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>
@@ -211,6 +214,7 @@
                 <version>Summer2017</version>
               </docletArtifact>
               <useStandardDocletOptions>false</useStandardDocletOptions>
+              <show>private</show>
             </configuration>
           </plugin>
         </plugins>

projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties

@@ -0,0 +1,5 @@
+package=it.pkg.javadoc
+version=0.1-SNAPSHOT
+groupId=javadoc.archetype.it
+artifactId=javadoc
+grader=true

projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/goal.txt

@@ -0,0 +1 @@
+javadoc:javadoc

projects-parent/archetypes-parent/apptbook-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy

@@ -0,0 +1,11 @@
+File buildLog = new File(basedir, "project/javadoc/build.log");
+if (!buildLog.isFile()) {
+  throw new FileNotFoundException("Couldn't find build log: " + buildLog)
+}
+
+String logText = buildLog.text
+
+def expectedJavaDoc = "A basic GWT class that makes sure that we can send an appointment book"
+if (!logText.contains(expectedJavaDoc)) {
+  throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc)
+}

projects-parent/archetypes-parent/apptbook-web-archetype/src/main/resources/archetype-resources/pom.xml

@@ -188,6 +188,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>
@@ -202,6 +205,7 @@
                 <version>Summer2017</version>
               </docletArtifact>
               <useStandardDocletOptions>false</useStandardDocletOptions>
+              <show>private</show>
             </configuration>
           </plugin>
         </plugins>

projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/archetype.properties

@@ -0,0 +1,5 @@
+package=it.pkg.javadoc
+version=0.1-SNAPSHOT
+groupId=javadoc.archetype.it
+artifactId=javadoc
+grader=true

projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/goal.txt

@@ -0,0 +1 @@
+javadoc:javadoc

projects-parent/archetypes-parent/apptbook-web-archetype/src/test/resources/projects/javadoc/verify.groovy

@@ -0,0 +1,11 @@
+File buildLog = new File(basedir, "project/javadoc/build.log");
+if (!buildLog.isFile()) {
+  throw new FileNotFoundException("Couldn't find build log: " + buildLog)
+}
+
+String logText = buildLog.text
+
+def expectedJavaDoc = "A helper class for accessing the rest client"
+if (!logText.contains(expectedJavaDoc)) {
+  throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc)
+}

projects-parent/archetypes-parent/phonebill-archetype/src/main/resources/archetype-resources/pom.xml

@@ -122,6 +122,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>
@@ -136,6 +139,7 @@
                 <version>Summer2017</version>
               </docletArtifact>
               <useStandardDocletOptions>false</useStandardDocletOptions>
+              <show>private</show>
             </configuration>
           </plugin>
         </plugins>

projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/archetype.properties

@@ -0,0 +1,5 @@
+package=it.pkg.javadoc
+version=0.1-SNAPSHOT
+groupId=javadoc.archetype.it
+artifactId=javadoc
+grader=true

projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/goal.txt

@@ -0,0 +1 @@
+javadoc:javadoc

projects-parent/archetypes-parent/phonebill-archetype/src/test/resources/projects/javadoc/verify.groovy

@@ -0,0 +1,11 @@
+File buildLog = new File(basedir, "project/javadoc/build.log");
+if (!buildLog.isFile()) {
+  throw new FileNotFoundException("Couldn't find build log: " + buildLog)
+}
+
+String logText = buildLog.text
+
+def expectedJavaDoc = "The main class for the CS410J Phone Bill Project"
+if (!logText.contains(expectedJavaDoc)) {
+  throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc)
+}

projects-parent/archetypes-parent/phonebill-gwt-archetype/src/main/resources/archetype-resources/pom.xml

@@ -184,6 +184,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>
@@ -198,6 +201,7 @@
                 <version>Summer2017</version>
               </docletArtifact>
               <useStandardDocletOptions>false</useStandardDocletOptions>
+              <show>private</show>
             </configuration>
           </plugin>
         </plugins>

projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/archetype.properties

@@ -0,0 +1,5 @@
+package=it.pkg.javadoc
+version=0.1-SNAPSHOT
+groupId=javadoc.archetype.it
+artifactId=javadoc
+grader=true

projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/goal.txt

@@ -0,0 +1 @@
+javadoc:javadoc

projects-parent/archetypes-parent/phonebill-gwt-archetype/src/test/resources/projects/javadoc/verify.groovy

@@ -0,0 +1,11 @@
+File buildLog = new File(basedir, "project/javadoc/build.log");
+if (!buildLog.isFile()) {
+  throw new FileNotFoundException("Couldn't find build log: " + buildLog)
+}
+
+String logText = buildLog.text
+
+def expectedJavaDoc = "A basic GWT class that makes sure that we can send an Phone Bill back"
+if (!logText.contains(expectedJavaDoc)) {
+  throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc)
+}

projects-parent/archetypes-parent/phonebill-web-archetype/src/main/resources/archetype-resources/pom.xml

@@ -189,6 +189,9 @@
   <profiles>
     <profile>
       <id>grader</id>
+      <activation>
+        <activeByDefault>${grader}</activeByDefault>
+      </activation>
       <build>
         <plugins>
           <plugin>
@@ -203,6 +206,7 @@
                 <version>Summer2017</version>
               </docletArtifact>
               <useStandardDocletOptions>false</useStandardDocletOptions>
+              <show>private</show>
             </configuration>
           </plugin>
         </plugins>

projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/archetype.properties

@@ -0,0 +1,5 @@
+package=it.pkg.javadoc
+version=0.1-SNAPSHOT
+groupId=javadoc.archetype.it
+artifactId=javadoc
+grader=true

projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/goal.txt

@@ -0,0 +1 @@
+javadoc:javadoc

projects-parent/archetypes-parent/phonebill-web-archetype/src/test/resources/projects/javadoc/verify.groovy

@@ -0,0 +1,11 @@
+File buildLog = new File(basedir, "project/javadoc/build.log");
+if (!buildLog.isFile()) {
+  throw new FileNotFoundException("Couldn't find build log: " + buildLog)
+}
+
+String logText = buildLog.text
+
+def expectedJavaDoc = "A helper class for accessing the rest client."
+if (!logText.contains(expectedJavaDoc)) {
+  throw new IllegalStateException("Didn't find expected JavaDoc: " + expectedJavaDoc)
+}