You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by cz...@apache.org on 2007/01/31 14:58:20 UTC
svn commit: r501847 - in
/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal:
event/layout/ layout/renderer/impl/ om/ profile/impl/ services/
services/aspects/impl/support/
Author: cziegeler
Date: Wed Jan 31 05:58:19 2007
New Revision: 501847
URL: http://svn.apache.org/viewvc?view=rev&rev=501847
Log:
Fix javadoc errors
Modified:
cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/event/layout/LayoutEvent.java
cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/layout/renderer/impl/DefaultLinkRenderer.java
cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/CopletType.java
cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/Layout.java
cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/LayoutFeatures.java
cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/AbstractPortalUser.java
cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/AbstractProfileManager.java
cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/GroupBasedProfileManager.java
cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/ProfileHolder.java
cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/services/LayoutFactory.java
cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/services/aspects/impl/support/PortalManagerAspectContextImpl.java
Modified: cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/event/layout/LayoutEvent.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/event/layout/LayoutEvent.java?view=diff&rev=501847&r1=501846&r2=501847
==============================================================================
--- cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/event/layout/LayoutEvent.java (original)
+++ cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/event/layout/LayoutEvent.java Wed Jan 31 05:58:19 2007
@@ -40,7 +40,7 @@
}
/**
- * @see org.apache.cocoon.portal.event.LayoutEvent#getTarget()
+ * The target layout object.
*/
public Layout getTarget() {
return this.target;
Modified: cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/layout/renderer/impl/DefaultLinkRenderer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/layout/renderer/impl/DefaultLinkRenderer.java?view=diff&rev=501847&r1=501846&r2=501847
==============================================================================
--- cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/layout/renderer/impl/DefaultLinkRenderer.java (original)
+++ cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/layout/renderer/impl/DefaultLinkRenderer.java Wed Jan 31 05:58:19 2007
@@ -40,7 +40,7 @@
public class DefaultLinkRenderer implements Renderer, ThreadSafe {
/**
- * @see org.apache.cocoon.portal.layout.renderer.impl.AbstractRenderer#toSAX(org.apache.cocoon.portal.om.Layout, org.apache.cocoon.portal.PortalService, org.xml.sax.ContentHandler)
+ * @see org.apache.cocoon.portal.layout.renderer.Renderer#toSAX(org.apache.cocoon.portal.om.Layout, org.apache.cocoon.portal.PortalService, org.xml.sax.ContentHandler)
*/
public void toSAX(Layout layout, PortalService service, ContentHandler handler)
throws SAXException, LayoutException {
Modified: cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/CopletType.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/CopletType.java?view=diff&rev=501847&r1=501846&r2=501847
==============================================================================
--- cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/CopletType.java (original)
+++ cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/CopletType.java Wed Jan 31 05:58:19 2007
@@ -26,7 +26,7 @@
* A coplet base data defines a coplet type, like a pipeline based coplet,
* a JSR 168 portlet or a WSRP portlet. For each type exists a coplet base
* data with some configuration.
- * Based on the coplet base data, coplets are created ({@link CopletData}.
+ * Based on the coplet type, coplets are created ({@link CopletDefinition}.
*
* @version $Id$
*/
Modified: cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/Layout.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/Layout.java?view=diff&rev=501847&r1=501846&r2=501847
==============================================================================
--- cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/Layout.java (original)
+++ cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/Layout.java Wed Jan 31 05:58:19 2007
@@ -66,7 +66,7 @@
* Never create a layout object directly. Use the
* {@link LayoutFactory} instead.
* @param id The unique identifier of the layout object or null.
- * @param name The type of the layout.
+ * @param type The type of the layout.
* @see PortalUtils#testId(String)
*/
public Layout(String id, String type) {
Modified: cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/LayoutFeatures.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/LayoutFeatures.java?view=diff&rev=501847&r1=501846&r2=501847
==============================================================================
--- cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/LayoutFeatures.java (original)
+++ cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/om/LayoutFeatures.java Wed Jan 31 05:58:19 2007
@@ -108,7 +108,8 @@
/**
* The layout traverser gets notified by each layout object in the tree when
- * the layout is traversed using {@link LayoutFeatures#traverseLayout}.
+ * the layout is traversed using {@link LayoutFeatures#traverseLayout(PortalService, Layout, LayoutTraverser)}
+ * and {@link LayoutFeatures#traverseLayout(PortalService, Layout, LayoutTraverser, boolean)}.
*/
public interface LayoutTraverser {
Modified: cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/AbstractPortalUser.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/AbstractPortalUser.java?view=diff&rev=501847&r1=501846&r2=501847
==============================================================================
--- cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/AbstractPortalUser.java (original)
+++ cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/AbstractPortalUser.java Wed Jan 31 05:58:19 2007
@@ -67,7 +67,7 @@
}
/**
- * @param group The group to set.
+ * @param groups The groups to set.
*/
public void setGroups(Collection groups) {
this.groups = groups;
Modified: cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/AbstractProfileManager.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/AbstractProfileManager.java?view=diff&rev=501847&r1=501846&r2=501847
==============================================================================
--- cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/AbstractProfileManager.java (original)
+++ cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/AbstractProfileManager.java Wed Jan 31 05:58:19 2007
@@ -92,24 +92,10 @@
}
/**
- * @see org.apache.cocoon.portal.profile.ProfileManager#register(org.apache.cocoon.portal.om.Layout)
- */
- public void register(Layout layout) {
- // overwrite in subclass
- }
-
- /**
* @see org.apache.cocoon.portal.profile.ProfileManager#saveUserProfiles()
*/
public void saveUserProfiles() {
// override in subclass
- }
-
- /**
- * @see org.apache.cocoon.portal.profile.ProfileManager#unregister(org.apache.cocoon.portal.om.Layout)
- */
- public void unregister(Layout layout) {
- // overwrite in subclass
}
/**
Modified: cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/GroupBasedProfileManager.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/GroupBasedProfileManager.java?view=diff&rev=501847&r1=501846&r2=501847
==============================================================================
--- cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/GroupBasedProfileManager.java (original)
+++ cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/GroupBasedProfileManager.java Wed Jan 31 05:58:19 2007
@@ -362,7 +362,7 @@
/**
* Return the current set of global coplet types.
- * @return
+ * @return The global set of coplet types.
* @throws Exception
*/
protected Map getGlobalCopletTypes()
@@ -594,10 +594,7 @@
}
}
- /**
- * @see org.apache.cocoon.portal.profile.impl.AbstractProfileManager#saveUserLayout(java.lang.String)
- */
- public void saveLayoutInstances() {
+ protected void saveLayoutInstances() {
try {
final ProfileHolder profile = this.getUserProfile();
final Map key = this.buildKey(CATEGORY_USER,
Modified: cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/ProfileHolder.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/ProfileHolder.java?view=diff&rev=501847&r1=501846&r2=501847
==============================================================================
--- cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/ProfileHolder.java (original)
+++ cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/profile/impl/ProfileHolder.java Wed Jan 31 05:58:19 2007
@@ -79,7 +79,7 @@
/**
* Set all coplet definitions.
- * @param copletTypes An id based map of the definitions.
+ * @param copletDefinitions An id based map of the definitions.
*/
public void setCopletDefinitions(Map copletDefinitions) {
this.copletDefinitions = copletDefinitions;
@@ -87,7 +87,7 @@
/**
* Set all coplet instances.
- * @param copletTypes An id based map of the instances.
+ * @param copletInstances An id based map of the instances.
*/
public void setCopletInstances(Collection copletInstances) {
this.copletInstances = new HashMap();
@@ -279,7 +279,7 @@
/**
* Search the layout instance for a layout object.
* @param layout
- * @return
+ * @return The layout instance or null.
*/
public LayoutInstance searchLayoutInstance(Layout layout) {
if ( layout != null ) {
Modified: cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/services/LayoutFactory.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/services/LayoutFactory.java?view=diff&rev=501847&r1=501846&r2=501847
==============================================================================
--- cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/services/LayoutFactory.java (original)
+++ cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/services/LayoutFactory.java Wed Jan 31 05:58:19 2007
@@ -63,7 +63,7 @@
* Create a new layout instance for the layout object.
* The instance is also registered at the profile manager.
* @param layout
- * @return
+ * @return A new layout instance.
*/
LayoutInstance newInstace(Layout layout);
Modified: cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/services/aspects/impl/support/PortalManagerAspectContextImpl.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/services/aspects/impl/support/PortalManagerAspectContextImpl.java?view=diff&rev=501847&r1=501846&r2=501847
==============================================================================
--- cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/services/aspects/impl/support/PortalManagerAspectContextImpl.java (original)
+++ cocoon/trunk/blocks/cocoon-portal/cocoon-portal-impl/src/main/java/org/apache/cocoon/portal/services/aspects/impl/support/PortalManagerAspectContextImpl.java Wed Jan 31 05:58:19 2007
@@ -55,7 +55,7 @@
}
/**
- * @see org.apache.cocoon.portal.services.aspects.PortalManagerAspectRenderContext#invokeNext(org.xml.sax.ContentHandler, org.apache.avalon.framework.parameters.Parameters)
+ * @see org.apache.cocoon.portal.services.aspects.PortalManagerAspectRenderContext#invokeNext(org.xml.sax.ContentHandler, java.util.Properties)
*/
public void invokeNext(ContentHandler ch, Properties properties)
throws SAXException {