Author: painter
Date: Mon Nov  5 15:54:33 2018
New Revision: 1845818

URL: http://svn.apache.org/viewvc?rev=1845818&view=rev
Log:
Fix/update javadoc for fulcrum-intake

Modified:
    
turbine/fulcrum/trunk/intake/src/java/org/apache/fulcrum/intake/IntakeServiceImpl.java
    
turbine/fulcrum/trunk/intake/src/java/org/apache/fulcrum/intake/model/FieldType.java
    
turbine/fulcrum/trunk/intake/src/test/org/apache/fulcrum/intake/IntakeServiceTest.java

Modified: 
turbine/fulcrum/trunk/intake/src/java/org/apache/fulcrum/intake/IntakeServiceImpl.java
URL: 
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/intake/src/java/org/apache/fulcrum/intake/IntakeServiceImpl.java?rev=1845818&r1=1845817&r2=1845818&view=diff
==============================================================================
--- 
turbine/fulcrum/trunk/intake/src/java/org/apache/fulcrum/intake/IntakeServiceImpl.java
 (original)
+++ 
turbine/fulcrum/trunk/intake/src/java/org/apache/fulcrum/intake/IntakeServiceImpl.java
 Mon Nov  5 15:54:33 2018
@@ -68,13 +68,13 @@ import org.apache.fulcrum.intake.model.G
  * This service provides access to input processing objects based on an XML
  * specification.
  *
+ * avalon.component name="intake"
+ * avalon.service type="org.apache.fulcrum.intake.IntakeService"
+ *
  * @author <a href="mailto:jmcna...@collab.net";>John McNally</a>
  * @author <a href="mailto:h...@intermeta.de";>Henning P. Schmiedehausen</a>
  * @author <a href="mailto:quint...@bellsouth.net";>Quinton McCombs</a>
  * @version $Id$
- *
- * @avalon.component name="intake"
- * @avalon.service type="org.apache.fulcrum.intake.IntakeService"
  */
 public class IntakeServiceImpl extends AbstractLogEnabled implements
         IntakeService, Configurable, Initializable, Contextualizable,
@@ -880,8 +880,13 @@ public class IntakeServiceImpl extends A
     }
 
     /**
-     * @see org.apache.avalon.framework.context.Contextualizable
-     * @avalon.entry key="urn:avalon:home" type="java.io.File"
+     * Note that the avalon.entry key="urn:avalon:home" 
+     * and the type is {@link java.io.File}
+     * 
+     * {@link 
org.apache.avalon.framework.context.Contextualizable#contextualize(Context)}
+     * 
+     * @param context the Context to use
+     * @throws ContextException if the context is not found
      */
     @Override
     public void contextualize(Context context) throws ContextException
@@ -892,7 +897,10 @@ public class IntakeServiceImpl extends A
     /**
      * Avalon component lifecycle method
      *
-     * @avalon.dependency 
type="org.apache.fulcrum.localization.LocalizationService"
+     * avalon.dependency 
type="org.apache.fulcrum.localization.LocalizationService"
+     * 
+     * @param manager the service manager
+     * @throws ServiceException generic exception
      */
     @Override
     public void service(ServiceManager manager) throws ServiceException

Modified: 
turbine/fulcrum/trunk/intake/src/java/org/apache/fulcrum/intake/model/FieldType.java
URL: 
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/intake/src/java/org/apache/fulcrum/intake/model/FieldType.java?rev=1845818&r1=1845817&r2=1845818&view=diff
==============================================================================
--- 
turbine/fulcrum/trunk/intake/src/java/org/apache/fulcrum/intake/model/FieldType.java
 (original)
+++ 
turbine/fulcrum/trunk/intake/src/java/org/apache/fulcrum/intake/model/FieldType.java
 Mon Nov  5 15:54:33 2018
@@ -211,10 +211,9 @@ public enum FieldType implements Seriali
      *
      * @param f the XML object
      * @param g the group this field belongs to
-     * @return a Field<?> instance
+     * @return a Field&lt;?&gt; instance
      *
-     * @throws IntakeException
-     *             if the field could not be created
+     * @throws IntakeException if the field could not be created
      */
     public abstract Field<?> getInstance(XmlField f, Group g) throws 
IntakeException;
 }

Modified: 
turbine/fulcrum/trunk/intake/src/test/org/apache/fulcrum/intake/IntakeServiceTest.java
URL: 
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/intake/src/test/org/apache/fulcrum/intake/IntakeServiceTest.java?rev=1845818&r1=1845817&r2=1845818&view=diff
==============================================================================
--- 
turbine/fulcrum/trunk/intake/src/test/org/apache/fulcrum/intake/IntakeServiceTest.java
 (original)
+++ 
turbine/fulcrum/trunk/intake/src/test/org/apache/fulcrum/intake/IntakeServiceTest.java
 Mon Nov  5 15:54:33 2018
@@ -34,8 +34,6 @@ import org.junit.Test;
 /**
  * @author Eric Pugh
  *
- * To change the template for this generated type comment go to
- * Window>Preferences>Java>Code Generation>Code and Comments
  */
 public class IntakeServiceTest extends BaseUnit4Test
 {


Reply via email to