Просмотр исходного кода

Fixed typo in method name and added comments provided by PR #83.

Timur Sağlam 5 лет назад
Родитель
Сommit
91a448384c

+ 50 - 14
jplag.frontend-utils/src/main/java/jplag/Language.java

@@ -1,33 +1,69 @@
 package jplag;
 
-
 import java.io.*;
 
 /**
- * One interface for all languages...
+ * Common interface for all languages. Each language-front end must provide a concrete language implementation.
  */
 public interface Language {
-	public String[] suffixes();
 
-	public String name();
+    /**
+     * Suffixes for the files containing code of the language.
+     */
+    public String[] suffixes();
+
+    /**
+     * Descriptive name of the language.
+     */
+    public String name();
 
-	public String getShortName();
+    /**
+     * Short name of the language used for CLI options.
+     */
+    public String getShortName();
 
-	public int min_token_match();
+    /**
+     * Minimum number of tokens required for a match.
+     */
+    public int min_token_match();
 
-	public Structure parse(File dir, String[] files);
+    /**
+     * Parses a set files in a directory.
+     */
+    public Structure parse(File dir, String[] files);
 
-	public boolean errors();
+    /**
+     * Whether errors were found during the last {@link #parse}.
+     */
+    public boolean errors();
 
-	public int errorsCount();
+    /**
+     * Number of errors found during the last {@link #parse}.
+     */
+    public int errorsCount();
 
-	public boolean supportsColumns();
+    /**
+     * Determines whether the parser provide column information.
+     */
+    public boolean supportsColumns();
 
-	public boolean isPreformated();
+    /**
+     * Determines whether JPlag should use a fixed-width font in its reports.
+     */
+    public boolean isPreformatted();
 
-	public boolean usesIndex();
+    /**
+     * Determines whether tokens from the scanner are indexed.
+     */
+    public boolean usesIndex();
 
-	public int noOfTokens();
+    /**
+     * Number of defined tokens in the scanner of the language.
+     */
+    public int noOfTokens();
 
-	public String type2string(int type);
+    /**
+     * Convert a token type to a text representation.
+     */
+    public String type2string(int type);
 }

+ 1 - 1
jplag.frontend.chars/src/main/java/jplag/chars/Language.java

@@ -55,7 +55,7 @@ public class Language implements jplag.Language {
 		return false;
 	}
 
-	public boolean isPreformated() {
+	public boolean isPreformatted() {
 		return false;
 	}
 

+ 1 - 1
jplag.frontend.cpp/src/main/java/jplag/cpp/Language.java

@@ -42,7 +42,7 @@ public class Language implements jplag.Language {
 		return false;
 	}
 
-	public boolean isPreformated() {
+	public boolean isPreformatted() {
 		return true;
 	}
 

+ 1 - 1
jplag.frontend.csharp-1.2/src/main/java/jplag/csharp/Language.java

@@ -46,7 +46,7 @@ public class Language implements jplag.Language {
 		return true;
 	}
 
-	public boolean isPreformated() {
+	public boolean isPreformatted() {
 		return true;
 	}
 

+ 1 - 1
jplag.frontend.java-1.1exp/src/main/java/jplag/javax/Language.java

@@ -39,7 +39,7 @@ public class Language implements jplag.Language {
 		return false;
 	}
 
-	public boolean isPreformated() {
+	public boolean isPreformatted() {
 		return true;
 	}
 

+ 1 - 1
jplag.frontend.java-1.2/src/main/java/jplag/java/Language.java

@@ -45,7 +45,7 @@ public class Language implements jplag.Language {
 		return true;
 	}
 
-	public boolean isPreformated() {
+	public boolean isPreformatted() {
 		return true;
 	}
 

+ 1 - 1
jplag.frontend.java-1.5/src/main/java/jplag/java15/Language.java

@@ -45,7 +45,7 @@ public class Language implements jplag.Language {
 		return true;
 	}
 
-	public boolean isPreformated() {
+	public boolean isPreformatted() {
 		return true;
 	}
 

+ 1 - 1
jplag.frontend.java-1.5/src/main/java/jplag/java15/LanguageWithDelimitedMethods.java

@@ -50,7 +50,7 @@ public class LanguageWithDelimitedMethods implements jplag.Language {
 		return true;
 	}
 
-	public boolean isPreformated() {
+	public boolean isPreformatted() {
 		return true;
 	}
 

+ 1 - 1
jplag.frontend.java-1.7/src/main/java/jplag/java17/Language.java

@@ -45,7 +45,7 @@ public class Language implements jplag.Language {
 		return true;
 	}
 
-	public boolean isPreformated() {
+	public boolean isPreformatted() {
 		return true;
 	}
 

+ 1 - 1
jplag.frontend.java-1.9/src/main/java/jplag/java19/Language.java

@@ -38,7 +38,7 @@ public class Language implements jplag.Language {
 		return true;
 	}
 
-	public boolean isPreformated() {
+	public boolean isPreformatted() {
 		return true;
 	}
 

+ 1 - 1
jplag.frontend.python-3/src/main/java/jplag/python3/Language.java

@@ -46,7 +46,7 @@ public class Language implements jplag.Language {
         return true;
     }
 
-    public boolean isPreformated() {
+    public boolean isPreformatted() {
         return true;
     }
 

+ 1 - 1
jplag.frontend.scheme/src/main/java/jplag/scheme/Language.java

@@ -40,7 +40,7 @@ public class Language implements jplag.Language {
 		return false;
 	}
 
-	public boolean isPreformated() {
+	public boolean isPreformatted() {
 		return true;
 	}
 

+ 1 - 1
jplag.frontend.text/src/main/java/jplag/text/Language.java

@@ -53,7 +53,7 @@ public class Language implements jplag.Language {
 		return true;
 	}
 
-	public boolean isPreformated() {
+	public boolean isPreformatted() {
 		return false;
 	}
 

+ 6 - 6
jplag/src/main/java/jplag/reporting/Report.java

@@ -636,18 +636,18 @@ public class Report {
             f.println("</center>");
             f.println("</h3>");
             f.println("<HR>");
-            if (result.getOptions().getLanguage().isPreformated()) {
+            if (result.getOptions().getLanguage().isPreformatted()) {
                 f.println("<PRE>");
             }
             for (int y = 0; y < text[x].length; y++) {
                 f.print(text[x][y]);
-                if (!result.getOptions().getLanguage().isPreformated()) {
+                if (!result.getOptions().getLanguage().isPreformatted()) {
                     f.println("<BR>");
                 } else {
                     f.println();
                 }
             }
-            if (result.getOptions().getLanguage().isPreformated()) {
+            if (result.getOptions().getLanguage().isPreformatted()) {
                 f.println("</PRE>");
             }
         }
@@ -855,18 +855,18 @@ public class Report {
             f.println("</center>");
             f.println("</h3>");
             f.println("<HR>");
-            if (result.getOptions().getLanguage().isPreformated()) {
+            if (result.getOptions().getLanguage().isPreformatted()) {
                 f.println("<PRE>");
             }
             for (int y = 0; y < text[x].length; y++) {
                 f.print(text[x][y]);
-                if (!result.getOptions().getLanguage().isPreformated()) {
+                if (!result.getOptions().getLanguage().isPreformatted()) {
                     f.println("<BR>");
                 } else {
                     f.println();
                 }
             }
-            if (result.getOptions().getLanguage().isPreformated()) {
+            if (result.getOptions().getLanguage().isPreformatted()) {
                 f.println("</PRE>");
             }
         }