You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by hl...@apache.org on 2013/06/19 18:03:24 UTC

git commit: Fix JavaDoc Warnings Add missing copyright headers

Updated Branches:
  refs/heads/master 1a964fe65 -> 09ca58266


Fix JavaDoc Warnings
Add missing copyright headers


Project: http://git-wip-us.apache.org/repos/asf/tapestry-5/repo
Commit: http://git-wip-us.apache.org/repos/asf/tapestry-5/commit/09ca5826
Tree: http://git-wip-us.apache.org/repos/asf/tapestry-5/tree/09ca5826
Diff: http://git-wip-us.apache.org/repos/asf/tapestry-5/diff/09ca5826

Branch: refs/heads/master
Commit: 09ca582667da4c0a65b77146e4ef44676690597e
Parents: 1a964fe
Author: Howard M. Lewis Ship <hl...@apache.org>
Authored: Wed Jun 19 09:03:14 2013 -0700
Committer: Howard M. Lewis Ship <hl...@apache.org>
Committed: Wed Jun 19 09:03:14 2013 -0700

----------------------------------------------------------------------
 .../internal/plastic/PlasticClassPool.java      |  3 +--
 .../corelib/components/GridColumns.java         |  1 -
 .../DefaultRequestExceptionHandler.java         |  2 +-
 .../internal/services/DocumentLinker.java       |  4 ++--
 .../services/assets/AssetChecksumGenerator.java |  2 +-
 .../tapestry5/ioc/services/PropertyAccess.java  |  4 ++--
 .../jpa/TapestryPersistenceUnitInfo.java        |  9 ++++---
 .../tapestry5/internal/mongodb/MongoDBImpl.java | 19 ++++++++++++---
 .../internal/mongodb/MongoDBSourceImpl.java     | 25 +++++++++++++-------
 .../org/apache/tapestry5/mongodb/MongoDB.java   | 15 +++++++++++-
 .../apache/tapestry5/mongodb/MongoDBSource.java | 14 ++++++++++-
 .../tapestry5/mongodb/MongoDBSymbols.java       | 18 ++++++++++++--
 12 files changed, 87 insertions(+), 29 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/plastic/src/main/java/org/apache/tapestry5/internal/plastic/PlasticClassPool.java
----------------------------------------------------------------------
diff --git a/plastic/src/main/java/org/apache/tapestry5/internal/plastic/PlasticClassPool.java b/plastic/src/main/java/org/apache/tapestry5/internal/plastic/PlasticClassPool.java
index 927349f..5d38c0c 100644
--- a/plastic/src/main/java/org/apache/tapestry5/internal/plastic/PlasticClassPool.java
+++ b/plastic/src/main/java/org/apache/tapestry5/internal/plastic/PlasticClassPool.java
@@ -1,4 +1,4 @@
-// Copyright 2011, 2012 The Apache Software Foundation
+// Copyright 2011-2013 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -442,7 +442,6 @@ public class PlasticClassPool implements ClassLoaderDelegate, Opcodes, PlasticCl
      * @param baseClassName class from which the transformed class extends
      * @param classNode     node for the class
      * @param proxy         if true, the class is a new empty class; if false an existing class that's being transformed
-     * @return
      * @throws ClassNotFoundException
      */
     private InternalPlasticClassTransformation createTransformation(String baseClassName, ClassNode classNode, boolean proxy)

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/GridColumns.java
----------------------------------------------------------------------
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/GridColumns.java b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/GridColumns.java
index 71fb937..739a5c2 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/GridColumns.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/GridColumns.java
@@ -229,7 +229,6 @@ public class GridColumns
      * Returns null or "true", depending on whether the Grid is rendering for in-place updates or not ("true"
      * means in-place updates). The affects whether the data-inplace-grid-links attribute will be rendered or not.
      *
-     * @return
      */
     public String getInplaceGridLinks()
     {

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DefaultRequestExceptionHandler.java
----------------------------------------------------------------------
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DefaultRequestExceptionHandler.java b/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DefaultRequestExceptionHandler.java
index 6f5d520..7cad70b 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DefaultRequestExceptionHandler.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DefaultRequestExceptionHandler.java
@@ -50,7 +50,7 @@ import java.util.Map.Entry;
  * error page. Exception context is formed either from the name of Exception (e.g. SmtpNotRespondingException -> ServiceFailure mapping
  * would render a page with URL /servicefailure/smtpnotresponding) or they can implement {@link ContextAwareException} interface.
  *
- * If no configured exception type is found, the default exception page {@link SymbolConstants.EXCEPTION_REPORT_PAGE} is rendered.
+ * If no configured exception type is found, the default exception page {@link SymbolConstants#EXCEPTION_REPORT_PAGE} is rendered.
  * This fallback exception page must implement the {@link ExceptionReporter} interface.
  */
 public class DefaultRequestExceptionHandler implements RequestExceptionHandler

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DocumentLinker.java
----------------------------------------------------------------------
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DocumentLinker.java b/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DocumentLinker.java
index 886d534..a66b828 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DocumentLinker.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/internal/services/DocumentLinker.java
@@ -1,4 +1,4 @@
-// Copyright 2007, 2008, 2010, 2012 The Apache Software Foundation
+// Copyright 2007-2013 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -22,7 +22,7 @@ import org.apache.tapestry5.services.javascript.StylesheetLink;
  * Responsible for injecting script and style links into the &lt;head&gt; and &lt;body&gt; element of the rendered HTML
  * document.
  *
- * @see org.apache.tapestry5.services.javascript.ModuleManager#writeInitialization(org.apache.tapestry5.dom.Element, java.util.List
+ * @see org.apache.tapestry5.services.javascript.ModuleManager#writeInitialization(org.apache.tapestry5.dom.Element, java.util.List, java.util.List)
  * @since 5.4
  */
 public interface DocumentLinker

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/AssetChecksumGenerator.java
----------------------------------------------------------------------
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/AssetChecksumGenerator.java b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/AssetChecksumGenerator.java
index dc78648..8961a97 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/AssetChecksumGenerator.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/services/assets/AssetChecksumGenerator.java
@@ -19,7 +19,7 @@ import org.apache.tapestry5.ioc.Resource;
 import java.io.IOException;
 
 /**
- * Generates a checksum of an arbitrary {@link org.apache.tapestry5.Resource} or {@link StreamableResource} which can be incorporated into
+ * Generates a checksum of an arbitrary {@link org.apache.tapestry5.ioc.Resource} or {@link StreamableResource} which can be incorporated into
  * the {@linkplain org.apache.tapestry5.Asset#toClientURL() client URL} of an Asset.
  *
  * @since 5.4

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PropertyAccess.java
----------------------------------------------------------------------
diff --git a/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PropertyAccess.java b/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PropertyAccess.java
index 1a02a96..ae542c5 100644
--- a/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PropertyAccess.java
+++ b/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/PropertyAccess.java
@@ -1,4 +1,4 @@
-// Copyright 2006, 2010 The Apache Software Foundation
+// Copyright 2006, 2010, 2013 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -48,7 +48,7 @@ public interface PropertyAccess
 
     /**
      * Returns the annotation of a given property for the specified type if such an annotation is present, else null.
-     * A convenience over invoking {@link #getAdapter(Object)}.{@link #ClassPropertyAdapter.getPropertyAdapter(String)}.{@link #PropertyAdapter.getAnnotation(Class)}
+     * A convenience over invoking {@link #getAdapter(Object)}.{@link ClassPropertyAdapter#getPropertyAdapter(String)}.{@link PropertyAdapter#getAnnotation(Class)}
      *
      * @param instance     the object to read a value from
      * @param propertyName the name of the property to read (case is ignored)

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/TapestryPersistenceUnitInfo.java
----------------------------------------------------------------------
diff --git a/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/TapestryPersistenceUnitInfo.java b/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/TapestryPersistenceUnitInfo.java
index 4ff5b41..e1b193f 100644
--- a/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/TapestryPersistenceUnitInfo.java
+++ b/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/TapestryPersistenceUnitInfo.java
@@ -1,4 +1,4 @@
-// Copyright 2011 The Apache Software Foundation
+// Copyright 2011, 2013 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -14,13 +14,12 @@
 
 package org.apache.tapestry5.jpa;
 
-import java.net.URL;
-import java.util.Map;
-
 import javax.persistence.SharedCacheMode;
 import javax.persistence.ValidationMode;
 import javax.persistence.spi.PersistenceUnitInfo;
 import javax.persistence.spi.PersistenceUnitTransactionType;
+import java.net.URL;
+import java.util.Map;
 
 /**
  * Tapestry's mutable extension of {@link PersistenceUnitInfo} interface used for XML-less configuration
@@ -156,7 +155,7 @@ public interface TapestryPersistenceUnitInfo extends PersistenceUnitInfo
     TapestryPersistenceUnitInfo excludeUnlistedClasses(boolean exclude);
 
     /**
-     * {@link javax.persistence.spi.PersistenceProvider} allows creating an {@alink javax.persistence.EntityManagerFactory}
+     * {@link javax.persistence.spi.PersistenceProvider} allows creating an {@link javax.persistence.EntityManagerFactory}
      * with a default EntityManager properties map. This operation allows contributing default properties for
      * EntityManager.
      *

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/tapestry-mongodb/src/main/java/org/apache/tapestry5/internal/mongodb/MongoDBImpl.java
----------------------------------------------------------------------
diff --git a/tapestry-mongodb/src/main/java/org/apache/tapestry5/internal/mongodb/MongoDBImpl.java b/tapestry-mongodb/src/main/java/org/apache/tapestry5/internal/mongodb/MongoDBImpl.java
index b922df0..b4aff6e 100644
--- a/tapestry-mongodb/src/main/java/org/apache/tapestry5/internal/mongodb/MongoDBImpl.java
+++ b/tapestry-mongodb/src/main/java/org/apache/tapestry5/internal/mongodb/MongoDBImpl.java
@@ -1,13 +1,26 @@
+// Copyright 2013 The Apache Software Foundation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package org.apache.tapestry5.internal.mongodb;
 
+import com.mongodb.DB;
+import com.mongodb.Mongo;
 import org.apache.tapestry5.ioc.services.ThreadCleanupListener;
 import org.apache.tapestry5.mongodb.MongoDB;
 import org.apache.tapestry5.mongodb.MongoDBSource;
 import org.slf4j.Logger;
 
-import com.mongodb.DB;
-import com.mongodb.Mongo;
-
 /**
  * Default implementation for {@link org.apache.tapestry5.mongodb.MongoDB}
  */

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/tapestry-mongodb/src/main/java/org/apache/tapestry5/internal/mongodb/MongoDBSourceImpl.java
----------------------------------------------------------------------
diff --git a/tapestry-mongodb/src/main/java/org/apache/tapestry5/internal/mongodb/MongoDBSourceImpl.java b/tapestry-mongodb/src/main/java/org/apache/tapestry5/internal/mongodb/MongoDBSourceImpl.java
index 94dd3e9..3c5f64e 100644
--- a/tapestry-mongodb/src/main/java/org/apache/tapestry5/internal/mongodb/MongoDBSourceImpl.java
+++ b/tapestry-mongodb/src/main/java/org/apache/tapestry5/internal/mongodb/MongoDBSourceImpl.java
@@ -1,18 +1,27 @@
-package org.apache.tapestry5.internal.mongodb;
+// Copyright 2013 The Apache Software Foundation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
-import java.net.UnknownHostException;
-import java.util.List;
+package org.apache.tapestry5.internal.mongodb;
 
+import com.mongodb.*;
 import org.apache.tapestry5.ioc.annotations.Symbol;
 import org.apache.tapestry5.mongodb.MongoDBSource;
 import org.apache.tapestry5.mongodb.MongoDBSymbols;
 import org.slf4j.Logger;
 
-import com.mongodb.MongoClient;
-import com.mongodb.MongoClientOptions;
-import com.mongodb.ReadPreference;
-import com.mongodb.ServerAddress;
-import com.mongodb.WriteConcern;
+import java.net.UnknownHostException;
+import java.util.List;
 
 /**
  * Default implementation for {@link org.apache.tapestry5.mongodb.MongoDBSource}

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDB.java
----------------------------------------------------------------------
diff --git a/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDB.java b/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDB.java
index 1cf9b4f..524174b 100644
--- a/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDB.java
+++ b/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDB.java
@@ -1,7 +1,20 @@
+// Copyright 2013 The Apache Software Foundation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package org.apache.tapestry5.mongodb;
 
 import com.mongodb.DB;
-import org.slf4j.Logger;
 
 /**
  *

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDBSource.java
----------------------------------------------------------------------
diff --git a/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDBSource.java b/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDBSource.java
index 643774b..887f7c7 100644
--- a/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDBSource.java
+++ b/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDBSource.java
@@ -1,4 +1,16 @@
-package org.apache.tapestry5.mongodb;
+// Copyright 2013 The Apache Software Foundation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.package org.apache.tapestry5.mongodb;
 
 import com.mongodb.MongoClient;
 import com.mongodb.ServerAddress;

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/09ca5826/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDBSymbols.java
----------------------------------------------------------------------
diff --git a/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDBSymbols.java b/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDBSymbols.java
index 56f4ef5..6b667d9 100644
--- a/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDBSymbols.java
+++ b/tapestry-mongodb/src/main/java/org/apache/tapestry5/mongodb/MongoDBSymbols.java
@@ -1,3 +1,17 @@
+// Copyright 2013 The Apache Software Foundation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package org.apache.tapestry5.mongodb;
 
 /**
@@ -11,12 +25,12 @@ package org.apache.tapestry5.mongodb;
 public class MongoDBSymbols
 {
     /**
-     * The {@link com.mongodb.WriteConcern} to use. Default to {@link com.mongodb.WriteConcern.ACKNOWLEDGED}.
+     * The {@link com.mongodb.WriteConcern} to use. Default to {@link com.mongodb.WriteConcern#ACKNOWLEDGED}.
      */
     public static final String WRITE_CONCERN = "tapestry.mongodb.write_concern";
 
     /**
-     * The {@link com.mongodb.ReadPreference} to use. Default to {@link com.mongodb.ReadPreference.primary()}.
+     * The {@link com.mongodb.ReadPreference} to use. Default to {@link com.mongodb.ReadPreference#primary()}.
      */
     public static final String READ_PREFERENCE = "tapestry.mongodb.read_preference";