Commit 8bb15894 authored by Brian Long's avatar Brian Long
Browse files

updated javadocs

parent bd5b2185

src/main/java/com/inteligr8/maven/aps/modeling/crawler/ApsTemplateCrawler.java

+1 −2
Original line number Diff line number Diff line
@@ -33,8 +33,7 @@ public class ApsTemplateCrawler { 
	private final boolean failOnIntegrityViolation;

	

	/**

	 * @param apsAppName A name for the APS App.

	 * @param apsAppDirectory A directory to the unpacked APS App export.

	 * @param apsTemplateDirectory A directory to the APS template files.

	 * @param failOnIntegrityViolation true to fail on file integrity issues; false to log warnings.

	 */

	public ApsTemplateCrawler(File apsTemplateDirectory, boolean failOnIntegrityViolation) {

src/main/java/com/inteligr8/maven/aps/modeling/goal/ApsAddressibleGoal.java

+2 −0
Original line number Diff line number Diff line
@@ -120,6 +120,8 @@ public abstract class ApsAddressibleGoal extends DisablableGoal { 
	}

	

	/**

	 * This method constructs and caches the APS API accessor.

	 * 

	 * @return An APS API instance.

	 */

	public synchronized ApsPublicRestApiJerseyImpl getApsApi() {

src/main/java/com/inteligr8/maven/aps/modeling/translator/ApsTemplateJsonTranslator.java

+0 −2
Original line number Diff line number Diff line
@@ -37,8 +37,6 @@ public class ApsTemplateJsonTranslator implements ApsFileTranslator { 
	

	/**

	 * This constructor initializes the default translator.

	 * 

	 * @param api An APS API reference.

	 */

	public ApsTemplateJsonTranslator(

			Index<Long, String> apsDocumentTemplateIndex,

src/main/java/com/inteligr8/maven/aps/modeling/util/Index.java

+2 −0
Original line number Diff line number Diff line
@@ -35,6 +35,8 @@ import com.fasterxml.jackson.databind.ObjectMapper; 
 * `allowDuplicateValues` to `false`.

 * 

 * @author brian@inteligr8.com

 * @param <K> An index key type.

 * @param <V> An index value type.

 */

public class Index<K, V> {

src/main/java/com/inteligr8/maven/aps/modeling/util/MapComparator.java

+2 −0
Original line number Diff line number Diff line
@@ -28,6 +28,8 @@ import java.util.Map; 
 * any sorted list.

 * 

 * @author brian@inteligr8.com

 * @param <K> An map key type.

 * @param <V> An map value type.

 */

public class MapComparator<K, V> implements Comparator<Map<K, V>> {