Revision: 17864
http://sourceforge.net/p/gate/code/17864
Author: markagreenwood
Date: 2014-04-18 07:12:27 +0000 (Fri, 18 Apr 2014)
Log Message:
-----------
cleaned up the javadoc warnings
Modified Paths:
--------------
gate/trunk/src/main/gate/DocumentFormat.java
gate/trunk/src/main/gate/corpora/NekoHtmlDocumentFormat.java
gate/trunk/src/main/gate/creole/annic/HTMLGenerator.java
gate/trunk/src/main/gate/creole/annic/lucene/LuceneDocument.java
gate/trunk/src/main/gate/creole/annic/lucene/LuceneSearchThread.java
gate/trunk/src/main/gate/creole/annic/lucene/PatternValidator.java
gate/trunk/src/main/gate/creole/annic/lucene/SubQueryParser.java
gate/trunk/src/main/gate/creole/orthomatcher/OrthoMatcher.java
gate/trunk/src/main/gate/gui/docview/CorefEditor.java
gate/trunk/src/main/gate/persist/LuceneDataStoreImpl.java
Modified: gate/trunk/src/main/gate/DocumentFormat.java
===================================================================
--- gate/trunk/src/main/gate/DocumentFormat.java 2014-04-18 01:22:59 UTC
(rev 17863)
+++ gate/trunk/src/main/gate/DocumentFormat.java 2014-04-18 07:12:27 UTC
(rev 17864)
@@ -528,8 +528,6 @@
* .-separated tokens (such as .gate.xml.gz). The order the extensions are
* returned in is from the most specific (longest) to the most generic
* (shortest) one, e.g. [.gate.xml.gz, .xml.gz, .gz].
- * @param url
- * @return
*/
private static List<String> getFileSuffixes(URL url){
List<String> res = new LinkedList<String>();
Modified: gate/trunk/src/main/gate/corpora/NekoHtmlDocumentFormat.java
===================================================================
--- gate/trunk/src/main/gate/corpora/NekoHtmlDocumentFormat.java
2014-04-18 01:22:59 UTC (rev 17863)
+++ gate/trunk/src/main/gate/corpora/NekoHtmlDocumentFormat.java
2014-04-18 07:12:27 UTC (rev 17864)
@@ -259,9 +259,6 @@
* the document. The HTML parser only reports event positions as line
* and column numbers, so we need this information to be able to
* correctly infer the repositioning information.
- *
- * @param docContent
- * @return
*/
private int[] buildLineOffsets(String docContent) {
Matcher m = afterNewlinePattern.matcher(docContent);
Modified: gate/trunk/src/main/gate/creole/annic/HTMLGenerator.java
===================================================================
--- gate/trunk/src/main/gate/creole/annic/HTMLGenerator.java 2014-04-18
01:22:59 UTC (rev 17863)
+++ gate/trunk/src/main/gate/creole/annic/HTMLGenerator.java 2014-04-18
07:12:27 UTC (rev 17864)
@@ -146,9 +146,6 @@
/**
* This method is used for sorting the pattern annotations.
- *
- * @param annots
- * @return
*/
private static PatternAnnotation[] sort(PatternAnnotation[] annots) {
@@ -232,10 +229,6 @@
/**
* From given an array of pattern annotations, this method finds out
* the annotations of the given type.
- *
- * @param annotations
- * @param type
- * @return
*/
private static List<PatternAnnotation> findOutAnnotationsOfType(
PatternAnnotation[] annotations, String type) {
Modified: gate/trunk/src/main/gate/creole/annic/lucene/LuceneDocument.java
===================================================================
--- gate/trunk/src/main/gate/creole/annic/lucene/LuceneDocument.java
2014-04-18 01:22:59 UTC (rev 17863)
+++ gate/trunk/src/main/gate/creole/annic/lucene/LuceneDocument.java
2014-04-18 07:12:27 UTC (rev 17864)
@@ -512,9 +512,6 @@
/**
* Some file names are not compatible to the underlying file system. This
* method replaces all those incompatible characters with '_'.
- *
- * @param name
- * @return
*/
private String getCompatibleName(String name) {
return name.replaceAll("[\\/:\\*\\?\"<>|]", "_");
@@ -523,11 +520,6 @@
/**
* This method, given a tokenstream and file name, writes the tokenstream on
* the provided location.
- *
- * @param tokenStream
- * @param fileName
- * @param location
- * @throws Exception
*/
private void writeOnDisk(List<Token> tokenStream, String folderName,
String fileName, String location) throws Exception {
@@ -585,13 +577,6 @@
* This method given a GATE document and other required parameters, for each
* annotation of type indexUnitAnnotationType creates a separate list of
* baseTokens underlying in it.
- *
- * @param document
- * @param inputAs
- * @param featuresToExclude
- * @param baseTokenAnnotationType
- * @param indexUnitAnnotationType
- * @return
*/
private List<Token>[] getTokens(gate.Document document,
AnnotationSet inputAs, List<String> featuresToInclude,
Modified: gate/trunk/src/main/gate/creole/annic/lucene/LuceneSearchThread.java
===================================================================
--- gate/trunk/src/main/gate/creole/annic/lucene/LuceneSearchThread.java
2014-04-18 01:22:59 UTC (rev 17863)
+++ gate/trunk/src/main/gate/creole/annic/lucene/LuceneSearchThread.java
2014-04-18 07:12:27 UTC (rev 17864)
@@ -125,9 +125,6 @@
/**
* Given a file name, it replaces the all invalid characters with '_'.
- *
- * @param name
- * @return
*/
private String getCompatibleName(String name) {
return name.replaceAll("[\\/:\\*\\?\"<>|]", "_");
@@ -490,9 +487,6 @@
* pattern, converts it into the annic pattern. In other words, for
* each pattern it collects the information such as annotations in
* context and so on.
- *
- * @param aResult
- * @return
*/
private List<Pattern> createAnnicPatterns(LuceneQueryResult aResult) {
// get the result from search engine
@@ -514,13 +508,6 @@
/**
* Locates the valid patterns in token stream and discards the invalid
* first term positions returned by the lucene searcher.
- *
- * @param docID
- * @param gateAnnotations
- * @param firstTermPositions
- * @param patternLength
- * @param queryString
- * @return
*/
private List<Pattern> locatePatterns(String docID, String annotationSetName,
List<List<PatternAnnotation>> gateAnnotations,
@@ -641,9 +628,6 @@
* Each index unit is first converted into a separate lucene document.
* And a new ID with documentName and a unit number is assined to it.
* But when we return results, we take the unit number out.
- *
- * @param documentID
- * @return
*/
private String removeUnitNumber(String documentID) {
int index = documentID.lastIndexOf("-");
@@ -653,10 +637,6 @@
/**
* This method looks on the disk to find the tokenStream
- *
- * @param location String
- * @throws Exception
- * @return ArrayList
*/
private List<gate.creole.annic.apache.lucene.analysis.Token>
getTokenStreamFromDisk(
String indexDirectory, String documentFolder, String documentID)
throws Exception {
@@ -687,15 +667,6 @@
* positions, pattern length, queryType and patternWindow and returns
* the GateAnnotations as an array for each pattern with left and
* right context
- *
- * @param subTokens
- * @param ftp
- * @param patLen
- * @param qType
- * @param patWindow
- * @param query
- * @param baseTokenAnnotationType
- * @return
*/
private PatternResult getPatternResult(
List<gate.creole.annic.apache.lucene.analysis.Token> subTokens,
@@ -759,13 +730,6 @@
/**
* This method returns the valid patterns back and the respective
* GateAnnotations
- *
- * @param subTokens ArrayList
- * @param ftp ArrayList
- * @param patLen int
- * @param patWindow int
- * @param query String
- * @return PatternResult
*/
@SuppressWarnings({"rawtypes", "unchecked"})
private PatternResult getPatternResult(
@@ -1115,10 +1079,6 @@
/**
* Checks if the QueryItem already exists.
- *
- * @param n
- * @param top
- * @return
*/
// private boolean doesAlreadyExist(QueryItem n, List<QueryItem> top) {
//
Modified: gate/trunk/src/main/gate/creole/annic/lucene/PatternValidator.java
===================================================================
--- gate/trunk/src/main/gate/creole/annic/lucene/PatternValidator.java
2014-04-18 01:22:59 UTC (rev 17863)
+++ gate/trunk/src/main/gate/creole/annic/lucene/PatternValidator.java
2014-04-18 07:12:27 UTC (rev 17864)
@@ -35,7 +35,6 @@
* annotations in which it checks if the annotations exist that are
* validating for the given query
*
- * @throws SearchException
* @return int positive number indicates the offset of the last
* annotation of the pattern. -1 indicates invalid pattern.
*/
@@ -128,10 +127,6 @@
/**
* Checks whether two terms are equal.
- *
- * @param tk
- * @param term
- * @return
*/
private boolean isEqual(Token tk, Term term) {
return (term.text().equals(tk.termText()) &&
term.type().equals(tk.type()));
Modified: gate/trunk/src/main/gate/creole/annic/lucene/SubQueryParser.java
===================================================================
--- gate/trunk/src/main/gate/creole/annic/lucene/SubQueryParser.java
2014-04-18 01:22:59 UTC (rev 17863)
+++ gate/trunk/src/main/gate/creole/annic/lucene/SubQueryParser.java
2014-04-18 07:12:27 UTC (rev 17864)
@@ -44,10 +44,6 @@
/**
* Method retrieves wild card characters after the closing bracket.
- *
- * @param brClPos
- * @param query
- * @return
*/
private static String findWildCardString(int brClPos, String query) {
String wcs = "";
@@ -72,10 +68,6 @@
* This method, interprets the wild cards and convert query
* accordingly. For example: (A)+3 is converted into ((A) | ((A)(A)) |
* ((A)(A)(A)))
- *
- * @param query
- * @return
- * @throws SearchException
*/
private static String extractWildcards(String query) throws SearchException {
outer: while(true) {
@@ -159,7 +151,6 @@
* and the arrayList consists of
* 1. {A}{C}
* 2. {B}{C}
- * @throws SearchException
*/
public static List<String> parseQuery(String q1) throws SearchException {
@@ -378,10 +369,6 @@
/**
* This is a helper method that helps in duplicating the provided tokens.
- * @param tokens
- * @param queries
- * @param dupliSize
- * @return
*/
private static List<String> writeTokens(List<String> tokens, List<String>
queries,
int dupliSize) {
@@ -488,9 +475,6 @@
/**
* Returns the position of a closing bracket.
- * @param startFrom
- * @param query
- * @return
*/
private static int findBracketClosingPosition(int startFrom, String query) {
int balance = 0;
@@ -518,10 +502,6 @@
/**
* Helps in duplicating a character in the provided queries
- * @param c
- * @param no
- * @param queries
- * @return
*/
private static List<String> writeCharInAll(char c, int no, List<String>
queries) {
for(int i = 0; i < no; i++) {
@@ -534,10 +514,6 @@
/**
* Helps in duplicating a string in the provided queries
- * @param c
- * @param no
- * @param queries
- * @return
*/
private static List<String> writeStringInAll(String c, int no, List<String>
queries) {
for(int i = 0; i < no; i++) {
@@ -550,9 +526,6 @@
/**
* Returns if the character is bracket used to mark boundary of a token or
an escape character.
- * @param ch
- * @param pre
- * @return
*/
private static boolean isOpenBracket(char ch, char pre) {
if(ch == '(' && pre != '\\')
@@ -562,9 +535,6 @@
/**
* Returns if the character is bracket used to mark boundary of a token or
an escape character.
- * @param ch
- * @param pre
- * @return
*/
private static boolean isClosingBracket(char ch, char pre) {
if(ch == ')' && pre != '\\')
@@ -574,9 +544,6 @@
/**
* Returns if the character is an OR symbol used as a logical operator or an
escape character.
- * @param ch
- * @param pre
- * @return
*/
private static boolean isOrSym(char ch, char pre) {
if(ch == '|' && pre != '\\')
Modified: gate/trunk/src/main/gate/creole/orthomatcher/OrthoMatcher.java
===================================================================
--- gate/trunk/src/main/gate/creole/orthomatcher/OrthoMatcher.java
2014-04-18 01:22:59 UTC (rev 17863)
+++ gate/trunk/src/main/gate/creole/orthomatcher/OrthoMatcher.java
2014-04-18 07:12:27 UTC (rev 17864)
@@ -1085,10 +1085,6 @@
/**
* basic_person_match_criteria
* Note that this function relies on various global variables in some other
match rules.
- * @param shortName
- * @param longName
- * @param mr
- * @return
*/
private boolean basic_person_match_criteria(String shortName,
String longName, boolean mr[]) {
Modified: gate/trunk/src/main/gate/gui/docview/CorefEditor.java
===================================================================
--- gate/trunk/src/main/gate/gui/docview/CorefEditor.java 2014-04-18
01:22:59 UTC (rev 17863)
+++ gate/trunk/src/main/gate/gui/docview/CorefEditor.java 2014-04-18
07:12:27 UTC (rev 17864)
@@ -930,8 +930,6 @@
/**
* Returns annotation Set
- * @param annotSet
- * @return
*/
private AnnotationSet getAnnotationSet(String annotSet) {
return (annotSet.equals(DEFAULT_ANNOTSET_NAME)) ?
document.getAnnotations() :
@@ -1204,8 +1202,6 @@
/**
* Given an annotation, this will find out the chainHead
- * @param ann
- * @return
*/
private CorefTreeNode findOutTheChainHead(Annotation ann, String set) {
Map<CorefTreeNode, List<Integer>> chains =
corefChains.get(corefAnnotationSetNodesMap.get(
Modified: gate/trunk/src/main/gate/persist/LuceneDataStoreImpl.java
===================================================================
--- gate/trunk/src/main/gate/persist/LuceneDataStoreImpl.java 2014-04-18
01:22:59 UTC (rev 17863)
+++ gate/trunk/src/main/gate/persist/LuceneDataStoreImpl.java 2014-04-18
07:12:27 UTC (rev 17864)
@@ -224,9 +224,6 @@
/**
* Obtain the lock object on which we must synchronize when loading or
* saving the LR with the given ID.
- *
- * @param id
- * @return
*/
private Object lockObjectForID(Object id) {
synchronized(lockObjects) {
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Learn Graph Databases - Download FREE O'Reilly Book
"Graph Databases" is the definitive new guide to graph databases and their
applications. Written by three acclaimed leaders in the field,
this first edition is now available. Download your free book today!
http://p.sf.net/sfu/NeoTech
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
