You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2014/12/16 15:08:54 UTC
svn commit: r1645956 - in /uima/uimaj/trunk:
uimaj-core/src/main/java/org/apache/uima/cas/impl/
uimaj-core/src/main/java/org/apache/uima/internal/util/
uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/
uimaj-examples/src/main/java/org/ap...
Author: schor
Date: Tue Dec 16 14:08:53 2014
New Revision: 1645956
URL: http://svn.apache.org/r1645956
Log:
no Jira - update javadocs to correct lint errors
Modified:
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntArrayIndex.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/Int2IntHashMap.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/IntHashSet.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/PositiveIntSet_impl.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/MetaDataObject_impl.java
uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/cas/RegExAnnotator.java
uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/Ecore2UimaTypeSystem.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/RunAE.java
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntArrayIndex.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntArrayIndex.java?rev=1645956&r1=1645955&r2=1645956&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntArrayIndex.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIntArrayIndex.java Tue Dec 16 14:08:53 2014
@@ -302,7 +302,7 @@ public class FSIntArrayIndex<T extends F
* In a sorted array of fsAddrs, find the lowest one that matches the keys in fsRef, or
* if none match, return a negative number of insertion point if not found
* @param fsRef
- * @return
+ * @return index of an arbitrary FS that matches on the compare function or a negative number of insertion point if not found
*/
private final int find(int fsRef) {
return binarySearch(this.index.getArray(), fsRef, 0, this.index.size());
@@ -339,7 +339,7 @@ public class FSIntArrayIndex<T extends F
/**
* Like find, but if found, returns position of Exact FS spot or neg of an insert spot (if no == match)
* @param fsRef
- * @return
+ * @return position of Exact FS spot or neg of an insert spot (if no == match)
*/
private final int findEq(int fsRef) {
int pos = find(fsRef);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/Int2IntHashMap.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/Int2IntHashMap.java?rev=1645956&r1=1645955&r2=1645956&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/Int2IntHashMap.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/Int2IntHashMap.java Tue Dec 16 14:08:53 2014
@@ -384,7 +384,7 @@ public class Int2IntHashMap {
/**
* advance pos until it points to a non 0 or is 1 past end
* @param pos
- * @return
+ * @return updated pos
*/
private int moveToNextFilled(int pos) {
if (pos < 0) {
@@ -406,7 +406,7 @@ public class Int2IntHashMap {
/**
* decrement pos until it points to a non 0 or is -1
* @param pos
- * @return
+ * @return updated pos
*/
private int moveToPreviousFilled(int pos) {
final int max = keys.length;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/IntHashSet.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/IntHashSet.java?rev=1645956&r1=1645955&r2=1645956&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/IntHashSet.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/IntHashSet.java Tue Dec 16 14:08:53 2014
@@ -518,7 +518,7 @@ public class IntHashSet implements Posit
/**
* advance pos until it points to a non 0 or is 1 past end
* @param pos
- * @return
+ * @return updated pos
*/
private int moveToNextFilled(int pos) {
if (pos < 0) {
@@ -540,7 +540,7 @@ public class IntHashSet implements Posit
/**
* decrement pos until it points to a non 0 or is -1
* @param pos
- * @return
+ * @return updated pos
*/
private int moveToPreviousFilled(int pos) {
final int max = getCapacity();
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/PositiveIntSet_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/PositiveIntSet_impl.java?rev=1645956&r1=1645955&r2=1645956&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/PositiveIntSet_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/internal/util/PositiveIntSet_impl.java Tue Dec 16 14:08:53 2014
@@ -393,7 +393,7 @@ public class PositiveIntSet_impl impleme
* returns new hash table size ( usually double) + overhead
*
* @param numberOfEntries
- * @return
+ * @return new hash table size ( usually double) + overhead
*/
private int getHashSetSpace() {
return ((IntHashSet)intSet).getSpaceUsedInWords() * 2 + IntHashSet.getSpaceOverheadInWords();
@@ -426,7 +426,7 @@ public class PositiveIntSet_impl impleme
* could be a large.
*
* @param existingSize
- * @return
+ * @return overallocate size
*/
private static int getHashSetOverAllocateSize(int existingSize) {
return existingSize + (existingSize >> HASH_SET_OVERALLOCATE_DIVIDER_SHIFT);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/MetaDataObject_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/MetaDataObject_impl.java?rev=1645956&r1=1645955&r2=1645956&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/MetaDataObject_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/metadata/impl/MetaDataObject_impl.java Tue Dec 16 14:08:53 2014
@@ -286,7 +286,6 @@ public abstract class MetaDataObject_imp
* Any class which wants to add additional parameters needs to implement / override
* getAdditionalParameters.
* @return an array of Attribute objects associated with this class
- * @throws
*/
MetaDataAttr[] getAttributes() {
final Class<? extends MetaDataObject_impl> clazz = this.getClass();
Modified: uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/cas/RegExAnnotator.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/cas/RegExAnnotator.java?rev=1645956&r1=1645955&r2=1645956&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/cas/RegExAnnotator.java (original)
+++ uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/cas/RegExAnnotator.java Tue Dec 16 14:08:53 2014
@@ -252,10 +252,7 @@ public class RegExAnnotator extends CasA
* parameters.
*
* @param aCAS
- * the CAS to process
- * @param aResultSpec
- * A list of outputs that this annotator should produce.
- *
+ * the CAS to process
* @throws AnnotatorProcessException
* if a failure occurs during processing.
*
Modified: uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/Ecore2UimaTypeSystem.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/Ecore2UimaTypeSystem.java?rev=1645956&r1=1645955&r2=1645956&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/Ecore2UimaTypeSystem.java (original)
+++ uima/uimaj/trunk/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/Ecore2UimaTypeSystem.java Tue Dec 16 14:08:53 2014
@@ -319,8 +319,8 @@ public class Ecore2UimaTypeSystem {
}
/**
- * @param attr
- * @return
+ * @param attr -
+ * @return -
*/
private static FeatureDescription eStructuralFeature2UimaFeature(
EStructuralFeature aStructuralFeature, Map aOptions) throws URISyntaxException {
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/RunAE.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/RunAE.java?rev=1645956&r1=1645955&r2=1645956&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/RunAE.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/RunAE.java Tue Dec 16 14:08:53 2014
@@ -50,7 +50,7 @@ import org.apache.uima.util.AnalysisEngi
* An example application that reads documents from the file system, sends them though an Analysis
* Engine(AE), and produces XML files with inline annotations. This application uses a
* {@link CollectionProcessingEngine} to drive the processing. For a simpler introduction to using
- * AEs in an application, see {@link ExampleApplication}.
+ * AEs in an application, see class ExampleApplication in the uimaj-examples project.
* <p>
* <code>Usage: java org.apache.uima.examples.RunAE [OPTIONS]
* <AE descriptor or JAR file name> <input dir>