Revision: 14981
http://gate.svn.sourceforge.net/gate/?rev=14981&view=rev
Author: markagreenwood
Date: 2012-01-10 13:45:27 +0000 (Tue, 10 Jan 2012)
Log Message:
-----------
fixed a bunch of javadoc warnings
Modified Paths:
--------------
gate/trunk/src/gate/creole/CustomDuplication.java
gate/trunk/src/gate/gui/SingleConcatenatedFileInputDialog.java
gate/trunk/src/gate/gui/annedit/JNullableTextField.java
gate/trunk/src/gate/gui/docview/AnnotationList.java
gate/trunk/src/gate/gui/docview/AnnotationSetsView.java
gate/trunk/src/gate/gui/docview/CorefEditor.java
gate/trunk/src/gate/gui/docview/TextualDocumentView.java
Modified: gate/trunk/src/gate/creole/CustomDuplication.java
===================================================================
--- gate/trunk/src/gate/creole/CustomDuplication.java 2012-01-10 13:14:07 UTC
(rev 14980)
+++ gate/trunk/src/gate/creole/CustomDuplication.java 2012-01-10 13:45:27 UTC
(rev 14981)
@@ -18,13 +18,13 @@
import gate.Factory.DuplicationContext;
/**
- * Interface which should be implemented by any Resource type which
- * cannot be duplicated in the standard way (see
- * {@link Factory#duplicate(Resource) Factory.duplicate}). If a Resource
- * class requires custom duplication logic it should implement this
- * interface and provide an implementation of the
- * {@link #duplicate(DuplicationContext) duplicate} method to create a new
- * resource instance that has the same behaviour as <code>this</code>.
+ * Interface which should be implemented by any Resource type which cannot be
+ * duplicated in the standard way (see {@link Factory#duplicate(Resource)
+ * Factory.duplicate}). If a Resource class requires custom duplication logic
it
+ * should implement this interface and provide an implementation of the
+ * {@link CustomDuplication#duplicate(DuplicationContext) duplicate} method to
+ * create a new resource instance that has the same behaviour as
+ * <code>this</code>.
*
* @author ian
*/
Modified: gate/trunk/src/gate/gui/SingleConcatenatedFileInputDialog.java
===================================================================
--- gate/trunk/src/gate/gui/SingleConcatenatedFileInputDialog.java
2012-01-10 13:14:07 UTC (rev 14980)
+++ gate/trunk/src/gate/gui/SingleConcatenatedFileInputDialog.java
2012-01-10 13:45:27 UTC (rev 14981)
@@ -220,8 +220,6 @@
/**
* Gets the document root element set by user
- *
- * @return
*/
public String getDocumentRootElement() {
return documentRootElementTextField.getText();
@@ -229,8 +227,6 @@
/**
* Sets the value for documentRootElement field
- *
- * @param documentRootElement
*/
public void setDocumentRootElement(String documentRootElement) {
this.documentRootElementTextField.setText(documentRootElement);
@@ -238,8 +234,6 @@
/**
* Gets the document name prefix set by user
- *
- * @return
*/
public String getDocumentNamePrefix() {
return documentNamePrefixTextField.getText();
@@ -247,8 +241,6 @@
/**
* Sets the value for document name prefix
- *
- * @param documentNamePrefix
*/
public void setDocumentNamePrefix(String documentNamePrefix) {
this.documentNamePrefixTextField.setText(documentNamePrefix);
@@ -256,8 +248,6 @@
/**
* Gets the selected document type.
- *
- * @return
*/
public DocType getDocumentType() {
return (DocType)this.documentTypeComboBox.getSelectedItem();
@@ -265,8 +255,6 @@
/**
* Sets the document type
- *
- * @param documentType
*/
public void setDocumentType(DocType documentType) {
this.documentTypeComboBox.setSelectedItem(documentType);
@@ -274,8 +262,6 @@
/**
* Returns the number of documents to fetch
- *
- * @return
*/
public int getNumOfDocumentsToFetch() {
if(this.numOfDocumentsToFetchTextField.getText().trim().length() == 0) {
@@ -295,8 +281,6 @@
/**
* Sets the number of documents to fetch
- *
- * @param numOfDocumentsToFetch
*/
public void setNumOfDocumentsToFetch(int numOfDocumentsToFetch) {
this.numOfDocumentsToFetchTextField.setText("" + numOfDocumentsToFetch);
Modified: gate/trunk/src/gate/gui/annedit/JNullableTextField.java
===================================================================
--- gate/trunk/src/gate/gui/annedit/JNullableTextField.java 2012-01-10
13:14:07 UTC (rev 14980)
+++ gate/trunk/src/gate/gui/annedit/JNullableTextField.java 2012-01-10
13:45:27 UTC (rev 14981)
@@ -109,7 +109,6 @@
* Gets the value currently being edited. Unlike {@link JTextField}, this
* value may be null (if {@link #setText(String)} was called previously with
* a <code>null</code> value, of the delete button was pressed by the user).
- * @return
*/
public String getText() {
return text;
@@ -118,7 +117,6 @@
/**
* Sets the number of columns for the included {@link JTextField}, see
* {@link JTextField#setColumns(int)}.
- * @param cols
*/
public void setColumns(int cols) {
textField.setColumns(cols);
Modified: gate/trunk/src/gate/gui/docview/AnnotationList.java
===================================================================
--- gate/trunk/src/gate/gui/docview/AnnotationList.java 2012-01-10 13:14:07 UTC
(rev 14980)
+++ gate/trunk/src/gate/gui/docview/AnnotationList.java 2012-01-10 13:45:27 UTC
(rev 14981)
@@ -33,8 +33,6 @@
/**
* Provides the annotation
- * @param row
- * @return
*/
public AnnotationData getAnnotationAtRow(int row);
Modified: gate/trunk/src/gate/gui/docview/AnnotationSetsView.java
===================================================================
--- gate/trunk/src/gate/gui/docview/AnnotationSetsView.java 2012-01-10
13:14:07 UTC (rev 14980)
+++ gate/trunk/src/gate/gui/docview/AnnotationSetsView.java 2012-01-10
13:45:27 UTC (rev 14981)
@@ -241,11 +241,7 @@
/**
* Create the annotation editor (responsible for creating the window
* used to edit individual annotations).
- *
- * @param textView
- * @param asView
- * @return
- * @throws ResourceInstantiationException
+ * @throws ResourceInstantiationException if an error occurs
*/
protected gate.gui.annedit.OwnedAnnotationEditor createAnnotationEditor(
TextualDocumentView textView, AnnotationSetsView asView)
@@ -1601,9 +1597,6 @@
}
}
- /**
- * The beginning is the same as {@link NameBearerHandle.SaveAsXmlAction}.
- */
protected class SavePreserveFormatAction extends AbstractAction{
public SavePreserveFormatAction(){
super("Save Preserving Format");
Modified: gate/trunk/src/gate/gui/docview/CorefEditor.java
===================================================================
--- gate/trunk/src/gate/gui/docview/CorefEditor.java 2012-01-10 13:14:07 UTC
(rev 14980)
+++ gate/trunk/src/gate/gui/docview/CorefEditor.java 2012-01-10 13:45:27 UTC
(rev 14981)
@@ -16,21 +16,61 @@
package gate.gui.docview;
-import java.awt.*;
-import javax.swing.*;
-import javax.swing.tree.*;
-import javax.swing.event.*;
-import java.util.*;
-import gate.*;
-import gate.creole.*;
-import java.io.*;
-import java.awt.event.*;
-import gate.swing.*;
-import gate.event.*;
+import gate.Annotation;
+import gate.AnnotationSet;
+import gate.creole.ANNIEConstants;
+import gate.event.AnnotationSetEvent;
+import gate.event.AnnotationSetListener;
import gate.gui.MainFrame;
+import gate.swing.ColorGenerator;
+import java.awt.BorderLayout;
+import java.awt.Color;
+import java.awt.Component;
+import java.awt.FlowLayout;
+import java.awt.Point;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.KeyAdapter;
+import java.awt.event.KeyEvent;
+import java.awt.event.MouseAdapter;
+import java.awt.event.MouseEvent;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Set;
+import java.util.Vector;
+
+import javax.swing.AbstractAction;
+import javax.swing.BorderFactory;
+import javax.swing.ComboBoxEditor;
+import javax.swing.ComboBoxModel;
+import javax.swing.DefaultComboBoxModel;
+import javax.swing.JButton;
+import javax.swing.JCheckBox;
+import javax.swing.JColorChooser;
+import javax.swing.JComboBox;
+import javax.swing.JLabel;
+import javax.swing.JOptionPane;
+import javax.swing.JPanel;
+import javax.swing.JPopupMenu;
+import javax.swing.JScrollPane;
+import javax.swing.JTextArea;
+import javax.swing.JTextField;
+import javax.swing.JToggleButton;
+import javax.swing.JTree;
+import javax.swing.JWindow;
+import javax.swing.SwingUtilities;
+import javax.swing.ToolTipManager;
+import javax.swing.UIManager;
+import javax.swing.event.MouseInputAdapter;
+import javax.swing.text.DefaultHighlighter;
import javax.swing.text.Highlighter;
-import javax.swing.text.DefaultHighlighter;
+import javax.swing.tree.DefaultMutableTreeNode;
+import javax.swing.tree.TreeCellRenderer;
+import javax.swing.tree.TreePath;
/**
* Display a tree that contains the co-references type of the document,
@@ -1112,8 +1152,6 @@
/**
* Given an annotation, this method returns the string of that annotation
- * @param ann
- * @return
*/
public String getString(Annotation ann) {
return document.getContent().toString().substring(ann.
Modified: gate/trunk/src/gate/gui/docview/TextualDocumentView.java
===================================================================
--- gate/trunk/src/gate/gui/docview/TextualDocumentView.java 2012-01-10
13:14:07 UTC (rev 14980)
+++ gate/trunk/src/gate/gui/docview/TextualDocumentView.java 2012-01-10
13:45:27 UTC (rev 14981)
@@ -574,13 +574,13 @@
protected Map<AnnotationData, HighlightData> blinkingTagsForAnnotations;
/**
- * This list stores the {@link HighlightData} values for annotations pending
+ * This list stores the {@link TextualDocumentView.HighlightData} values for
annotations pending
* highlighting
*/
protected List<HighlightData> highlightsToAdd;
/**
- * This list stores the {@link HighlightData} values for highlights that need
+ * This list stores the {@link TextualDocumentView.HighlightData} values for
highlights that need
* to be removed
*/
protected List<HighlightData> highlightsToRemove;
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Write once. Port to many.
Get the SDK and tools to simplify cross-platform app development. Create
new or port existing apps to sell to consumers worldwide. Explore the
Intel AppUpSM program developer opportunity. appdeveloper.intel.com/join
http://p.sf.net/sfu/intel-appdev
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
