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 2013/09/09 16:35:35 UTC
svn commit: r1521141 - in
/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl:
OptimizeStrings.java ProcessTrace_impl.java SerializationMeasures.java
XMLParser_impl.java
Author: schor
Date: Mon Sep 9 14:35:34 2013
New Revision: 1521141
URL: http://svn.apache.org/r1521141
Log:
[UIMA-3256] fixup Javadocs
Modified:
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/OptimizeStrings.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/ProcessTrace_impl.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/SerializationMeasures.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/XMLParser_impl.java
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/OptimizeStrings.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/OptimizeStrings.java?rev=1521141&r1=1521140&r2=1521141&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/OptimizeStrings.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/OptimizeStrings.java Mon Sep 9 14:35:34 2013
@@ -119,7 +119,7 @@ public class OptimizeStrings {
/**
* The number of characters saved - for statistical reporting only
- * @return
+ * @return the number of characters saved
*/
public long getSavedCharsExact() {
return savedCharsExact;
@@ -131,7 +131,7 @@ public class OptimizeStrings {
/**
* The list of common strings
- * @return
+ * @return the list of common strings
*/
public String[] getCommonStrings() {
return commonStringsA;
@@ -166,15 +166,14 @@ public class OptimizeStrings {
return stringToIndexMap.get(s);
}
- /**
- * returns a (positive or 0) or negative number.
+ /**
+ *
+ * @param s must not be null
+ * @return a (positive or 0) or negative number.
* If positive, it is the offset in the common string
* If negative, -v is the index (starting at 1) that sequentially
* increases, for each new unique string fetched using this
* method.
- *
- * @param s, must not be null
- * @return
*/
public int getIndexOrSeqIndex(String s) {
if (null == s) {
@@ -334,7 +333,7 @@ public class OptimizeStrings {
* Copy refs so that final array has no dups up to new length
* Return new length, but don't trim array
* @param sortedStrings
- * @return
+ * @return new length
*/
private int eliminateSortedStringDuplicates(String[] sortedStrings) {
if (sortedStrings.length == 0) {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/ProcessTrace_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/ProcessTrace_impl.java?rev=1521141&r1=1521140&r2=1521141&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/ProcessTrace_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/ProcessTrace_impl.java Mon Sep 9 14:35:34 2013
@@ -231,7 +231,7 @@ public class ProcessTrace_impl implement
}
/**
- * @see org.apache.uima.util.ProcessTrace#getEventsByComponentName(String)
+ * @see org.apache.uima.util.ProcessTrace#getEventsByComponentName(String, boolean)
*/
public List<ProcessTraceEvent> getEventsByComponentName(String aComponentName, boolean aRecurseAfterMatch) {
List<ProcessTraceEvent> result = new ArrayList<ProcessTraceEvent>();
@@ -242,7 +242,7 @@ public class ProcessTrace_impl implement
}
/**
- * @see org.apache.uima.util.ProcessTrace#getEventsByType(String)
+ * @see org.apache.uima.util.ProcessTrace#getEventsByType(String, boolean)
*/
public List<ProcessTraceEvent> getEventsByType(String aType, boolean aRecurseAfterMatch) {
List<ProcessTraceEvent> result = new ArrayList<ProcessTraceEvent>();
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/SerializationMeasures.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/SerializationMeasures.java?rev=1521141&r1=1521140&r2=1521141&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/SerializationMeasures.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/SerializationMeasures.java Mon Sep 9 14:35:34 2013
@@ -59,7 +59,7 @@ public class SerializationMeasures {
/**
* helper method to truncate printing of lots of trailing 0s
* @param c
- * @return
+ * @return the index of the 1st 0 where all the rest are 0's, or the last index
*/
private static int maxIndexToZeros(int[] c) {
for (int i = c.length - 1; i >= 0; i--) {
@@ -269,7 +269,7 @@ public class SerializationMeasures {
return 100F;
}
- return ((100F * a)/ b);
+ return ((100F * a)/ b);
}
// all measures in counts or bytes
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/XMLParser_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/XMLParser_impl.java?rev=1521141&r1=1521140&r2=1521141&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/XMLParser_impl.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/util/impl/XMLParser_impl.java Mon Sep 9 14:35:34 2013
@@ -916,7 +916,7 @@ public CasInitializerDescription parseCa
}
/**
- * @see org.apache.uima.util.XMLParser#newSaxDeserializer(java.lang.String, java.net.URL, boolean)
+ * @see org.apache.uima.util.XMLParser#newSaxDeserializer(org.apache.uima.util.XMLParser.ParsingOptions)
*/
public SaxDeserializer newSaxDeserializer(XMLParser.ParsingOptions aOptions) {
return new SaxDeserializer_impl(this, aOptions);