David Carr avatar David Carr committed de49a2d

docs: tweak javadocs

Comments (0)

Files changed (2)

src/main/java/us/carrclan/david/gradle/site/PublishSite.java

  * <p><pre class="groovyTestCase">
  * def project = org.gradle.testfixtures.ProjectBuilder.builder().build()
  * project.with {
- *     task([type: us.carrclan.david.gradle.site.PublishSite], 'myTask') {
+ *     task(name: 'myTask', type: us.carrclan.david.gradle.site.PublishSite) {
  *         baseDir = 'build/web-app'
  *         url = 'ftp://ftp.example.com/mySite'
  *         authenticationInfo {

src/main/java/us/carrclan/david/gradle/site/SitePlugin.java

 import java.io.File;
 import java.util.concurrent.Callable;
 
+/**
+ * A {@link Plugin} that publishes static HTML websites.
+ */
 public class SitePlugin implements Plugin<Project> {
     public static final String SITE_GROUP_NAME = "Site";
     public static final String SITE_EXTENSION_NAME = "site";
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.