paulsp      2002/07/08 03:44:49

  Modified:    src/java/org/apache/jetspeed/util/template JetspeedLink.java
                        BaseJetspeedLink.java
               src/java/org/apache/jetspeed/om/profile/psml
                        PsmlIdentityElement.java
  Log:
  JavaDoc cleanup
  
  Revision  Changes    Path
  1.10      +18 -18    
jakarta-jetspeed/src/java/org/apache/jetspeed/util/template/JetspeedLink.java
  
  Index: JetspeedLink.java
  ===================================================================
  RCS file: 
/home/cvs/jakarta-jetspeed/src/java/org/apache/jetspeed/util/template/JetspeedLink.java,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- JetspeedLink.java 8 May 2002 03:18:11 -0000       1.9
  +++ JetspeedLink.java 8 Jul 2002 10:44:49 -0000       1.10
  @@ -366,7 +366,7 @@
        * @param entry to receive the action
        * @return DynamicURI that includes the desire action
        *
  -     * @depracated use getAction()
  +     * @depreceted use getAction()
        */
       public DynamicURI setAction(String action, Entry entry);
       
  @@ -378,7 +378,7 @@
        * @param portlet to receive the action
        * @return DynamicURI that includes the desire action
        *
  -     * @depracated use getAction()
  +     * @depreceted use getAction()
        */
       public DynamicURI setAction(String action, Portlet portlet);
       
  @@ -390,7 +390,7 @@
        * @param portlet to receive the action
        * @return DynamicURI that includes the desire action
        *
  -     * @depracated use getAction()
  +     * @depreceted use getAction()
        */
       public DynamicURI setAction(String action, Portlets portlet);
       
  @@ -400,7 +400,7 @@
        * @param group Desired group
        * @return DynamicURI that to the desired page
        *
  -     * @depracated use getGroup()
  +     * @depreceted use getGroup()
        */
       public DynamicURI setGroup(String group);
       
  @@ -411,7 +411,7 @@
        * @param group Desired group
        * @return DynamicURI that to the desired page
        *
  -     * @depracated use getGroup()
  +     * @depreceted use getGroup()
        */
       public DynamicURI setGroup(String group, String page);
       
  @@ -421,7 +421,7 @@
        *
        * @return DynamicURI that to the desired page
        *
  -     * @depracated use getPage()
  +     * @depreceted use getPage()
        */
       public DynamicURI setPage();
       
  @@ -432,7 +432,7 @@
        * @param page Desired page
        * @return DynamicURI that to the desired page
        *
  -     * @depracated use getPage()
  +     * @depreceted use getPage()
        */
       public DynamicURI setPage(String page);
       
  @@ -444,7 +444,7 @@
        * @param paneName Name of desired pane
        * @return DynamicURI that to the desired page
        *
  -     * @depracated use getPage()
  +     * @depreceted use getPage()
        */
       public DynamicURI setPage(String page, String paneName);
       
  @@ -454,7 +454,7 @@
        * @param peid of the portlet
        * @return DynamicURI to specific portlet
        *
  -     * @depracated use getPortletById()
  +     * @depreceted use getPortletById()
        */
       public DynamicURI setPortletById(String peid);
       
  @@ -464,7 +464,7 @@
        * @param peid of the portal element
        * @return DynamicURI to specific portal element
        *
  -     * @depracated use getPortletById or getPaneById()
  +     * @depreceted use getPortletById or getPaneById()
        */
       public DynamicURI setPortalElement(String peid);
       
  @@ -477,7 +477,7 @@
        * @param portletName the name of the portlet to link to
        * @return a DynamicURI referencing the named portlet for easy link 
construction in template
        *
  -     * @depracated use getPortletByName()
  +     * @depreceted use getPortletByName()
        */
       public DynamicURI setPortletByName(String portletName);
       
  @@ -487,7 +487,7 @@
        * @param role Desired role
        * @return DynamicURI that to the desired page
        *
  -     * @depracated use getRole()
  +     * @depreceted use getRole()
        */
       public DynamicURI setRole(String role);
       
  @@ -498,7 +498,7 @@
        * @param page Desired page
        * @return DynamicURI that to the desired page
        *
  -     * @depracated use getRole()
  +     * @depreceted use getRole()
        */
       public DynamicURI setRole(String role, String page);
       
  @@ -508,7 +508,7 @@
        * @param template to add to link
        * @return DynamicURI to specific portlet
        *
  -     * @depracated use getTemplate()
  +     * @depreceted use getTemplate()
        */
       public DynamicURI setTemplate(String template);
       
  @@ -518,7 +518,7 @@
        * @param user Desired user
        * @return DynamicURI that to the desired page
        *
  -     * @depracated use getUser()
  +     * @depreceted use getUser()
        */
       public DynamicURI setUser(String user);
       
  @@ -529,7 +529,7 @@
        * @param user Desired user
        * @return DynamicURI that to the desired page
        *
  -     * @depracated use getUser()
  +     * @depreceted use getUser()
        */
       public DynamicURI setUser(String user, String page);
       
  @@ -566,7 +566,7 @@
       public DynamicURI getPaneByName(String paneName);
   
       /**
  -     * Depracated methods from JetspeedTemplateLink.
  +     * depreceted methods from JetspeedTemplateLink.
        */
       
       /**
  
  
  
  1.13      +20 -20    
jakarta-jetspeed/src/java/org/apache/jetspeed/util/template/BaseJetspeedLink.java
  
  Index: BaseJetspeedLink.java
  ===================================================================
  RCS file: 
/home/cvs/jakarta-jetspeed/src/java/org/apache/jetspeed/util/template/BaseJetspeedLink.java,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- BaseJetspeedLink.java     20 May 2002 12:58:13 -0000      1.12
  +++ BaseJetspeedLink.java     8 Jul 2002 10:44:49 -0000       1.13
  @@ -191,7 +191,7 @@
        * @param peid of the portal element
        * @return DynamicURI to specific portal element
        *
  -     * @depracated Use getPortletById() or getPaneById()
  +     * @deprecated Use getPortletById() or getPaneById()
        */
       public DynamicURI setPortalElement(String peid)
       {
  @@ -246,7 +246,7 @@
        * @param template to add to link
        * @return DynamicURI to specific portlet
        *
  -     * @depracated Use getTemplate()
  +     * @deprecated Use getTemplate()
        */
       public DynamicURI setTemplate(String template)
       {
  @@ -259,7 +259,7 @@
        * @param action Desired action
        * @return DynamicURI that includes the desire action
        *
  -     * @depracated Use getAction()
  +     * @deprecated Use getAction()
        */
       public DynamicURI setAction(String action)
       {
  @@ -274,7 +274,7 @@
        * @param portlets to receive the action
        * @return DynamicURI that includes the desire action
        *
  -     * @depracated Use getAction()
  +     * @deprecated Use getAction()
        */
       public DynamicURI setAction(String action, Portlets portlets)
       {
  @@ -288,7 +288,7 @@
        * @param portlet to receive the action
        * @return DynamicURI that includes the desire action
        *
  -     * @depracated Use getAction()
  +     * @deprecated Use getAction()
        */
       public DynamicURI setAction(String action, Portlet portlet)
       {
  @@ -303,7 +303,7 @@
        * @param entry to receive the action
        * @return DynamicURI that includes the desire action
        *
  -     * @depracated Use getAction()
  +     * @deprecated Use getAction()
        */
       public DynamicURI setAction(String action, Entry entry)
       {
  @@ -317,7 +317,7 @@
        * @param action Desired action
        * @param peid Id of portlet to receive the action
        * @return DynamicURI that includes the desire action
  -     * @depracated Use getAction()
  +     * @deprecated Use getAction()
        */
       public DynamicURI setAction(String action, String peid)
       {
  @@ -330,7 +330,7 @@
        * @param group Desired group
        * @return DynamicURI that to the desired page
        *
  -     * @depracated Use getGroup()
  +     * @deprecated Use getGroup()
        */
       public DynamicURI setGroup(String group)
       {
  @@ -344,7 +344,7 @@
        * @param group Desired group
        * @return DynamicURI that to the desired page
        *
  -     * @depracated Use getGroup()
  +     * @deprecated Use getGroup()
        */
       public DynamicURI setGroup(String group, String page)
       {
  @@ -357,7 +357,7 @@
        *
        * @return DynamicURI that to the desired page
        *
  -     * @depracated Use getPage()
  +     * @deprecated Use getPage()
        */
       public DynamicURI setPage()
       {
  @@ -371,7 +371,7 @@
        * @param page Desired page
        * @return DynamicURI that to the desired page
        *
  -     * @depracated Use getPage()
  +     * @deprecated Use getPage()
        */
       public DynamicURI setPage(String page)
       {
  @@ -385,7 +385,7 @@
        * @param page Desired page
        * @param paneName Desired pane name
        * @return DynamicURI that to the desired page
  -     * @depracated Use getPage()
  +     * @deprecated Use getPage()
        */
       public DynamicURI setPage(String page, String paneName)
       {
  @@ -399,7 +399,7 @@
        * @param role Desired role
        * @return DynamicURI that to the desired page
        *
  -     * @depracated use getRole()
  +     * @deprecated use getRole()
        */
       public DynamicURI setRole(String role)
       {
  @@ -413,7 +413,7 @@
        * @param page Desired page
        * @return DynamicURI that to the desired page
        *
  -     * @depracated use getRole()
  +     * @deprecated use getRole()
        */
       public DynamicURI setRole(String role, String page)
       {
  @@ -426,7 +426,7 @@
        * @param user Desired user
        * @return DynamicURI that to the desired page
        *
  -     * @depracated Use getUser()
  +     * @deprecated Use getUser()
        */
       public DynamicURI setUser(String user)
       {
  @@ -440,7 +440,7 @@
        * @param user Desired user
        * @return DynamicURI that to the desired page
        *
  -     * @depracated  Use getUser()
  +     * @deprecated  Use getUser()
        */
       public DynamicURI setUser(String user, String page)
       {
  @@ -453,7 +453,7 @@
        * @param paneId of the Pane
        * @return URI to specific portlet
        *
  -     * @depracated Use getPaneById()
  +     * @deprecated Use getPaneById()
        */
       public DynamicURI setPaneById(String paneId)
       {
  @@ -465,7 +465,7 @@
        *
        * @param paneName Name of the Pane
        * @return URI to specific portlet
  -     * @depracated Use getPaneByName()
  +     * @deprecated Use getPaneByName()
        */
       public DynamicURI setPaneByName(String paneName)
       {
  @@ -1156,7 +1156,7 @@
       }
       
       /**
  -     * Depracated methods from JetspeedTemplateLink.
  +     * deprecated methods from JetspeedTemplateLink.
        */
       
       /**
  
  
  
  1.3       +24 -14    
jakarta-jetspeed/src/java/org/apache/jetspeed/om/profile/psml/PsmlIdentityElement.java
  
  Index: PsmlIdentityElement.java
  ===================================================================
  RCS file: 
/home/cvs/jakarta-jetspeed/src/java/org/apache/jetspeed/om/profile/psml/PsmlIdentityElement.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- PsmlIdentityElement.java  21 May 2002 10:13:49 -0000      1.2
  +++ PsmlIdentityElement.java  8 Jul 2002 10:44:49 -0000       1.3
  @@ -85,7 +85,7 @@
       public PsmlIdentityElement()
       {}
   
  -    /** @see org.apache.jetspeed.om.registry.RegistryEntry#getId */
  +    /** @see org.apache.jetspeed.om.profile.IdentityElement#getId */
       public String getId()
       {
           if (this.id == null)
  @@ -95,37 +95,43 @@
           return this.id;
       }
                                   
  -    /** @see org.apache.jetspeed.om.registry.RegistryEntry#setId */
  +    /** @see org.apache.jetspeed.om.profile.IdentityElement#setId */
       public void setId( String id )
       {
           this.id = id;
       }
     
  +    /** @see org.apache.jetspeed.om.profile.IdentityElement#getSkin */
       public Skin getSkin()
       {
           return this.skin;
       }
   
  +    /** @see org.apache.jetspeed.om.profile.IdentityElement#setSkin */
       public void setSkin(Skin skin)
       {
           this.skin = skin;
       }
   
  +    /** @see org.apache.jetspeed.om.profile.IdentityElement#getLayout */
       public Layout getLayout()
       {
           return this.layout;
       }
   
  +    /** @see org.apache.jetspeed.om.profile.IdentityElement#setLayout */
       public void setLayout(Layout layout)
       {
           this.layout = layout;
       }
   
  +    /** @see org.apache.jetspeed.om.profile.IdentityElement#getControl */
       public Control getControl()
       {
           return this.control;
       }
   
  +    /** @see org.apache.jetspeed.om.profile.IdentityElement#setControl */
       public void setControl(Control control)
       {
           this.control = control;
  @@ -144,16 +150,20 @@
   
       // Castor serialization methods
       
  -    /** Required by Castor 0.8.11 XML serialization for retrieving the metainfo
  -      */
  +    /**
  +     * Required by Castor 0.8.11 XML serialization for retrieving the metainfo
  +     * @see org.apache.jetspeed.om.profile.IdentityElement#getMetaInfo 
  +     */
       public MetaInfo getMetaInfo()
       {
           return this.metaInfo;
       }
                                   
  -    /** Required by Castor 0.8.11 XML serialization for setting the entry
  -      * metainfo
  -      */
  +    /** 
  +     * Required by Castor 0.8.11 XML serialization for setting the entry
  +     * metainfo
  +     * @see org.apache.jetspeed.om.profile.IdentityElement#setMetaInfo 
  +     */
       public void setMetaInfo( MetaInfo metaInfo )
       {
           this.metaInfo = metaInfo;
  @@ -161,7 +171,7 @@
   
       // helper getter setters into meta info
   
  -    /** @see org.apache.jetspeed.om.registry.MetaInfo#getTitle */
  +    /** @see org.apache.jetspeed.om.profile.MetaInfo#getTitle */
       public String getTitle()
       {
           if (this.metaInfo != null)
  @@ -172,7 +182,7 @@
           return null;
       }
                                   
  -    /** @see org.apache.jetspeed.om.registry.MetaInfo#setTitle */
  +    /** @see org.apache.jetspeed.om.profile.MetaInfo#setTitle */
       public void setTitle(String title)
       {
           if (this.metaInfo == null)
  @@ -183,7 +193,7 @@
           this.metaInfo.setTitle(title);
       }
   
  -    /** @see org.apache.jetspeed.om.registry.MetaInfo#getDescription */
  +    /** @see org.apache.jetspeed.om.profile.MetaInfo#getDescription */
       public String getDescription()
       {
           if (this.metaInfo != null)
  @@ -194,7 +204,7 @@
           return null;
       }
                                   
  -    /** @see org.apache.jetspeed.om.registry.MetaInfo#setDescription */
  +    /** @see org.apache.jetspeed.om.profile.MetaInfo#setDescription */
       public void setDescription(String description)
       {
           if (this.metaInfo == null)
  @@ -205,7 +215,7 @@
           this.metaInfo.setDescription(description);
       }
   
  -    /** @see org.apache.jetspeed.om.registry.MetaInfo#getImage */
  +    /** @see org.apache.jetspeed.om.profile.MetaInfo#getImage */
       public String getImage()
       {
           if (this.metaInfo != null)
  @@ -216,7 +226,7 @@
           return null;
       }
                                   
  -    /** @see org.apache.jetspeed.om.registry.MetaInfo#setImage */
  +    /** @see org.apache.jetspeed.om.profile.MetaInfo#setImage */
       public void setImage(String image)
       {
           if (this.metaInfo == null)
  
  
  

--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to