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 2019/07/19 18:46:56 UTC
svn commit: r1863413 - in /uima/uimaj/trunk:
uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/
uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/
uimaj-tools/src/main/java/org/apache/uima/tools/ uimaj-to...
Author: schor
Date: Fri Jul 19 18:46:56 2019
New Revision: 1863413
URL: http://svn.apache.org/viewvc?rev=1863413&view=rev
Log:
no jira - javadoc fixes
Modified:
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeCollectionReaderCasInitializerImpl.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeCollectionReaderIteratorImpl.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeConfigurationImpl.java
uima/uimaj/trunk/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSection.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationViewerMain.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/RunAE.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/ValidateDescriptor.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/annot_view/Gladis.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConfigField.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmFrame.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmPanel.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/MetaDataPanel.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/PerformanceReportDialog.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationDisplayCustomizationFrame.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/LogFileViewer.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/Jg.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/pear/install/InstallPearCli.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/stylemap/StyleMapEditor.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/gui/SpringUtilities.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/htmlview/AnnotationViewGenerator.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/viewer/CasAnnotationViewer.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/viewer/CasTreeViewer.java
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeCollectionReaderCasInitializerImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeCollectionReaderCasInitializerImpl.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeCollectionReaderCasInitializerImpl.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeCollectionReaderCasInitializerImpl.java Fri Jul 19 18:46:56 2019
@@ -71,6 +71,8 @@ public class CpeCollectionReaderCasIniti
/**
* Returns configuration parameter settings for this CasInitializer.
+ *
+ * @return the configuration parameter settings
*/
public CasProcessorConfigurationParameterSettings getConfigurationParameterSettings() {
return cfps;
@@ -78,7 +80,11 @@ public class CpeCollectionReaderCasIniti
/**
* Sets configuration parameter settings for this CasInitializer.
+ *
+ * @param settings the new configuration parameter settings
+ * @throws CpeDescriptorException the cpe descriptor exception
*/
+ @Override
public void setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings settings)
throws CpeDescriptorException {
cfps = settings;
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeCollectionReaderIteratorImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeCollectionReaderIteratorImpl.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeCollectionReaderIteratorImpl.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeCollectionReaderIteratorImpl.java Fri Jul 19 18:46:56 2019
@@ -51,8 +51,11 @@ public class CpeCollectionReaderIterator
}
/**
- * @param descriptor
+ * Sets the descriptor.
+ *
+ * @param descriptor the new descriptor
*/
+ @Override
public void setDescriptor(CpeComponentDescriptor descriptor) {
this.descriptor = descriptor;
}
@@ -78,8 +81,11 @@ public class CpeCollectionReaderIterator
}
/**
- * @param settings
+ * Sets the configuration parameter settings.
+ *
+ * @param settings the new configuration parameter settings
*/
+ @Override
public void setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings settings) {
configurationParameterSettings = settings;
if (settings != null && settings.getParameterSettings() != null) {
@@ -118,7 +124,9 @@ public class CpeCollectionReaderIterator
}
/**
- * @param settings
+ * Sets the config parameter settings.
+ *
+ * @param settings the new config parameter settings
*/
public void setConfigParameterSettings(ConfigurationParameterSettings settings) {
configParameterSettings = settings;
@@ -136,8 +144,11 @@ public class CpeCollectionReaderIterator
}
/**
- * @param mappings
+ * Sets the sofa name mappings.
+ *
+ * @param mappings the new sofa name mappings
*/
+ @Override
public void setSofaNameMappings(CpeSofaMappings mappings) {
sofaNameMappings = mappings;
}
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeConfigurationImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeConfigurationImpl.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeConfigurationImpl.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/metadata/cpe/CpeConfigurationImpl.java Fri Jul 19 18:46:56 2019
@@ -166,21 +166,27 @@ public class CpeConfigurationImpl extend
}
/**
- * @param string
+ * Sets the deploy as.
+ *
+ * @param string the new deploy as
*/
public void setDeployAs(String string) {
deployAs = string;
}
/**
- * @param l
+ * Sets the num to process.
+ *
+ * @param l the new num to process
*/
public void setNumToProcess(long l) {
num2Process = l;
}
/**
- * @param aStartAt
+ * Sets the start at.
+ *
+ * @param aStartAt the new start at
*/
public void setStartAt(String aStartAt) {
@@ -188,7 +194,9 @@ public class CpeConfigurationImpl extend
}
/**
- * @param string
+ * Sets the timer impl.
+ *
+ * @param string the new timer impl
*/
public void setTimerImpl(String string) {
timerImpl = string;
@@ -206,7 +214,9 @@ public class CpeConfigurationImpl extend
}
/**
- * @param queue
+ * Sets the output queue.
+ *
+ * @param queue the new output queue
*/
public void setOutputQueue(OutputQueue queue) {
outputQueue = queue;
Modified: uima/uimaj/trunk/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSection.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSection.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSection.java (original)
+++ uima/uimaj/trunk/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSection.java Fri Jul 19 18:46:56 2019
@@ -811,7 +811,7 @@ implements Listener, StandardStrings {
/**
* Pack tree.
*
- * @param table the table
+ * @param p_tree the tree
*/
public void packTree(Tree p_tree) {
TreeColumn[] columns = p_tree.getColumns();
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationViewerMain.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationViewerMain.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationViewerMain.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationViewerMain.java Fri Jul 19 18:46:56 2019
@@ -296,8 +296,10 @@ public class AnnotationViewerMain extend
}
/**
- * @param tad
- * @param descFileName
+ * Gets the style map file.
+ *
+ * @param tad the tad
+ * @param descFileName the desc file name
* @return the style map file
* @throws IOException -
*/
@@ -317,8 +319,10 @@ public class AnnotationViewerMain extend
}
/**
- * @param tsd
- * @param descFileName
+ * Gets the style map file.
+ *
+ * @param tsd the tsd
+ * @param descFileName the desc file name
* @return the style map file
* @throws IOException -
*/
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=1863413&r1=1863412&r2=1863413&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 Fri Jul 19 18:46:56 2019
@@ -240,6 +240,10 @@ public class RunAE implements StatusCall
}
/**
+ * Entity process complete.
+ *
+ * @param aCas the a cas
+ * @param aStatus the a status
* @see org.apache.uima.collection.StatusCallbackListener#entityProcessComplete(org.apache.uima.cas.CAS,
* org.apache.uima.collection.EntityProcessStatus)
*/
@@ -338,6 +342,7 @@ public class RunAE implements StatusCall
/**
* Reads command line arguments and sets static class variables appropriately.
*
+ * @param args the args
* @return true if command line args were valid, false if not
*/
private boolean processCmdLineArgs(String[] args) {
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/ValidateDescriptor.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/ValidateDescriptor.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/ValidateDescriptor.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/ValidateDescriptor.java Fri Jul 19 18:46:56 2019
@@ -33,8 +33,8 @@ public class ValidateDescriptor {
/**
* Runs the ValidateDescriptor tool.
*
- * @param args
- * takes one argument, the path to a descriptor file.
+ * @param args takes one argument, the path to a descriptor file.
+ * @throws Exception the exception
*/
public static void main(String[] args) throws Exception {
if (args.length != 1) {
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/annot_view/Gladis.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/annot_view/Gladis.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/annot_view/Gladis.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/annot_view/Gladis.java Fri Jul 19 18:46:56 2019
@@ -31,7 +31,9 @@ import org.apache.uima.tools.cvd.CVD;
public class Gladis {
/**
- * @param args
+ * The main method.
+ *
+ * @param args the arguments
*/
public static void main(String[] args) {
CVD.main(args);
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConfigField.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConfigField.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConfigField.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConfigField.java Fri Jul 19 18:46:56 2019
@@ -156,6 +156,8 @@ public class ConfigField {
/**
* Returns whether this field has been modified from its original value. This is not affected by
* whether the user has saved the new value; for that use isDirty().
+ *
+ * @return true, if is modified
*/
public boolean isModified() {
Object currentValue = getFieldValue();
@@ -171,6 +173,8 @@ public class ConfigField {
/**
* Returns whether this field has been modified since the last time the CPE descriptor was saved.
+ *
+ * @return true, if is dirty
*/
public boolean isDirty() {
Object currentValue = getFieldValue();
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmFrame.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmFrame.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmFrame.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmFrame.java Fri Jul 19 18:46:56 2019
@@ -157,6 +157,8 @@ public class CpmFrame extends JFrame imp
/**
* Runs the application.
+ *
+ * @param args the arguments
*/
public static void main(String[] args) {
//GUI creation must be done in the event handler thread, because Swing is
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmPanel.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmPanel.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmPanel.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmPanel.java Fri Jul 19 18:46:56 2019
@@ -653,13 +653,9 @@ public class CpmPanel extends JPanel imp
* Called by createCpeDescription to add configuration parameter overrides to the CpeDescription
* being constructed, based on the user's changes in the GUI.
*
- * @param aSettings
- * the CasProcessorConfigurationParameterSettings element that will be modified
- * @param aPanel
- * the GUI panel representing settings for the CAS Processor
- * @param aClearDirty
- * whether to clear the dirty bit of each field. This should be set to true when this
- * method is called during the act of saving the CPE descriptor.
+ * @param aSettings the CasProcessorConfigurationParameterSettings element that will be modified
+ * @param aPanel the GUI panel representing settings for the CAS Processor
+ * @throws CpeDescriptorException the cpe descriptor exception
*/
private void createParameterOverrides(CasProcessorConfigurationParameterSettings aSettings,
MetaDataPanel aPanel) throws CpeDescriptorException {
@@ -966,8 +962,11 @@ public class CpmPanel extends JPanel imp
}
/**
- * @param descriptor
- * @param cpeDescSaveFile
+ * Update import.
+ *
+ * @param descriptor the descriptor
+ * @param cpeDescSaveFile the cpe desc save file
+ * @throws Exception the exception
*/
private void updateImport(CpeComponentDescriptor descriptor, File cpeDescSaveFile) throws Exception {
//don't touch import by name
@@ -995,6 +994,7 @@ public class CpmPanel extends JPanel imp
/**
* Utility method for convertion a URL to a File name, taking care of
* proper escaping.
+ *
* @param url a URL
* @return File corresponding to that URL
*/
@@ -1034,7 +1034,11 @@ public class CpmPanel extends JPanel imp
}
}
- /** Ask user to confirm exist. Return true if they confirm, false if not. */
+ /**
+ * Ask user to confirm exist. Return true if they confirm, false if not.
+ *
+ * @return true, if successful
+ */
public boolean confirmExit() {
mShuttingDown = true;
// ask for confirm if CPM is processing
@@ -1812,7 +1816,10 @@ public class CpmPanel extends JPanel imp
}
/**
- * @param specifier
+ * Checks if is cas consumer specifier.
+ *
+ * @param specifier the specifier
+ * @return true, if is cas consumer specifier
*/
private boolean isCasConsumerSpecifier(ResourceSpecifier specifier) {
if (specifier instanceof CasConsumerDescription) {
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/MetaDataPanel.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/MetaDataPanel.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/MetaDataPanel.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/MetaDataPanel.java Fri Jul 19 18:46:56 2019
@@ -184,6 +184,8 @@ public class MetaDataPanel extends FormP
/**
* Returns whether this panel has been modified from its original configuration. Note that this is
* not affected by saves. For that, use isDirty().
+ *
+ * @return true, if is modified
*/
public boolean isModified() {
List fields = getValues();
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/PerformanceReportDialog.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/PerformanceReportDialog.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/PerformanceReportDialog.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/PerformanceReportDialog.java Fri Jul 19 18:46:56 2019
@@ -56,7 +56,10 @@ public class PerformanceReportDialog ext
private Map mEventTypeMap;
/**
- * @throws java.awt.HeadlessException
+ * Instantiates a new performance report dialog.
+ *
+ * @param aFrame the a frame
+ * @throws HeadlessException the headless exception
*/
public PerformanceReportDialog(Frame aFrame) throws HeadlessException {
super(aFrame, true);
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationDisplayCustomizationFrame.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationDisplayCustomizationFrame.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationDisplayCustomizationFrame.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationDisplayCustomizationFrame.java Fri Jul 19 18:46:56 2019
@@ -187,30 +187,38 @@ public class AnnotationDisplayCustomizat
private JTree tree;
/**
- * @throws java.awt.HeadlessException
+ * Instantiates a new annotation display customization frame.
+ *
+ * @throws java.awt.HeadlessException the java.awt. headless exception
*/
public AnnotationDisplayCustomizationFrame() {
super();
}
/**
- * @param arg0
+ * Instantiates a new annotation display customization frame.
+ *
+ * @param arg0 the arg 0
*/
public AnnotationDisplayCustomizationFrame(GraphicsConfiguration arg0) {
super(arg0);
}
/**
- * @param arg0
- * @throws java.awt.HeadlessException
+ * Instantiates a new annotation display customization frame.
+ *
+ * @param arg0 the arg 0
+ * @throws java.awt.HeadlessException the java.awt. headless exception
*/
public AnnotationDisplayCustomizationFrame(String arg0) {
super(arg0);
}
/**
- * @param arg0
- * @param arg1
+ * Instantiates a new annotation display customization frame.
+ *
+ * @param arg0 the arg 0
+ * @param arg1 the arg 1
*/
public AnnotationDisplayCustomizationFrame(String arg0, GraphicsConfiguration arg1) {
super(arg0, arg1);
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/LogFileViewer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/LogFileViewer.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/LogFileViewer.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/LogFileViewer.java Fri Jul 19 18:46:56 2019
@@ -57,30 +57,38 @@ public class LogFileViewer extends JFram
private JTextArea textArea;
/**
- * @throws java.awt.HeadlessException
+ * Instantiates a new log file viewer.
+ *
+ * @throws java.awt.HeadlessException the java.awt. headless exception
*/
public LogFileViewer() {
super();
}
/**
- * @param arg0
+ * Instantiates a new log file viewer.
+ *
+ * @param arg0 the arg 0
*/
public LogFileViewer(GraphicsConfiguration arg0) {
super(arg0);
}
/**
- * @param arg0
- * @throws java.awt.HeadlessException
+ * Instantiates a new log file viewer.
+ *
+ * @param arg0 the arg 0
+ * @throws java.awt.HeadlessException the java.awt. headless exception
*/
public LogFileViewer(String arg0) {
super(arg0);
}
/**
- * @param arg0
- * @param arg1
+ * Instantiates a new log file viewer.
+ *
+ * @param arg0 the arg 0
+ * @param arg1 the arg 1
*/
public LogFileViewer(String arg0, GraphicsConfiguration arg1) {
super(arg0, arg1);
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/Jg.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/Jg.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/Jg.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/Jg.java Fri Jul 19 18:46:56 2019
@@ -78,8 +78,7 @@ public class Jg {
private final static boolean IS_TRACE_LIMITED = false;
/**
- * Interface implemeted by JCAS code generation's templates
- *
+ * Interface implemented by JCAS code generation's templates.
*/
public interface IJCasTypeTemplate {
public String generate(Object argument);
@@ -286,6 +285,9 @@ public class Jg {
/**
* Returns the string from the plugin's resource bundle, or 'key' if not found.
+ *
+ * @param key the key
+ * @return the resource string
*/
public String getResourceString(String key) {
ResourceBundle bundle = getResourceBundle();
@@ -301,7 +303,9 @@ public class Jg {
}
/**
- * Returns the plugin's resource bundle,
+ * Returns the plugin's resource bundle,.
+ *
+ * @return the resource bundle
*/
public ResourceBundle getResourceBundle() {
return resourceBundle;
@@ -430,7 +434,9 @@ public class Jg {
* -jcasgenoutput xxxx
* -jcasgenclasspath xxxx
*
- * @param arguments
+ *
+ * @param arguments the arguments
+ * @return the int
*/
public int main1(String[] arguments) {
boolean hadError = false;
@@ -712,7 +718,11 @@ public class Jg {
/**
* return true if td is not defined in this project, or
* it is defined, but is also in merged and any of the other
- * merged urls are not defined in this project
+ * merged urls are not defined in this project.
+ *
+ * @param td the td
+ * @param projectDirPath the project dir path
+ * @return true, if is out of scope
*/
private boolean isOutOfScope(TypeDescription td, String projectDirPath) {
URI typeDefinitionUri;
@@ -795,9 +805,6 @@ public class Jg {
* @param jcasTypeInstance Template instance used to generate class
* @param jcas_TypeInstance Template instance used to generate class
* @throws IOException -
- * @throws InstantiationException -
- * @throws IllegalAccessException -
- * @return void
*/
private void generateClassesFromTemplate(TypeDescription td, String outputDirectory,
IJCasTypeTemplate jcasTypeInstance, IJCasTypeTemplate jcas_TypeInstance)
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/pear/install/InstallPearCli.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/pear/install/InstallPearCli.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/pear/install/InstallPearCli.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/pear/install/InstallPearCli.java Fri Jul 19 18:46:56 2019
@@ -29,7 +29,9 @@ import org.apache.uima.pear.tools.Packag
public class InstallPearCli {
/**
- * @param args
+ * The main method.
+ *
+ * @param args the arguments
*/
public static void main(String[] args) {
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/stylemap/StyleMapEditor.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/stylemap/StyleMapEditor.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/stylemap/StyleMapEditor.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/stylemap/StyleMapEditor.java Fri Jul 19 18:46:56 2019
@@ -114,6 +114,9 @@ public class StyleMapEditor extends JDia
/**
*
* Creates a new `Editor.
+ *
+ * @param aOwner the a owner
+ * @param cas the cas
*/
public StyleMapEditor(final JFrame aOwner, CAS cas) {
super(aOwner, "Style Map Editor", true);
@@ -285,14 +288,12 @@ public class StyleMapEditor extends JDia
* Displays the StyleMapEditor GUI and allows the user to edit a style map. When the user has
* finished, the new style map is returned.
*
- * @param aAnalysisEngineMetaData
- * Metadata for the AnalysisEngine whose style map is to be edited. This contains the
+ * @param aAnalysisEngineMetaData Metadata for the AnalysisEngine whose style map is to be edited. This contains the
* AE's capabilities and type system definition, which are needed by the editor.
- * @param aStyleMapXml
- * An existing style map XML document that will be loaded into the editor. This is
+ * @param aStyleMapXml An existing style map XML document that will be loaded into the editor. This is
* optional, if null is passed in, a default style map will be automatically generated
* from the AE metadata.
- *
+ * @param cas the cas
* @return a new style map XML document. If the user cancels, null is returned.
*/
public String launchEditor(AnalysisEngineMetaData aAnalysisEngineMetaData, String aStyleMapXml,
@@ -460,10 +461,9 @@ public class StyleMapEditor extends JDia
/**
* Displays the Style Map Editor GUI and allows the user to interact with it.
*
- * @param aStyleList
- * an ArrayList containing the style map entries to be edited. When the user modifies a
+ * @param aStyleList an ArrayList containing the style map entries to be edited. When the user modifies a
* setting in the GUI, the elements of this List will be updated.
- *
+ * @param cas the cas
* @return true if the user exits the dialog by clicking the OK button, false if the user has
* clicked the Cancel button.
*/
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/gui/SpringUtilities.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/gui/SpringUtilities.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/gui/SpringUtilities.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/gui/SpringUtilities.java Fri Jul 19 18:46:56 2019
@@ -45,18 +45,13 @@ public class SpringUtilities {
* in a grid. Each component is as big as the maximum preferred width and height of the
* components. The parent is made just big enough to fit them all.
*
- * @param rows
- * number of rows
- * @param cols
- * number of columns
- * @param initialX
- * x location to start the grid at
- * @param initialY
- * y location to start the grid at
- * @param xPad
- * x padding between cells
- * @param yPad
- * y padding between cells
+ * @param parent the parent
+ * @param rows number of rows
+ * @param cols number of columns
+ * @param initialX x location to start the grid at
+ * @param initialY y location to start the grid at
+ * @param xPad x padding between cells
+ * @param yPad y padding between cells
*/
public static void makeGrid(Container parent, int rows, int cols, int initialX, int initialY,
int xPad, int yPad) {
@@ -137,18 +132,13 @@ public class SpringUtilities {
* components in that column; height is similarly determined for each row. The parent is made just
* big enough to fit them all.
*
- * @param rows
- * number of rows
- * @param cols
- * number of columns
- * @param initialX
- * x location to start the grid at
- * @param initialY
- * y location to start the grid at
- * @param xPad
- * x padding between cells
- * @param yPad
- * y padding between cells
+ * @param parent the parent
+ * @param rows number of rows
+ * @param cols number of columns
+ * @param initialX x location to start the grid at
+ * @param initialY y location to start the grid at
+ * @param xPad x padding between cells
+ * @param yPad y padding between cells
*/
public static void makeCompactGrid(Container parent, int rows, int cols, int initialX,
int initialY, int xPad, int yPad) {
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/htmlview/AnnotationViewGenerator.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/htmlview/AnnotationViewGenerator.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/htmlview/AnnotationViewGenerator.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/htmlview/AnnotationViewGenerator.java Fri Jul 19 18:46:56 2019
@@ -124,9 +124,9 @@ public class AnnotationViewGenerator {
/**
* Writes a resource file to disk. The resource file is looked up in the classpath
*
- * @param filename
- * name of the file, to be looked up in the classpath, under the same package as this
+ * @param filename name of the file, to be looked up in the classpath, under the same package as this
* class.
+ * @param outputDir the output dir
* @return outputDir directory of output file. Output file will be named the same as the
* <code>filename</code> parameter.
*/
@@ -170,8 +170,8 @@ public class AnnotationViewGenerator {
* {@link #processDocument(File)}.</LI>
* </UL>
*
- * @param aStyleMap
- * path to style map to be processed
+ * @param aStyleMap path to style map to be processed
+ * @throws TransformerException the transformer exception
*/
public void processStyleMap(File aStyleMap) throws TransformerException {
// Copy static files annotations.xsl, annotationViewer.js, and index.html to
@@ -204,8 +204,8 @@ public class AnnotationViewGenerator {
* to {@link #processStyleMap(File)}. Generates a file named docView.html, which represents the
* HTML view of the annotated document.
*
- * @param aInlineXmlDoc
- * path to annotated document to be processed
+ * @param aInlineXmlDoc path to annotated document to be processed
+ * @throws TransformerException the transformer exception
*/
public void processDocument(File aInlineXmlDoc) throws TransformerException {
// Generate document view HTML from Inline XML
@@ -348,10 +348,9 @@ public class AnnotationViewGenerator {
* Automatically generates a style map file for the given analysis engine. The style map will be
* written to the file <code>aStyleMapFile</code>.
*
- * @param aAE
- * the Analysis Engine whose outputs will be viewed using the generated style map.
- * @param aStyleMapFile
- * file to which autogenerated style map will be written
+ * @param aAE the Analysis Engine whose outputs will be viewed using the generated style map.
+ * @param aStyleMapFile file to which autogenerated style map will be written
+ * @throws IOException Signals that an I/O exception has occurred.
*/
public void autoGenerateStyleMapFile(AnalysisEngine aAE, File aStyleMapFile) throws IOException {
this.autoGenerateStyleMapFile(aAE.getAnalysisEngineMetaData(), aStyleMapFile);
@@ -361,12 +360,10 @@ public class AnnotationViewGenerator {
* Automatically generates a style map file for the given analysis engine metadata. The style map
* will be written to the file <code>aStyleMapFile</code>.
*
- *
- * @param aMetaData
- * Metadata of the Analysis Engine whose outputs will be viewed using the generated style
+ * @param aMetaData Metadata of the Analysis Engine whose outputs will be viewed using the generated style
* map.
- * @param aStyleMapFile
- * file to which autogenerated style map will be written
+ * @param aStyleMapFile file to which autogenerated style map will be written
+ * @throws IOException Signals that an I/O exception has occurred.
*/
public void autoGenerateStyleMapFile(AnalysisEngineMetaData aMetaData, File aStyleMapFile)
throws IOException {
@@ -385,10 +382,9 @@ public class AnnotationViewGenerator {
* Automatically generates a style map file for the given type system. The style map will be
* written to the file <code>aStyleMapFile</code>.
*
- * @param aTypeSystem
- * the type system for which a style map will be generated
- * @param aStyleMapFile
- * file to which autogenerated style map will be written
+ * @param aTypeSystem the type system for which a style map will be generated
+ * @param aStyleMapFile file to which autogenerated style map will be written
+ * @throws IOException Signals that an I/O exception has occurred.
*/
public void autoGenerateStyleMapFile(TypeSystemDescription aTypeSystem, File aStyleMapFile)
throws IOException {
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/viewer/CasAnnotationViewer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/viewer/CasAnnotationViewer.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/viewer/CasAnnotationViewer.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/viewer/CasAnnotationViewer.java Fri Jul 19 18:46:56 2019
@@ -847,6 +847,9 @@ public class CasAnnotationViewer extends
}
/**
+ * Instantiates a new cas annotation viewer.
+ *
+ * @param aEntityViewEnabled the a entity view enabled
* @deprecated use the zero-argument constructor
*/
@Deprecated
@@ -862,8 +865,9 @@ public class CasAnnotationViewer extends
}
/**
- * @param userTypes
- * The userTypes to set.
+ * Sets the user types.
+ *
+ * @param userTypes The userTypes to set.
*/
public void setUserTypes(List<String> userTypes) {
this.userTypes = userTypes;
@@ -1013,7 +1017,7 @@ public class CasAnnotationViewer extends
* mode makes for a cleaner legend at the expense of making it more difficult to toggle which
* types are selected. There's also a button in the GUI that lets the user change this setting.
*
- * @param aHideUnselected
+ * @param aHideUnselected the new hide unselected checkboxes
*/
public void setHideUnselectedCheckboxes(boolean aHideUnselected) {
this.hideUnselectedCheckBoxes = aHideUnselected;
@@ -1540,10 +1544,9 @@ public class CasAnnotationViewer extends
* Examine an annotation and add type/feature/value-related controls if
* necessary.
*
- * @param doc
- * @param annotation
- * @param firstType
- * If true, the annotation being examined has the first
+ * @param doc the doc
+ * @param annotation the annotation
+ * @param firstType If true, the annotation being examined has the first
* type-related radio button that needs to be created and also
* set as selected.
* @return If true, the annotation being examined has its type being
@@ -1616,11 +1619,11 @@ public class CasAnnotationViewer extends
* Examine one feature of the given annotation and create the
* feature-related controls.
*
- * @param doc
- * @param annotation
- * @param feature
- * @param firstFeature
- * @return
+ * @param doc the doc
+ * @param annotation the annotation
+ * @param feature the feature
+ * @param firstFeature the first feature
+ * @return true, if successful
*/
private boolean processOneFeature(StyledDocument doc, Annotation annotation,
Feature feature, boolean firstFeature) {
@@ -1680,10 +1683,10 @@ public class CasAnnotationViewer extends
* Examine one feature of the given annotation and create the
* feature-value-related controls.
*
- * @param doc
- * @param annotation
- * @param feature
- * @return
+ * @param doc the doc
+ * @param annotation the annotation
+ * @param feature the feature
+ * @return true, if successful
*/
private boolean processOneFeatureValue(StyledDocument doc,
Annotation annotation, Feature feature) {
@@ -2026,8 +2029,8 @@ public class CasAnnotationViewer extends
* Check if an annotation matches the filters set by the user. If true, the
* annotation will be added to the annotation tree display panel.
*
- * @param annotation
- * @return
+ * @param annotation the annotation
+ * @return true, if is match
*/
private boolean isMatch(Annotation annotation) {
Type type = annotation.getType();
@@ -2174,9 +2177,9 @@ public class CasAnnotationViewer extends
* Get feature value in string, if value is not another annotation and not
* an array of annotations.
*
- * @param aFS
- * @param feature
- * @return
+ * @param aFS the a FS
+ * @param feature the feature
+ * @return the feature value in string
*/
private String getFeatureValueInString(FeatureStructure aFS, Feature feature) {
if (this.cas == null || this.typeSystem == null || this.stringType == null || this.fsArrayType == null) {
@@ -2222,10 +2225,10 @@ public class CasAnnotationViewer extends
* default value. If longer than specified limit, take only the leading
* substring that would fit in the limit.
*
- * @param stringValue
- * @param defaultIfNull
- * @param maxLength
- * @return
+ * @param stringValue the string value
+ * @param defaultIfNull the default if null
+ * @param maxLength the max length
+ * @return the string
*/
private static String checkString(String stringValue, String defaultIfNull, int maxLength) {
if (stringValue == null) {
@@ -2300,6 +2303,9 @@ public class CasAnnotationViewer extends
}
/**
+ * Sets the size.
+ *
+ * @param d the new size
* @see java.awt.Component#setSize(Dimension)
*/
public void setSize(Dimension d) {
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/viewer/CasTreeViewer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/viewer/CasTreeViewer.java?rev=1863413&r1=1863412&r2=1863413&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/viewer/CasTreeViewer.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/viewer/CasTreeViewer.java Fri Jul 19 18:46:56 2019
@@ -74,8 +74,8 @@ public class CasTreeViewer extends JPane
/**
* Creates a CAS Tree Viewer.
*
- * @param aCAS
- * the CAS containing the annotations to be displayed in the tree viewer GUI
+ * @param aCAS the CAS containing the annotations to be displayed in the tree viewer GUI
+ * @throws CASException the CAS exception
*/
public CasTreeViewer(CAS aCAS) throws CASException {
super();
@@ -229,10 +229,9 @@ public class CasTreeViewer extends JPane
/**
* Builds a tree from a CAS.
*
- * @param aRootNode
- * an existing root node for the tree
- * @param aCAS
- * CAS from which annotations will be extracted
+ * @param aCAS CAS from which annotations will be extracted
+ * @return the tree node
+ * @throws CASException the CAS exception
*/
private TreeNode buildTree(CAS aCAS) throws CASException {
// get iterator over all annotations
@@ -373,10 +372,8 @@ public class CasTreeViewer extends JPane
* <code><TEXT%gt;Process this text.</TEXT%gt;</code>, then only the text within those
* tags is returned. Otherwise the whole document is returned.
*
- * @param aFile
- * file to process
- * @param aTAE
- * Text Analysis Engine that will process the file
+ * @param text the text
+ * @return the text
*/
static private String getText(String text) {
int start = text.indexOf("<TEXT>");
@@ -397,6 +394,9 @@ public class CasTreeViewer extends JPane
}
/**
+ * Sets the size.
+ *
+ * @param d the new size
* @see java.awt.Component#setSize(Dimension)
*/
public void setSize(Dimension d) {