Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Fix some JavaDoc warnings, enable index splitting and link to source

git-svn-id: https://svn.apache.org/repos/asf/tapestry/tapestry5/branches/5.3@1196621 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information...
commit 56aeca419fd4912b5f72793d26230a057c1ae904 1 parent 602d7df
@hlship hlship authored
View
3  build.gradle
@@ -203,6 +203,8 @@ task aggregateJavadoc(type: Javadoc, group: "Documentation") {
destinationDir = javadocBuildDir.dir
configure(options) {
// overview = new File( projectDir, 'src/javadoc/package.html' )
+ splitIndex = true
+ linkSource = true
stylesheetFile = new File(projectDir, 'src/javadoc/stylesheet.css')
windowTitle = 'Tapestry API Documentation'
docTitle = "Tapestry JavaDoc ($project.version)"
@@ -211,7 +213,6 @@ task aggregateJavadoc(type: Javadoc, group: "Documentation") {
links = ['http://download.oracle.com/javase/6/docs/api/', 'http://download.oracle.com/javaee/6/api/']
addStringOption "tagletpath", configurations.javadoc.asPath
addStringOption "taglet", "org.apache.tapestry5.javadoc.TapestryDocTaglet"
-
exclude "org/apache/tapestry5/internal/plastic/asm/**"
}
View
2  plastic/src/main/java/org/apache/tapestry5/internal/plastic/Lockable.java
@@ -26,7 +26,7 @@
/**
* Checks to see if the object has been locked.
*
- * @throw IllegalStateException if {@link #lock()} has been invoked.
+ * @throws IllegalStateException if {@link #lock()} has been invoked.
*/
protected void check()
{
View
3  tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Tree.java
@@ -336,8 +336,7 @@ public TreeExpansionModel getExpansionModel()
/**
* Returns the actual {@link TreeSelectionModel} in use for this Tree component,
- * as per the {@link #selectionModel} parameter. This is often, but not always, the same
- * as {@link #getDefaultTreeSelectionModel()}.
+ * as per the {@link #selectionModel} parameter.
*/
public TreeSelectionModel getSelectionModel()
{
View
6 ...core/src/main/java/org/apache/tapestry5/services/assets/StreamableResourceProcessing.java
@@ -20,9 +20,9 @@
/**
* Defines additional features desired when accessing the content of a {@link Resource} as
* a {@link StreamableResource}.
- *
+ *
+ * @see StreamableResourceSource
* @since 5.3
- * @see StreamableResourceSource#getStreamableResource(Resource, StreamableResourceProcessing)
*/
public enum StreamableResourceProcessing
{
@@ -42,7 +42,7 @@
/**
* Turns off all caching and minification of the resource, which is appropriate when the individual resource will be
* aggregated with other resources to form a virtual composite.
- *
+ *
* @see JavaScriptStack
*/
FOR_AGGREGATION
View
1  tapestry-core/src/main/java/org/apache/tapestry5/services/security/ClientWhitelist.java
@@ -29,7 +29,6 @@
/**
* Analyzes the current request, returning true if it is on the whitelist.
*
- * @return
*/
boolean isClientRequestOnWhitelist();
}
View
1  tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/util/InitializationPlan.java
@@ -24,7 +24,6 @@
/**
* The description of the operation, used with the {@link org.apache.tapestry5.ioc.OperationTracker}.
*
- * @return
*/
String getDescription();
View
2  tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/cron/PeriodicExecutor.java
@@ -27,7 +27,7 @@
* @param schedule defines when the job will next execute
* @param name a name used in debugging output related to the job
* @param job a Runnable object that represents the work to be done
- * @returns a PeriodicJob that can be used to query when the job executes, or to cancel its execution
+ * @return a PeriodicJob that can be used to query when the job executes, or to cancel its execution
*/
PeriodicJob addJob(Schedule schedule, String name, Runnable job);
}
Please sign in to comment.
Something went wrong with that request. Please try again.