From 65733dc471500d715ff44915742eb5d788a3f80b Mon Sep 17 00:00:00 2001
From: jensp <jensp@8810af33-2d31-482b-a856-94f89814c4df>
Date: Fri, 16 Dec 2011 14:53:32 +0000
Subject: [PATCH] =?UTF-8?q?JavaDoc=20f=C3=BCr=20PublicPersonalProfile?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

git-svn-id: https://svn.libreccm.org/ccm/trunk@1367 8810af33-2d31-482b-a856-94f89814c4df
---
 .../PublicPersonalProfileNavItem.java          |  3 ++-
 .../ContentGenerator.java                      | 11 ++++++++++-
 .../PublicPersonalProfilesServlet.java         | 18 +++++++++++++++++-
 3 files changed, 29 insertions(+), 3 deletions(-)

diff --git a/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/contenttypes/PublicPersonalProfileNavItem.java b/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/contenttypes/PublicPersonalProfileNavItem.java
index 1d727df08..1b3d13c3e 100644
--- a/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/contenttypes/PublicPersonalProfileNavItem.java
+++ b/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/contenttypes/PublicPersonalProfileNavItem.java
@@ -7,7 +7,8 @@ import com.arsdigita.persistence.OID;
 import java.math.BigDecimal;
 
 /**
- *
+ * A possible navigation entry for a public personal profile.
+ * 
  * @author Jens Pelzetter 
  * @version $Id$
  */
diff --git a/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/publicpersonalprofile/ContentGenerator.java b/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/publicpersonalprofile/ContentGenerator.java
index 6527fabb2..5b7134f4e 100644
--- a/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/publicpersonalprofile/ContentGenerator.java
+++ b/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/publicpersonalprofile/ContentGenerator.java
@@ -5,12 +5,21 @@ import com.arsdigita.cms.contenttypes.GenericPerson;
 import com.arsdigita.xml.Element;
 
 /**
- *
+ * Implementations of this interface are used to render automatic content
+ * (for example a publication list).
+ * 
  * @author Jens Pelzetter 
  * @version $Id$
  */
 public interface ContentGenerator {
     
+    /**
+     * Generates the content
+     * 
+     * @param parent XML element to attach the content to
+     * @param person The person to be used as data source
+     * @param state The current page state.
+     */
     void generateContent(Element parent, GenericPerson person, PageState state);
     
 }
diff --git a/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/publicpersonalprofile/PublicPersonalProfilesServlet.java b/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/publicpersonalprofile/PublicPersonalProfilesServlet.java
index d887abe3e..653e12218 100644
--- a/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/publicpersonalprofile/PublicPersonalProfilesServlet.java
+++ b/ccm-cms-publicpersonalprofile/src/com/arsdigita/cms/publicpersonalprofile/PublicPersonalProfilesServlet.java
@@ -54,7 +54,8 @@ import javax.servlet.http.HttpServletResponse;
 import org.apache.log4j.Logger;
 
 /**
- *
+ * Servlet for the PublicPersonalProfile application.
+ * 
  * @author Jens Pelzetter 
  * @version $Id$
  */
@@ -482,6 +483,13 @@ public class PublicPersonalProfilesServlet extends BaseApplicationServlet {
         }
     }
 
+    /**
+     * Generates the contact XML for the person
+     * 
+     * @param profileOwnerElem
+     * @param contact
+     * @param state 
+     */
     private void generateContactXml(final Element profileOwnerElem,
                                     final GenericContact contact,
                                     final PageState state) {
@@ -524,6 +532,14 @@ public class PublicPersonalProfilesServlet extends BaseApplicationServlet {
         }
     }
 
+    /**
+     * Renders the admin page.
+     * 
+     * @param page
+     * @param request
+     * @param response
+     * @throws ServletException 
+     */
     private void showAdminPage(final Page page,
                                final HttpServletRequest request,
                                final HttpServletResponse response)