Javadoc fixes

This commit is contained in:
Rossen Stoyanchev
2018-09-11 15:28:02 -04:00
parent e4b6b9e8a6
commit 832e6c6c43
9 changed files with 16 additions and 19 deletions

View File

@@ -33,7 +33,7 @@ import org.springframework.core.GenericCollectionTypeResolver;
* Special converter that converts from a source array to a target collection. Supports the selection of an
* "approximate" collection implementation when a target collection interface such as <code>List.class</code> is
* specified. Supports type conversion of array elements when a concrete parameterized collection class is provided,
* such as <code>IntegerList<Integer>.class</code>.
* such as {@code List<Integer>}.
*
* Note that type erasure prevents arbitrary access to generic collection element type information at runtime,
* preventing the ability to convert elements for collections declared as properties.

View File

@@ -176,6 +176,7 @@ import org.springframework.webflow.execution.ScopeType;
* <p>
* <b>FormAction configurable properties</b><br>
* <table border="1">
* <caption>Configurable Properties</caption>
* <tr>
* <td><b>name</b></td>
* <td><b>default</b></td>

View File

@@ -23,6 +23,7 @@ import org.springframework.webflow.execution.RequestContext;
* Result object-to-event adapter interface that tries to do a sensible conversion of the result object into a web flow
* event. It uses the following conversion table:
* <table border="1">
* <caption>Result to Event Id Conversion</caption>
* <tr>
* <th>Result object type</th>
* <th>Event id</th>
@@ -40,11 +41,6 @@ import org.springframework.webflow.execution.RequestContext;
* <td>&nbsp;</td>
* </tr>
* <tr>
* <td>{@link org.springframework.core.enums.LabeledEnum}</td>
* <td>{@link org.springframework.core.enums.LabeledEnum#getLabel()}</td>
* <td>The result object will included in the event as an attribute named "result".</td>
* </tr>
* <tr>
* <td>{@link java.lang.Enum}</td>
* <td>{@link java.lang.Enum#name()}</td>
* <td>The result object will included in the event as an attribute named "result".</td>

View File

@@ -67,7 +67,7 @@ public class FlowDefinitionRegistryBuilder {
/**
* Create a new instance with the given ApplicationContext.
*
* @param applicationContext the ApplicationContext to use for initializing the
* @param appContext the ApplicationContext to use for initializing the
* FlowDefinitionResourceFactory and FlowBuilderServices instances with
*/
public FlowDefinitionRegistryBuilder(ApplicationContext appContext) {
@@ -77,7 +77,7 @@ public class FlowDefinitionRegistryBuilder {
/**
* Create a new instance with the given ApplicationContext and {@link FlowBuilderServices}.
*
* @param applicationContext the ApplicationContext to use for initializing the
* @param appContext the ApplicationContext to use for initializing the
* FlowDefinitionResourceFactory and FlowBuilderServices instances with
* @param builderServices a {@link FlowBuilderServices} instance to configure
* on the FlowDefinitionRegistry

View File

@@ -32,7 +32,8 @@ import org.springframework.webflow.mvc.servlet.FlowController;
* <p>
* This implementation extracts the filename and removes the file extension from the request URL. The results will be
* used as the flow Id that must be unique throughout the application.
*
*
* <p>
* For example the URLs
*
* <pre>
@@ -42,8 +43,7 @@ import org.springframework.webflow.mvc.servlet.FlowController;
* </pre>
*
* will all treat the filename "foo" as the flow id.
* </p>
*
*
* <strong>Note:</strong> Because this class only treats a filename as a flow id, clashes can result. For example:
*
* <pre>

View File

@@ -29,7 +29,7 @@ import org.springframework.webflow.execution.RequestContext;
* A path from one {@link TransitionableState state} to another {@link State state}.
* <p>
* When executed a transition takes a flow execution from its current state, called the <i>source state</i>, to another
* state, called the </i>target state</i>. A transition may become eligible for execution on the occurrence of an
* state, called the <i>target state</i>. A transition may become eligible for execution on the occurrence of an
* {@link Event} from within a transitionable source state.
* <p>
* When an event occurs within this transition's source <code>TransitionableState</code> the determination of the
@@ -246,4 +246,4 @@ public class Transition extends AnnotatedObject implements TransitionDefinition
return new ToStringCreator(this).append("on", getMatchingCriteria()).append("to", getTargetStateResolver())
.toString();
}
}
}

View File

@@ -57,8 +57,8 @@ import org.springframework.webflow.execution.View;
/**
* Default implementation of FlowExecution that uses a stack-based data structure to manage spawned flow sessions. This
* class is closely coupled with package-private <code>FlowSessionImpl</code> and <code>RequestControlContextImpl</code>
* . The three classes work together to form a complete flow execution implementation based on a finite state machine.
* class is closely coupled with package-private <code>FlowSessionImpl</code> and <code>RequestControlContextImpl</code>.
* The three classes work together to form a complete flow execution implementation based on a finite state machine.
* <p>
* This implementation of FlowExecution is serializable so it can be safely stored in an HTTP session or other
* persistent store such as a file, database, or client-side form field. Once deserialized, the

View File

@@ -33,7 +33,7 @@ import org.xml.sax.SAXException;
/**
* The default document loader strategy for XSD-based XML documents with validation enabled by default.
* <p>
* Note: full XSD support requires JDK 5.0 or a capable parser such as Xerces 2.0. JDK 1.4 or < do not fully support XSD
* Note: full XSD support requires JDK 5.0 or a capable parser such as Xerces 2.0. JDK 1.4 or &lt; do not fully support XSD
* out of the box. To use this implementation on JDK 1.4 make sure Xerces is available in your classpath or disable XSD
* validation by {@link #setValidating(boolean) setting the validating property to false}.
*

View File

@@ -41,6 +41,7 @@ import org.springframework.webflow.execution.repository.FlowExecutionRepository;
* <p>
* <b>Commonly used configurable properties</b><br>
* <table border="1">
* <caption>Configurable Properties</caption>
* <tr>
* <td><b>name</b></td>
* <td><b>description</b></td>
@@ -62,8 +63,7 @@ import org.springframework.webflow.execution.repository.FlowExecutionRepository;
* <td>None</td>
* </tr>
* </table>
* </p>
*
*
* @see FlowDefinitionLocator
* @see FlowExecutionFactory
* @see FlowExecutionRepository
@@ -191,4 +191,4 @@ public class FlowExecutorImpl implements FlowExecutor {
.toString());
}
}
}