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 23:37:45 UTC
svn commit: r1521296 - in
/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools: ./ cpm/
docanalyzer/ jcasgen/ stylemap/ util/gui/ util/htmlview/ viewer/
Author: schor
Date: Mon Sep 9 21:37:44 2013
New Revision: 1521296
URL: http://svn.apache.org/r1521296
Log:
[UIMA-3256] fixup Javadocs
Modified:
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/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/docanalyzer/AnnotationViewerDialog.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.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/stylemap/StyleMapEditor.java
uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/gui/FileSelector.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
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=1521296&r1=1521295&r2=1521296&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 Mon Sep 9 21:37:44 2013
@@ -296,9 +296,9 @@ public class AnnotationViewerMain extend
}
/**
- * @param tae // *
- * @param taeDescFileName
- * @return
+ * @param tad
+ * @param descFileName
+ * @return the style map file
* @throws IOException
*/
private File getStyleMapFile(AnalysisEngineDescription tad, String descFileName)
@@ -317,9 +317,9 @@ public class AnnotationViewerMain extend
}
/**
- * @param tae // *
- * @param taeDescFileName
- * @return
+ * @param tsd
+ * @param descFileName
+ * @return the style map file
* @throws IOException
*/
private File getStyleMapFile(TypeSystemDescription tsd, String descFileName) throws IOException {
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=1521296&r1=1521295&r2=1521296&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 Mon Sep 9 21:37:44 2013
@@ -878,9 +878,6 @@ public class CpmPanel extends JPanel imp
consumersPanel.validate();
}
- /**
- * @return
- */
private CpeDescription createEmptyCpeDescription() {
CpeDescription cpeDesc = CpeDescriptorFactory.produceDescriptor();
// We use CAS pool size default of 3
@@ -1726,7 +1723,7 @@ public class CpmPanel extends JPanel imp
* Returns whether the GUI is dirty; that is, whether configuration settings have been modified
* since the last save.
*
- * @return
+ * @return whether the GUI is dirty
*/
private boolean isDirty() {
// have components been added or removed?
@@ -1816,7 +1813,6 @@ public class CpmPanel extends JPanel imp
/**
* @param specifier
- * @return
*/
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=1521296&r1=1521295&r2=1521296&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 Mon Sep 9 21:37:44 2013
@@ -200,7 +200,7 @@ public class MetaDataPanel extends FormP
* Returns whether this panel is dirty; that is, whether a field has been modified since
* clearDirty() was last called.
*
- * @return
+ * @return whether this panel is dirty
*/
public boolean isDirty() {
List fields = getValues();
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java?rev=1521296&r1=1521295&r2=1521296&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java Mon Sep 9 21:37:44 2013
@@ -139,10 +139,10 @@ public class AnnotationViewerDialog exte
*
* @param aParentFrame
* frame containing this panel
- * @param aTitle
+ * @param aDialogTitle
* title to display for the dialog
- * @param aInputDir
- * directory containing input files (in XCAS foramt) to read
+ * @param med
+ *
* @param aStyleMapFile
* filename of style map to be used to view files in HTML
* @param aPerformanceStats
@@ -152,6 +152,11 @@ public class AnnotationViewerDialog exte
* @param aTypesToDisplay
* array of types that should be highlighted in the viewer. This can be set to the output
* types of the Analysis Engine. A value of null means to display all types.
+ * @param interactiveTempFN
+ * @param javaViewerRBisSelected
+ * @param javaViewerUCRBisSelected
+ * @param xmlRBisSelected
+ * @param cas
*/
public AnnotationViewerDialog(JFrame aParentFrame, String aDialogTitle, PrefsMediator med,
File aStyleMapFile, String aPerformanceStats, TypeSystem aTypeSystem,
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java?rev=1521296&r1=1521295&r2=1521296&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java Mon Sep 9 21:37:44 2013
@@ -213,7 +213,7 @@ public class PrefsMediator {
}
/**
- * @param TAEdir
+ * @param edir
* set the TAE directory
*/
public void setTAEfile(String edir) {
@@ -245,7 +245,7 @@ public class PrefsMediator {
}
/**
- * @param input file format
+ * @param inputFileFormat
* The input file format to set.
*/
public void setInputFileFormat(String inputFileFormat) {
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=1521296&r1=1521295&r2=1521296&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 Mon Sep 9 21:37:44 2013
@@ -432,7 +432,6 @@ public class Jg {
* -jcasgenclasspath xxxx
*
* @param arguments
- * @return
*/
public int main1(String[] arguments) {
boolean hadError = false;
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=1521296&r1=1521295&r2=1521296&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 Mon Sep 9 21:37:44 2013
@@ -64,7 +64,7 @@ import org.apache.uima.tools.util.htmlvi
* <li>A label used to identify the annotations in the annotation viewer</li>
* </ul>
* <p>
- * To invoke the editor, call the {@link launchEditor(TextAnalysisEngine,String)} method.
+ * To invoke the editor, call the {@link #launchEditor(AnalysisEngineMetaData, String, CAS)} method.
*
*
*
Modified: uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/gui/FileSelector.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/gui/FileSelector.java?rev=1521296&r1=1521295&r2=1521296&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/gui/FileSelector.java (original)
+++ uima/uimaj/trunk/uimaj-tools/src/main/java/org/apache/uima/tools/util/gui/FileSelector.java Mon Sep 9 21:37:44 2013
@@ -77,7 +77,6 @@ public class FileSelector extends JPanel
* @param initialValue filename initially displayed in the text field
* @param fileChooserTitle title of the JFileChooser launched when the user clicks Browse
* @param selectionMode Can be either JFileChooser.FILES_ONLY, JFileChooser.DIRECTORIES_ONLY or JFileChooser.FILES_AND_DIRECTORIES
- * @param currentDir default directory for the file chooser
*/
public FileSelector(String initialValue, String fileChooserTitle, int selectionMode) //
{
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=1521296&r1=1521295&r2=1521296&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 Mon Sep 9 21:37:44 2013
@@ -165,10 +165,10 @@ public class AnnotationViewGenerator {
* <LI>annotations.css - A CSS stylesheet for the annotation viewer</LI>
* <LI>legend.html - HTML document for legend (bottom pane of viewer)</LI>
* <LI>docFrame.xsl - An XSL stylesheet to be applied to annotated documents during calls to
- * {@link processDocument(File)}.</LI>
+ * {@link #processDocument(File)}.</LI>
* </UL>
*
- * @param aInlineXmlDoc
+ * @param aStyleMap
* path to style map to be processed
*/
public void processStyleMap(File aStyleMap) throws TransformerException {
@@ -199,7 +199,7 @@ public class AnnotationViewGenerator {
/**
* Processes an annotated document using the docFrame.xsl stylsheet generated by a previous call
- * to {@link processStyleMap(File)}. Generates a file named docView.html, which represents the
+ * to {@link #processStyleMap(File)}. Generates a file named docView.html, which represents the
* HTML view of the annotated document.
*
* @param aInlineXmlDoc
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=1521296&r1=1521295&r2=1521296&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 Mon Sep 9 21:37:44 2013
@@ -411,7 +411,7 @@ public class CasAnnotationViewer extends
* is to show all types in the CAS (except those specifically hidden by a call to
* {@link #setHiddenTypes(String[])}.
*
- * @param aTypeNames
+ * @param aDisplayedTypeNames
* names of types that are to be highlighted. Null indicates that all types in the CAS
* should be highlighted.
*/
@@ -466,7 +466,7 @@ public class CasAnnotationViewer extends
/**
* Configures the viewer to hide certain features in the annotation deatail pane.
*
- * @param aFeatureName
+ * @param aFeatureNames
* array of (short) feature names to be hidden
*/
public void setHiddenFeatures(String[] aFeatureNames) {
@@ -483,7 +483,7 @@ public class CasAnnotationViewer extends
* {@link #setEntityResolver(EntityResolver)} method has been called with a user-supplied
* class that can determine which annotations refer to the same entity.
*
- * @param aDisplayEntities
+ * @param aEnabled
* true to enable entity viewing mode, false to allow annotation viewing only.
* The default is false.
*/
@@ -534,9 +534,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 aConsistent
- * true (the default) causes colors to be consistent across documents, false allows them
- * to vary
+ * @param aHideUnselected
*/
public void setHideUnselectedCheckboxes(boolean aHideUnselected) {
mHideUnselectedCheckboxes = aHideUnselected;
@@ -611,8 +609,8 @@ public class CasAnnotationViewer extends
/**
* Causes the specified words to appear in boldface wherever they occur in the document. This is
- * case-insensitive. Call this method after {@link #setCAS()}. It wil apply only to the current
- * document, and will be reset on the next call to {@link #setCAS()}.
+ * case-insensitive. Call this method after {@link #setCAS(CAS)}. It wil apply only to the current
+ * document, and will be reset on the next call to {@link #setCAS(CAS)}.
*
* @param aWords
* array of words to highlight in boldface.
@@ -624,8 +622,8 @@ public class CasAnnotationViewer extends
/**
* Causes the specified spans to appear in boldface. This is case-insensitive. Call this method
- * after {@link #setCAS()}. It wil apply only to the current document, and will be reset on the
- * next call to {@link #setCAS()}.
+ * after {@link #setCAS(CAS)}. It wil apply only to the current document, and will be reset on the
+ * next call to {@link #setCAS(CAS)}.
*
* @param aSpans
* spans to appear in boldface (begin1, end1, begin2, end2, ...)
@@ -639,7 +637,7 @@ public class CasAnnotationViewer extends
* Configures the viewer appropriately for displaying a hit against an XML fragments query. This
* does not use a sophisticated algorithm for determining the location of the document that
* matched the query. Currently all it does is call {@link #setInitiallySelectedTypes(String[])}
- * with the list of types mentioned in the query and {@link #applyBoldfaceToKeyword(String[])} on
+ * with the list of types mentioned in the query and {@link #applyBoldfaceToKeywords(String[])} on
* any keywords mentioned in the query.
*
* @param aQuery
@@ -691,7 +689,7 @@ public class CasAnnotationViewer extends
* Configures the viewer appropriately for displaying a hit against an XML fragments query. This
* does not use a sophisticated algorithm for determining the location of the document that
* matched the query. Currently all it does is call {@link #setInitiallySelectedTypes(String[])}
- * with the list of types mentioned in the query and {@link #applyBoldfaceToKeyword(String[])} on
+ * with the list of types mentioned in the query and {@link #applyBoldfaceToKeywords(String[])} on
* any keywords mentioned in the query.
*
* @param aQuery