svn commit: r1380616 - /rave/sandbox/content-services/rave-jcr-integration/page-configuration/src/main/java/org/apache/rave/jcr/config/model/api/PageFragment.java

[ard]

Author: ard
Date: Tue Sep  4 12:55:57 2012
New Revision: 1380616

URL: http://svn.apache.org/viewvc?rev=1380616&view=rev
Log:
RAVE-696 improve javadocs

Modified:
    
rave/sandbox/content-services/rave-jcr-integration/page-configuration/src/main/java/org/apache/rave/jcr/config/model/api/PageFragment.java

Modified: 
rave/sandbox/content-services/rave-jcr-integration/page-configuration/src/main/java/org/apache/rave/jcr/config/model/api/PageFragment.java
URL: 
http://svn.apache.org/viewvc/rave/sandbox/content-services/rave-jcr-integration/page-configuration/src/main/java/org/apache/rave/jcr/config/model/api/PageFragment.java?rev=1380616&r1=1380615&r2=1380616&view=diff
==============================================================================
--- 
rave/sandbox/content-services/rave-jcr-integration/page-configuration/src/main/java/org/apache/rave/jcr/config/model/api/PageFragment.java
 (original)
+++ 
rave/sandbox/content-services/rave-jcr-integration/page-configuration/src/main/java/org/apache/rave/jcr/config/model/api/PageFragment.java
 Tue Sep  4 12:55:57 2012
@@ -30,7 +30,7 @@ public interface PageFragment {
     /**
      * Returns view name
      *
-     * @return view name or null if not set
+     * @return view name or <code>null</code> if not set
      */
     String getViewName();
 
@@ -56,16 +56,12 @@ public interface PageFragment {
     void setName(String name);
 
     /**
-     * Returnd name of the fragment
-     *
-     * @return name of the fragment. Should not be null
+     * @return the name of the fragment. Should not be <code>null</code>
      */
     String getName();
 
     /**
-     * Returns PageFragment parent (if any)
-     *
-     * @return null if no parent
+     * @return returns the parent {@link PageFragment} or <code>null</code> 
when their is no parent
      */
     PageFragment getParent();
 
@@ -77,8 +73,19 @@ public interface PageFragment {
      */
     void setParent(PageFragment parent);
 
+    /**
+     * Note that a {@link PageFragment} does not need to have a controller, 
also see {@link #getController()}
+     * @param controller the fully qualified classname of the controller
+     */
     void setController(String controller);
 
+    /**
+     * Returns the fully qualified classname of the controller class which is 
annotated with org.springframework.stereotype @Controller. 
+     * When this {@link PageFragment} does not need an explicit controller but 
is merely meant to surf as a renderer through
+     * {@link #getViewName()}, <code>null</code> can be returned
+     * @return the fully qualified classname of the controller class, or 
<code>null</code> when there is no specific controller 
+     * configured
+     */
     String getController();
 
     void setDescription(String description);