svn commit: r232510 - /cocoon/blocks/portal/trunk/java/org/apache/cocoon/portal/PortalService.java

[cz...@apache.org]

Author: cziegeler
Date: Sat Aug 13 10:28:10 2005
New Revision: 232510

URL: http://svn.apache.org/viewcvs?rev=232510&view=rev
Log:
Add some comments

Modified:
    cocoon/blocks/portal/trunk/java/org/apache/cocoon/portal/PortalService.java

Modified: cocoon/blocks/portal/trunk/java/org/apache/cocoon/portal/PortalService.java
URL: http://svn.apache.org/viewcvs/cocoon/blocks/portal/trunk/java/org/apache/cocoon/portal/PortalService.java?rev=232510&r1=232509&r2=232510&view=diff
==============================================================================
--- cocoon/blocks/portal/trunk/java/org/apache/cocoon/portal/PortalService.java (original)
+++ cocoon/blocks/portal/trunk/java/org/apache/cocoon/portal/PortalService.java Sat Aug 13 10:28:10 2005
@@ -19,7 +19,6 @@
 import java.util.List;
 import java.util.Map;
 
-import org.apache.avalon.framework.context.Context;
 import org.apache.cocoon.portal.layout.Layout;
 
 /**
@@ -27,7 +26,8 @@
  * of the portal, the current name etc.
  * The main use of this component is to get the {@link PortalComponentManager}
  * to get all the other portal components.
- * 
+ * This component is a singleton.
+ *
  * @author <a href="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
  * @author <a href="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
  * 
@@ -35,8 +35,12 @@
  */
 public interface PortalService {
 
+    /** The role to lookup this component. */
     String ROLE = PortalService.class.getName();
     
+    /**
+     * The name of the portal - as defined in the portal configuration.
+     */
     String getPortalName();
     
     void setPortalName(String value);