Revision: 6132
          
http://languagetool.svn.sourceforge.net/languagetool/?rev=6132&view=rev
Author:   dnaber
Date:     2012-01-01 11:59:22 +0000 (Sun, 01 Jan 2012)
Log Message:
-----------
improve javadoc

Modified Paths:
--------------
    
trunk/JLanguageTool/src/java/org/languagetool/rules/patterns/PatternRule.java

Modified: 
trunk/JLanguageTool/src/java/org/languagetool/rules/patterns/PatternRule.java
===================================================================
--- 
trunk/JLanguageTool/src/java/org/languagetool/rules/patterns/PatternRule.java   
    2012-01-01 11:58:53 UTC (rev 6131)
+++ 
trunk/JLanguageTool/src/java/org/languagetool/rules/patterns/PatternRule.java   
    2012-01-01 11:59:22 UTC (rev 6132)
@@ -69,7 +69,8 @@
 
   /**
    * @param id
-   *          Id of the Rule
+   *          Id of the Rule. Used in configuration. Should not contain 
special characters and should
+   *          be stable over time, unless the rule changes completely.
    * @param language
    *          Language of the Rule
    * @param elements
@@ -78,8 +79,9 @@
    *          Description to be shown (name)
    * @param message
    *          Message to be displayed to the user
+   * @param shortMessage
+   *          Message to be displayed to the user in the context menu in 
OpenOffice.org/LibreOffice
    */
-
   public PatternRule(final String id, final Language language,
       final List<Element> elements, final String description,
       final String message, final String shortMessage) {

This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.


------------------------------------------------------------------------------
Ridiculously easy VDI. With Citrix VDI-in-a-Box, you don't need a complex
infrastructure or vast IT resources to deliver seamless, secure access to
virtual desktops. With this all-in-one solution, easily deploy virtual 
desktops for less than the cost of PCs and save 60% on VDI infrastructure 
costs. Try it free! http://p.sf.net/sfu/Citrix-VDIinabox
_______________________________________________
Languagetool-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/languagetool-cvs

Reply via email to