You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by pk...@apache.org on 2015/05/20 13:55:50 UTC
svn commit: r1680532 - in /uima/ruta/trunk/ruta-core: ./
src/main/java/org/apache/uima/ruta/
src/main/java/org/apache/uima/ruta/engine/
src/main/java/org/apache/uima/ruta/resource/
Author: pkluegl
Date: Wed May 20 11:55:49 2015
New Revision: 1680532
URL: http://svn.apache.org/r1680532
Log:
UIMA-4402
- fixed javadoc
Modified:
uima/ruta/trunk/ruta-core/pom.xml
uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/RutaEnvironment.java
uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/HtmlConverter.java
uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/RutaEngine.java
uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/RutaTestUtils.java
uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/ViewWriter.java
uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/resource/MultiTreeWordListPersistence.java
Modified: uima/ruta/trunk/ruta-core/pom.xml
URL: http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-core/pom.xml?rev=1680532&r1=1680531&r2=1680532&view=diff
==============================================================================
--- uima/ruta/trunk/ruta-core/pom.xml (original)
+++ uima/ruta/trunk/ruta-core/pom.xml Wed May 20 11:55:49 2015
@@ -197,6 +197,16 @@
<argLine>-Xmx650M</argLine>
</configuration>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <!-- Exclude generated jcas classes -->
+ <sourceFileExcludes>
+ <sourceFileExclude>**/org/apache/uima/ruta/type/*.java</sourceFileExclude>
+ </sourceFileExcludes>
+ </configuration>
+ </plugin>
</plugins>
</build>
</project>
\ No newline at end of file
Modified: uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/RutaEnvironment.java
URL: http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/RutaEnvironment.java?rev=1680532&r1=1680531&r2=1680532&view=diff
==============================================================================
--- uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/RutaEnvironment.java (original)
+++ uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/RutaEnvironment.java Wed May 20 11:55:49 2015
@@ -509,6 +509,8 @@ public class RutaEnvironment {
* Type system describing the package to load.
* @param packageName
* Package to load or null to load all packages.
+ * @param alias
+ * Alias of the package. Null or empty string to use no alias.
*/
public void importPackageFromTypeSystem(String typesystem, String packageName, String alias) {
TypeSystemDescription tsd = TypeSystemDescriptionFactory
Modified: uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/HtmlConverter.java
URL: http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/HtmlConverter.java?rev=1680532&r1=1680531&r2=1680532&view=diff
==============================================================================
--- uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/HtmlConverter.java (original)
+++ uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/HtmlConverter.java Wed May 20 11:55:49 2015
@@ -59,7 +59,7 @@ import org.htmlparser.util.ParserExcepti
* it would be mapped to an annotation of length 0, it is not moved to the new view.
*
* The HTML Converter also supports heuristic and explicit conversion patterns which default to
- * html4 decoding, e.g., "<![CDATA[ ]]>", "<![CDATA[<]]>", etc. Concepts like tables or
+ * html4 decoding, e.g., "{@literal }", "{@literal <}", etc. Concepts like tables or
* lists are not supported.
*
* Note that in general it is suggested to run an html cleaner before any further processing to
@@ -191,7 +191,7 @@ public class HtmlConverter extends JCasA
/**
* This string array parameter can be used to apply custom conversions. It defaults to a list of
- * commonly used codes, e.g., <![CDATA[ ]]>, which are converted using html 4 entity
+ * commonly used codes, e.g., {@literal }, which are converted using html 4 entity
* unescaping. However, explicit conversion strings can also be passed via the parameter
* <code>conversionReplacements</code>. Remember to enable explicit conversion via
* <code>conversionPolicy</code> first.
@@ -207,7 +207,7 @@ public class HtmlConverter extends JCasA
* This string parameter determines the conversion policy used, either "heuristic", "explicit", or
* "none". When the value is "explicit", the parameters <code>conversionPatterns</code> and
* optionally <code>conversionReplacements</code> are considered. The "heuristic" conversion
- * policy uses simple regular expressions to decode html4 entities such as "<![CDATA[ ]]>".
+ * policy uses simple regular expressions to decode html4 entities such as "{@literal }".
* The default behavior is "heuristic".
*/
public static final String PARAM_CONVERSION_POLICY = "conversionPolicy";
Modified: uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/RutaEngine.java
URL: http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/RutaEngine.java?rev=1680532&r1=1680531&r2=1680532&view=diff
==============================================================================
--- uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/RutaEngine.java (original)
+++ uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/RutaEngine.java Wed May 20 11:55:49 2015
@@ -268,7 +268,7 @@ public class RutaEngine extends JCasAnno
/**
* This parameter specifies whether the memory consumption should be reduced. This parameter
- * should be set to true for very large CAS documents (e.g., > 500k tokens), but it also reduces
+ * should be set to true for very large CAS documents (e.g., > 500k tokens), but it also reduces
* the performance. The default value is set to false.
*/
public static final String PARAM_LOW_MEMORY_PROFILE = "lowMemoryProfile";
Modified: uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/RutaTestUtils.java
URL: http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/RutaTestUtils.java?rev=1680532&r1=1680531&r2=1680532&view=diff
==============================================================================
--- uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/RutaTestUtils.java (original)
+++ uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/RutaTestUtils.java Wed May 20 11:55:49 2015
@@ -195,9 +195,11 @@ public class RutaTestUtils {
/**
* Helper to get the test type, e.g. org.apache.uima.T1, org.apache.uima.T2, ...
*
- * @param cas
+ * @param cas
+ * The CAS object containing the type system
* @param i
* typeId, converted to {@link #TYPE} + i
+ * @return the test type object with the given counter
*/
public static Type getTestType(CAS cas, int i) {
if (cas == null)
Modified: uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/ViewWriter.java
URL: http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/ViewWriter.java?rev=1680532&r1=1680531&r2=1680532&view=diff
==============================================================================
--- uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/ViewWriter.java (original)
+++ uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/engine/ViewWriter.java Wed May 20 11:55:49 2015
@@ -41,15 +41,15 @@ import org.apache.uima.util.XMLSerialize
/**
* This Analysis Engine is able to serialize the processed CAS to an XMI file whereas the the source
* and destination view can be specified A descriptor file for this Analysis Engine is located in
- * the folder <quote>descriptor/utils</quote> of a UIMA Ruta project.
+ * the folder <code>descriptor/utils</code> of a UIMA Ruta project.
*
*/
public class ViewWriter extends JCasMultiplier_ImplBase {
/**
* This string parameter specifies the absolute path of the resulting file named
- * <quote>output.xmi</quote>. However, if an annotation of the type
- * <quote>org.apache.uima.examples.SourceDocumentInformation</quote> is given, then the value of
+ * <code>output.xmi</code>. However, if an annotation of the type
+ * <code>org.apache.uima.examples.SourceDocumentInformation</code> is given, then the value of
* this parameter is interpreted to be relative to the URI stored in the annotation and the name
* of the file will be adapted to the name of the source file. If this functionality is activated
* in the preferences, then the UIMA Ruta Workbench adds the SourceDocumentInformation annotation
Modified: uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/resource/MultiTreeWordListPersistence.java
URL: http://svn.apache.org/viewvc/uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/resource/MultiTreeWordListPersistence.java?rev=1680532&r1=1680531&r2=1680532&view=diff
==============================================================================
--- uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/resource/MultiTreeWordListPersistence.java (original)
+++ uima/ruta/trunk/ruta-core/src/main/java/org/apache/uima/ruta/resource/MultiTreeWordListPersistence.java Wed May 20 11:55:49 2015
@@ -60,7 +60,7 @@ public class MultiTreeWordListPersistenc
*
* @param is
* the inputStream to sniff. Must support {@link InputStream#markSupported()}
- * @return true if this stream starts with '<?xml'
+ * @return true if this stream starts with '{@literal <?xml}'
*/
public static boolean isSniffedXmlContentType(InputStream is) throws IOException {
if (is == null)