Revision: 6957
http://languagetool.svn.sourceforge.net/languagetool/?rev=6957&view=rev
Author: dnaber
Date: 2012-05-17 13:09:01 +0000 (Thu, 17 May 2012)
Log Message:
-----------
small javadoc improvements
Modified Paths:
--------------
trunk/JLanguageTool/src/java/org/languagetool/rules/Rule.java
Modified: trunk/JLanguageTool/src/java/org/languagetool/rules/Rule.java
===================================================================
--- trunk/JLanguageTool/src/java/org/languagetool/rules/Rule.java
2012-05-17 13:06:47 UTC (rev 6956)
+++ trunk/JLanguageTool/src/java/org/languagetool/rules/Rule.java
2012-05-17 13:09:01 UTC (rev 6957)
@@ -70,15 +70,18 @@
*/
public abstract String getId();
+ /**
+ * A short description of the error this rule can detect, usually in the
language of the text
+ * that is checked.
+ */
public abstract String getDescription();
/**
* Check whether the given text matches this error rule, i.e. whether the
text
* contains this error.
*
- * @param text
- * a pre-analyzed sentence
- * @return an array of RuleMatch object for each match.
+ * @param text a pre-analyzed sentence
+ * @return an array of {@link RuleMatch} objects
*/
public abstract RuleMatch[] match(AnalyzedSentence text) throws IOException;
@@ -216,7 +219,7 @@
/**
* Turns the rule off by default.
- **/
+ */
public final void setDefaultOff() {
defaultOff = true;
}
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Languagetool-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/languagetool-cvs
