svn commit: r998352 - in /tapestry/tapestry5/trunk: tapestry-core/src/main/java/org/apache/tapestry5/ tapestry-core/src/main/java/org/apache/tapestry5/annotations/ tapestry-hibernate/src/main/java/org/apache/tapestry5/hibernate/

[hl...@apache.org]

Author: hlship
Date: Fri Sep 17 22:09:04 2010
New Revision: 998352

URL: http://svn.apache.org/viewvc?rev=998352&view=rev
Log:
Minor JavaDoc corrections and tweaks

Modified:
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/PersistenceConstants.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Secure.java
    tapestry/tapestry5/trunk/tapestry-hibernate/src/main/java/org/apache/tapestry5/hibernate/HibernatePersistenceConstants.java

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/PersistenceConstants.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/PersistenceConstants.java?rev=998352&r1=998351&r2=998352&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/PersistenceConstants.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/PersistenceConstants.java Fri Sep 17 22:09:04 2010
@@ -1,10 +1,10 @@
-// Copyright 2008 The Apache Software Foundation
+// Copyright 2008, 2010 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
+// 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,
@@ -16,7 +16,7 @@ package org.apache.tapestry5;
 
 /**
  * Constants for persistent field strategies.
- *
+ * 
  * @see org.apache.tapestry5.annotations.Persist#value()
  */
 public class PersistenceConstants
@@ -32,7 +32,8 @@ public class PersistenceConstants
     public static final String CLIENT = "client";
 
     /**
-     * The page field persistence strategy that stores data in the session until the next request.
+     * A that stores data in the session, but only until the next request. This is often
+     * used for confirmation messages presented to the user.
      */
     public static final String FLASH = "flash";
 }

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Secure.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Secure.java?rev=998352&r1=998351&r2=998352&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Secure.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/annotations/Secure.java Fri Sep 17 22:09:04 2010
@@ -14,6 +14,7 @@
 
 package org.apache.tapestry5.annotations;
 
+import org.apache.tapestry5.SymbolConstants;
 import org.apache.tapestry5.ioc.annotations.UseWith;
 import org.apache.tapestry5.ioc.annotations.AnnotationUseContext;
 
@@ -25,6 +26,9 @@ import java.lang.annotation.Target;
 
 /**
  * A marker annotation that indicates that the page in question may only be accessed via HTTPS.
+ * <p>
+ * Normally, this annotation is ignored in development mode and only used in production mode. This can be changed
+ * via the {@link SymbolConstants#SECURE_ENABLED} configuration symbol. 
  *
  * @see org.apache.tapestry5.MetaDataConstants#SECURE_PAGE
  */

Modified: tapestry/tapestry5/trunk/tapestry-hibernate/src/main/java/org/apache/tapestry5/hibernate/HibernatePersistenceConstants.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-hibernate/src/main/java/org/apache/tapestry5/hibernate/HibernatePersistenceConstants.java?rev=998352&r1=998351&r2=998352&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-hibernate/src/main/java/org/apache/tapestry5/hibernate/HibernatePersistenceConstants.java (original)
+++ tapestry/tapestry5/trunk/tapestry-hibernate/src/main/java/org/apache/tapestry5/hibernate/HibernatePersistenceConstants.java Fri Sep 17 22:09:04 2010
@@ -1,10 +1,10 @@
-// Copyright 2009 The Apache Software Foundation
+// Copyright 2009, 2010 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
+// 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,
@@ -17,15 +17,17 @@ import org.apache.tapestry5.PersistenceC
 
 /**
  * Constants for persistent field strategies.
- *
- * @see org.apache.tapestry5.annotations.Persist#value()
  * 
+ * @see org.apache.tapestry5.annotations.Persist#value()
+ * @see PersistenceConstants
  * @since 5.2.0
  */
-public class HibernatePersistenceConstants extends PersistenceConstants 
+public class HibernatePersistenceConstants
 {
     /**
-     * If the field's value is a Hibernate entity its primary is stored in the {@link org.apache.tapestry5.services.Session}.
+     * If the field's value is a persistent Hibernate entity its type and primary key is stored in the
+     * {@link org.apache.tapestry5.services.Session}. Otherwise,
+     * the value is stored as per {@link PersistenceConstants#SESSION}.
      */
     public static final String ENTITY = "entity";
 }