Commits

Anonymous committed 9d26fab

cleaning up javadoc issues
Obtained from:
Submitted by:
Reviewed by:

git-svn-id: http://svn.opensymphony.com/svn/xwork/trunk@789e221344d-f017-0410-9bd5-d282ab1896d7

Comments (0)

Files changed (12)

src/java/com/opensymphony/xwork/ActionProxyFactory.java

      *
      * @param actionProxy
      * @param extraContext
-     * @return
+     * @return ActionInvocation
      * @throws Exception
      */
     public abstract ActionInvocation createActionInvocation(ActionProxy actionProxy, Map extraContext) throws Exception;
      * as part of creating an ActionProxy. Client code should not need to call the createActionInvocation methods.
      *
      * @param actionProxy
-     * @return
+     * @return ActionInvocation
      * @throws Exception
      */
     public abstract ActionInvocation createActionInvocation(ActionProxy actionProxy) throws Exception;
      * @param actionProxy
      * @param extraContext
      * @param pushAction   tells whether the Action should be pushed onto the ValueStack
-     * @return
+     * @return ActionInvocation
      * @throws Exception
      */
     public abstract ActionInvocation createActionInvocation(ActionProxy actionProxy, Map extraContext, boolean pushAction) throws Exception;
      * @param namespace    the namespace of the action
      * @param actionName
      * @param extraContext a Map of extra parameters to be provided to the ActionProxy
-     * @return
+     * @return ActionProxy
      * @throws Exception
      */
     public abstract ActionProxy createActionProxy(String namespace, String actionName, Map extraContext) throws Exception;
      * @param extraContext  a Map of extra parameters to be provided to the ActionProxy
      * @param executeResult flag which tells whether the result should be executed after the action
      * @param cleanupContext
-     * @return
+     * @return ActionProxy
      * @throws Exception
      */
     public abstract ActionProxy createActionProxy(String namespace, String actionName, Map extraContext, boolean executeResult, boolean cleanupContext) throws Exception;

src/java/com/opensymphony/xwork/ObjectFactory.java

      * @param namespace the namespace the action is configured in
      * @param config the action configuration found in the config for the actionName / namespace
      * @param extraContext a Map of extra context which uses the same keys as the {@link com.opensymphony.xwork.ActionContext}
-     * @return
+     * @return instance of the action class to handle a web request
      * @throws Exception
      */
     public Object buildAction(String actionName, String namespace, ActionConfig config, Map extraContext) throws Exception {

src/java/com/opensymphony/xwork/config/Configuration.java

      * the current runtime configuration.  currently, if changes have been made to the Configuration since the last
      * time buildRuntimeConfiguration() was called, you'll need to make sure to
      *
-     * @return
+     * @return the current runtime configuration
      */
     RuntimeConfiguration getRuntimeConfiguration();
 

src/java/com/opensymphony/xwork/config/ConfigurationManager.java

      * ConfigurationProvider has been added, then the XmlConfigurationProvider must be added by hand.
      * </p>
      *
+     * TODO: the lazy instantiation of XmlConfigurationProvider should be refactored to be elsewhere.  the behavior described above seems unintuitive.
+     *
      * @return the list of registered ConfigurationProvider objects
-     * @todo the lazy instantiation of XmlConfigurationProvider should be refactored to be elsewhere.  the behavior described above seems unintuitive.
      * @see com.opensymphony.xwork.config.ConfigurationProvider
      */
     public static List getConfigurationProviders() {
     /**
      * reloads the Configuration files if the configuration files indicate that they need to be reloaded.
      *
-     * @todo as FileManager.setReloadingConfigs never appears to be set anywhere, will this ever do anything?
-     * @todo it currently appears that the reload strategy is to check on each call to getConfiguration().  this seems extremely burdensome.  a caching mechanism should be implemented
+     * TODO: as FileManager.setReloadingConfigs never appears to be set anywhere, will this ever do anything?
+     * TODO: it currently appears that the reload strategy is to check on each call to getConfiguration().  this seems extremely burdensome.  a caching mechanism should be implemented
      */
     private static synchronized void conditionalReload() {
         if (FileManager.isReloadingConfigs()) {

src/java/com/opensymphony/xwork/config/ConfigurationProvider.java

     /**
      * Tells whether the ConfigurationProvider should reload its configuration
      *
-     * @return
+     * @return <tt>true</tt>, whether the ConfigurationProvider should reload its configuration, <tt>false</tt>otherwise.
      */
     public boolean needsReload();
 }

src/java/com/opensymphony/xwork/config/providers/InterceptorBuilder.java

      * @param packageConfig
      * @param refName
      * @param refParams
-     * @return
+     * @return list of interceptors referenced by the refName in the supplied PackageConfig.
      * @throws ConfigurationException
      */
     public static List constructInterceptorReference(PackageConfig packageConfig, String refName, Map refParams) throws ConfigurationException {

src/java/com/opensymphony/xwork/interceptor/AbstractLifecycleInterceptor.java

      * request by the DefaultActionInvocation or to short-circuit the processing and just return a String return code.
      *
      * @param invocation
-     * @return
+     * @return result
      * @throws Exception
      */
     public String intercept(ActionInvocation invocation) throws Exception {

src/java/com/opensymphony/xwork/interceptor/ParameterFilterInterceptor.java

     
     /**
      * @param c
-     * @return
+     * @return <tt>true</tt>, if char is property separator, <tt>false</tt> otherwise.
      */
     private boolean isPropSeperator(char c) {
         // TODO Auto-generated method stub
         return defaultBlock;
     }
     /**
-     * @param defaultBlock The defaultBlock to set.
+     * @param defaultExclude The defaultExclude to set.
      */
     public void setDefaultBlock(boolean defaultExclude) {
         this.defaultBlock = defaultExclude;

src/java/com/opensymphony/xwork/spring/SpringProxyableObjectFactory.java

     /**
      * Subclasses may override this to return a different application context.
      * Note that this application context should see any changes made to the
-     * {@link autoWiringFactory}, so the application context should be either
+     * {@link #autoWiringFactory}, so the application context should be either
      * the original or a child context of the original.
      * @param context
      */

src/java/com/opensymphony/xwork/spring/interceptor/ActionAutowiringInterceptor.java

     }
 
     /**
-     * @return
+     * @return context
      */
     protected ApplicationContext getApplicationContext() {
         return context;

src/java/com/opensymphony/xwork/util/InstantiatingNullHandler.java

  * references.</li>
  *
  * <li>If the null property is a simple bean with a no-arg constructor, it will simply be created using the {@link
- * ObjectFactory#buildBean(Class)} method.</li>
+ * ObjectFactory#buildBean(java.lang.Class, java.util.Map)} method.</li>
  *
  * </ul>
  *

src/java/overview.html

+<body>
+This document is the API specification for <a href="http://wiki.opensymphony.com/space/XWork" target="_blank">XWork 1.1.1</a>.
+</body>