Some javadoc improvements.

This commit is contained in:
Michael Bayne
2013-08-01 16:04:46 -07:00
parent 426f1698e0
commit 3af55c2660
3 changed files with 10 additions and 7 deletions
+4 -1
View File
@@ -139,10 +139,13 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId> <artifactId>maven-javadoc-plugin</artifactId>
<version>2.7</version> <version>2.9.1</version>
<configuration> <configuration>
<quiet>true</quiet> <quiet>true</quiet>
<show>public</show> <show>public</show>
<sourceFileExcludes>
<exclude>com/samskivert/gwt/**</exclude>
</sourceFileExcludes>
</configuration> </configuration>
</plugin> </plugin>
<plugin> <plugin>
@@ -9,7 +9,7 @@ import java.util.Iterator;
import java.util.Map; import java.util.Map;
/** /**
* A collector that does not use reflection and can be used in GWT. * A collector that does not use reflection and can be used with GWT.
*/ */
public abstract class BasicCollector implements Mustache.Collector public abstract class BasicCollector implements Mustache.Collector
{ {
@@ -27,7 +27,7 @@ import java.util.Map;
*/ */
public class Mustache public class Mustache
{ {
/** An interface to the Mustache compilation process. See {@link Mustache}. */ /** Compiles templates into executable form. See {@link Mustache}. */
public static class Compiler public static class Compiler
{ {
/** Whether or not standards mode is enabled. */ /** Whether or not standards mode is enabled. */
@@ -191,7 +191,7 @@ public class Mustache
} }
} }
/** Used to handle lambdas. */ /** Handles lambdas. */
public interface Lambda public interface Lambda
{ {
/** Executes this lambda on the supplied template fragment. The lambda should write its /** Executes this lambda on the supplied template fragment. The lambda should write its
@@ -203,21 +203,21 @@ public class Mustache
void execute (Template.Fragment frag, Writer out) throws IOException; void execute (Template.Fragment frag, Writer out) throws IOException;
} }
/** Used to read variables from values. */ /** Reads variables from context objects. */
public interface VariableFetcher public interface VariableFetcher
{ {
/** Reads the so-named variable from the supplied context object. */ /** Reads the so-named variable from the supplied context object. */
Object get (Object ctx, String name) throws Exception; Object get (Object ctx, String name) throws Exception;
} }
/** Handles escaper characters in substituted text. */ /** Handles escaping characters in substituted text. */
public interface Escaper public interface Escaper
{ {
/** Returns {@code raw} with the appropriate characters replaced with escape sequences. */ /** Returns {@code raw} with the appropriate characters replaced with escape sequences. */
String escape (String raw); String escape (String raw);
} }
/** Used to handle partials. */ /** Handles loading partial templates. */
public interface TemplateLoader public interface TemplateLoader
{ {
/** Returns a reader for the template with the supplied name. /** Returns a reader for the template with the supplied name.