Explorar o código

Activated JavaDoc & fixed wrong JavaDoc Tags.

Dominik Fuchß %!s(int64=4) %!d(string=hai) anos
pai
achega
b5e918584f

+ 12 - 12
jplag/pom.xml

@@ -39,18 +39,18 @@
 					</archive>
 				</configuration>
 			</plugin>
-			<!-- <plugin> -->
-			<!-- <groupId>org.apache.maven.plugins</groupId> -->
-			<!-- <artifactId>maven-javadoc-plugin</artifactId> -->
-			<!-- <executions> -->
-			<!-- <execution> -->
-			<!-- <id>attach-javadocs</id> -->
-			<!-- <goals> -->
-			<!-- <goal>jar</goal> -->
-			<!-- </goals> -->
-			<!-- </execution> -->
-			<!-- </executions> -->
-			<!-- </plugin> -->
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<executions>
+					<execution>
+						<id>attach-javadocs</id>
+						<goals>
+							<goal>jar</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-source-plugin</artifactId>

+ 2 - 2
jplag/src/main/java/de/jplag/GreedyStringTiling.java

@@ -22,10 +22,10 @@ public class GreedyStringTiling implements TokenConstants {
     }
 
     /**
-     * Creating hashes in linear time. The hash-code will be written in every Token for the next <hash_length> token
+     * Creating hashes in linear time. The hash-code will be written in every Token for the next &lt;hash_length&gt; token
      * (includes the Token itself).
      * @param tokenList contains the tokens.
-     * @param hashLength is the hash length (condition: 1 < hashLength < 26)
+     * @param hashLength is the hash length (condition: 1 &lt; hashLength &lt; 26)
      * @param makeTable determines if a simple hash table is created in the structure.
      */
     public void createHashes(TokenList tokenList, int hashLength, boolean makeTable) {

+ 7 - 6
jplag/src/main/java/de/jplag/SubmissionSet.java

@@ -56,9 +56,10 @@ public class SubmissionSet {
     }
 
     /**
-     * Retrieve the base code of this collection.
+     * Retrieve the base code of this collection.<br>
+     * <b>Asking for a non-existing basecode crashes the errorConsumer.</b>
+     * 
      * @return The base code submission.
-     * @note Asking for a non-existing basecode crashes the errorConsumer.
      * @see #hasBaseCode
      */
     public Submission getBaseCode() {
@@ -76,16 +77,16 @@ public class SubmissionSet {
     }
 
     /**
-     * Obtain the valid submissions.
-     * @note Changes in the list are reflected in this instance.
+     * Obtain the valid submissions.<br>
+     * <b>Changes in the list are reflected in this instance.</b>
      */
     public List<Submission> getSubmissions() {
         return submissions;
     }
 
     /**
-     * Obtain the invalid submissions.
-     * @note Changes in the list are reflected in this instance.
+     * Obtain the invalid submissions.<br>
+     * <b>Changes in the list are reflected in this instance.</b>
      */
     public List<Submission> getInvalidSubmissions() {
         return invalidSubmissions;

+ 3 - 3
jplag/src/main/java/de/jplag/reporting/TagParser.java

@@ -3,10 +3,10 @@ package de.jplag.reporting;
 public class TagParser {
 
     /**
-     * Replaces all "{<index>_description}" tags inside the message string with params[<index>-1].
+     * Replaces all "{&lt;index&gt;_description}" tags inside the message string with params[&lt;index&gt;-1].
      * <p>
-     * Example: parse("blb {1_n/a} d {3_desc} sf {2_bla} d", new String[] {"#", blabla(), null}); returns "blb # d null sf
-     * blab d", if blabla() returns "blab"
+     * Example: parse("blb {1_n/a} d {3_desc} sf {2_bla} d", new String[] {"#", blabla(), null}); returns "blb # d null
+     * sf blab d", if blabla() returns "blab"
      */
     public static String parse(String message, String[] params) {
         String[] tokens = message.split("[{}]", -1);