You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2013/08/10 00:23:52 UTC
svn commit: r1512516 - in /uima/sandbox/uimafit/trunk:
uimafit-core/src/main/java/org/apache/uima/fit/descriptor/
uimafit-core/src/main/java/org/apache/uima/fit/testing/factory/
uimafit-examples/src/main/java/org/apache/uima/fit/examples/tutorial/ex2/
Author: rec
Date: Fri Aug 9 22:23:51 2013
New Revision: 1512516
URL: http://svn.apache.org/r1512516
Log:
[UIMA-3169] Fix JavaDoc warnings
Modified:
uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/SofaCapability.java
uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/TypeCapability.java
uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/testing/factory/TokenBuilder.java
uima/sandbox/uimafit/trunk/uimafit-examples/src/main/java/org/apache/uima/fit/examples/tutorial/ex2/RoomNumberAnnotator.java
Modified: uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/SofaCapability.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/SofaCapability.java?rev=1512516&r1=1512515&r2=1512516&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/SofaCapability.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/SofaCapability.java Fri Aug 9 22:23:51 2013
@@ -25,13 +25,13 @@ import java.lang.annotation.Target;
/**
*
- * <pre>{@code
- * @SofaCapability(inputSofas = { GOLD_VIEW, SYSTEM_VIEW })
- * }</pre>
+ * <code><pre>
+ * {@literal @}SofaCapability(inputSofas = { GOLD_VIEW, SYSTEM_VIEW })
+ * </pre></code>
* or
- * <pre>{@code
- * @SofaCapability(inputSofas = CAS.NAME_DEFAULT_SOFA, outputSofas = GOLD_VIEW)
- * }</pre>
+ * <code><pre>
+ * {@literal @}SofaCapability(inputSofas = CAS.NAME_DEFAULT_SOFA, outputSofas = GOLD_VIEW)
+ * </pre></code>
*
* Adding this annotation to your analysis engine description makes your component "sofa aware." The
* base CAS delivered to "sofa aware" components has no explicit view associated with it. The logic
@@ -39,7 +39,9 @@ import java.lang.annotation.Target;
* as needed. You should therefore be aware that if you need to work with the "_InitialView" view,
* then you must explicitly request it with a call like:
*
+ * <code><pre>
* JCas initialView = jCas.getView(CAS.NAME_DEFAULT_SOFA);
+ * </pre></code>
*
* This is because the base CAS that it passed into the process method to "sofa aware" components is
* not the same as the "_InitialView". See how the following member variable is used to understand
Modified: uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/TypeCapability.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/TypeCapability.java?rev=1512516&r1=1512515&r2=1512516&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/TypeCapability.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/descriptor/TypeCapability.java Fri Aug 9 22:23:51 2013
@@ -26,19 +26,19 @@ import java.lang.annotation.Target;
/**
* A typical use of this annotation might look something like:
*
- * <pre>{@code
- * @TypeCapability(
+ * <code><pre>
+ * {@literal @}TypeCapability(
* inputs="org.apache.uima.fit.type.Token",
* outputs="org.apache.uima.fit.type.Token:pos")
- * }</pre>
+ * </code></pre>
*
* or
*
- * <pre>{@code
- * @TypeCapability(
+ * <code><pre>
+ * {@literal @}TypeCapability(
* inputs={"org.apache.uima.fit.type.Token","org.apache.uima.fit.type.Sentence"},
* outputs={"org.apache.uima.fit.type.Token:pos", "org.apache.uima.tutorial.RoomNumber"})
- * }</pre>
+ * </code></pre>
*
*/
Modified: uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/testing/factory/TokenBuilder.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/testing/factory/TokenBuilder.java?rev=1512516&r1=1512515&r2=1512516&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/testing/factory/TokenBuilder.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-core/src/main/java/org/apache/uima/fit/testing/factory/TokenBuilder.java Fri Aug 9 22:23:51 2013
@@ -34,9 +34,9 @@ import org.apache.uima.jcas.tcas.Annotat
*
*
* @param <TOKEN_TYPE>
- * the type system token type (e.g. {@link org.apache.uima.fit.examples.type.Token})
+ * the type system token type (e.g. {@code org.apache.uima.fit.examples.type.Token})
* @param <SENTENCE_TYPE>
- * the type system sentence type (e.g. {@link org.apache.uima.fit.examples.type.Sentence})
+ * the type system sentence type (e.g. {@code org.apache.uima.fit.examples.type.Sentence})
*/
public class TokenBuilder<TOKEN_TYPE extends Annotation, SENTENCE_TYPE extends Annotation> {
@@ -88,13 +88,13 @@ public class TokenBuilder<TOKEN_TYPE ext
* @param <T>
* the type system token type (e.g. org.apache.uima.fit.examples.type.Token)
* @param <S>
- * the type system sentence type (e.g. {@link org.apache.uima.fit.examples.type.Sentence})
+ * the type system sentence type (e.g. {@code org.apache.uima.fit.examples.type.Sentence})
* @param tokenClass
* the class of your token type from your type system (e.g.
- * {@link org.apache.uima.fit.type.Token})
+ * {@code org.apache.uima.fit.type.Token})
* @param sentenceClass
* the class of your sentence type from your type system (e.g.
- * {@link org.apache.uima.fit.type.Sentence})
+ * {@code org.apache.uima.fit.type.Sentence})
* @return the builder.
*/
public static <T extends Annotation, S extends Annotation> TokenBuilder<T, S> create(
Modified: uima/sandbox/uimafit/trunk/uimafit-examples/src/main/java/org/apache/uima/fit/examples/tutorial/ex2/RoomNumberAnnotator.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-examples/src/main/java/org/apache/uima/fit/examples/tutorial/ex2/RoomNumberAnnotator.java?rev=1512516&r1=1512515&r2=1512516&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-examples/src/main/java/org/apache/uima/fit/examples/tutorial/ex2/RoomNumberAnnotator.java (original)
+++ uima/sandbox/uimafit/trunk/uimafit-examples/src/main/java/org/apache/uima/fit/examples/tutorial/ex2/RoomNumberAnnotator.java Fri Aug 9 22:23:51 2013
@@ -35,7 +35,7 @@ import org.apache.uima.util.Level;
* Defining configuration parameters in this way in combination with using the
* {@link JCasAnnotator_ImplBase uimaFIT's JCasAnnotator_ImplBase} class obviates the need for an
* initialize method at all because the super class initialize method calls
- * {@link ConfigurationParameterInitializer#initializeConfigurationParameters}. This method
+ * {@link ConfigurationParameterInitializer#initialize}. This method
* initializes member variables annotated as configuration parameters using the configuration
* parameter information provided in the UimaContext.
*