#161 - Fixing javadoc to remove WARNING

pom.xml

@@ -256,10 +256,9 @@
 				<!-- common configuration by all executions -->
 				<configuration>
 					<baseDir>${project.build.directory}/${project.build.finalName}-dist/lsc-${project.version}</baseDir>
-					<installFile>src/install/install.xml</installFile>
+					<installFile>${project.basedir}/src/install/install.xml</installFile>
 					<mkdirs>true</mkdirs>
 					<finalName>${project.artifactId}-${project.version}-installer.jar</finalName>
-					<enableAttachArtifact>false</enableAttachArtifact>
 					<autoIncludeUrl>true</autoIncludeUrl>
 				</configuration>
 

src/main/java/org/lsc/AbstractSynchronize.java

@@ -320,8 +320,8 @@ public final String getTaskFullStatus(final String syncName) {
 	/**
 	 * Log all effective action.
 	 * 
-	 * @param jm List of modification to do on the Ldap server
-	 * @param identifier object identifier
+	 * @param lm List of modification to do on the Ldap server
+	 * @param data object identifier
 	 * @param except synchronization process name
 	 */
 	public final void logActionError(final LscModifications lm,
@@ -340,7 +340,7 @@ public final void logActionError(final LscModifications lm,
 	/**
 	 * Log all effective action.
 	 * 
-	 * @param jm List of modification to do on the Ldap server
+	 * @param lm List of modification to do on the Ldap server
 	 * @param id object identifier
 	 * @param syncName synchronization process name
 	 */
@@ -372,9 +372,8 @@ public final void logAction(final LscModifications lm,
 	}
 
 	/**
-	 * @param jm
-	 * @param id
-	 * @param syncName
+	 * @param lm List of modification to do on the Ldap server
+	 * @param syncName synchronization process name
 	 */
 	public final void logShouldAction(final LscModifications lm, final String syncName) {
 		switch (lm.getOperation()) {
@@ -412,12 +411,10 @@ protected void logStatus(InfoCounter counter) {
 	}
 
 	protected String getLogStatus(InfoCounter counter) {
-		String totalsLogMessage =
-				"All entries: "+ counter.getCountAll() +
+		return "All entries: "+ counter.getCountAll() +
 				", to modify entries: "+ counter.getCountModifiable() +
 				", successfully modified entries: "+counter.getCountCompleted()+
 				", errors: "+counter.getCountError();
-		return totalsLogMessage;
 	}
 
 	public IBean getBean(Task task, IService service, String pivotName, LscDatasets pivotAttributes, boolean fromSameService, boolean fromSource) throws LscServiceException {

src/main/java/org/lsc/jndi/AbstractSimpleJndiService.java

@@ -327,7 +327,7 @@ public final String getFilterId() {
 
 
 	/**
-	 * @see org.lsc.service.IService.getSupportedConnectionType()
+	 * @see org.lsc.service.IService#getSupportedConnectionType()
 	 */
 	public Collection<Class<? extends ConnectionType>> getSupportedConnectionType() {
 	    Collection<Class<? extends ConnectionType>> list = new ArrayList<Class<? extends ConnectionType>>();

src/main/java/org/lsc/jndi/JndiServices.java

@@ -1080,10 +1080,10 @@ public Map<String, LscDatasets> getAttrsList(final String base,
     /**
      * Retrieve a specific attribute from an object
      * 
-     * @param objectDn
-     * @param attribute
-     * @return
-     * @throws LscServiceException
+     * @param objectDn Distinguished Name of object attributes
+     * @param attribute Attributes returned by query
+     * @return List of objects returned from Source
+     * @throws LscServiceException Thrown when LSC fails to general issues
      */
     public List<String> getAttributeValues(String objectDn, String attribute) throws LscServiceException {
         List<String> values = null;
@@ -1262,7 +1262,7 @@ public LdapContext getContext() throws NamingException {
 	 * Get the initial JNDI context or get a derived context to be able to use controls without 
 	 * impacting or being impacted by other threads sharing a same context
 	 * @param forUpdates if this derived context is for updates
-	 * @return
+	 * @return {@link LdapContext} object for LDAPv3 connection
 	 * @throws NamingException
 	 */
 	public LdapContext getContext(boolean forUpdates) throws NamingException {

src/main/java/org/lsc/jndi/ScriptableJndiServices.java

@@ -135,7 +135,7 @@ protected final List<String> _list(final String base, final String filter) throw
          * 
          * @param base The base DN to search from.
          * @param filter The LDAP filter to use.
-         * @attribute attribute The attribute to search.
+         * @param attribute The attribute to search.
          * @return List<String> List of attributes values returned by the search.
          * @throws NamingException
          */
@@ -150,7 +150,7 @@ public final List<String> searchAttribute(final Object base, final Object filter
          *
          * @param base The base DN to search from.
          * @param filter The LDAP filter to use.
-         * @attribute attribute The attribute to search.
+         * @param attribute The attribute to search.
          * @return List<String> List of attributes values returned by the search.
          * @throws NamingException
          */

src/main/java/org/lsc/service/AbstractJdbcService.java

@@ -294,7 +294,7 @@ public static String getValue(Object value) {
 
 
     /**
-     * @see org.lsc.service.IService.getSupportedConnectionType()
+     * @see org.lsc.service.IService#getSupportedConnectionType()
      */
     public Collection<Class<? extends ConnectionType>> getSupportedConnectionType() {
         Collection<Class<? extends ConnectionType>> list = new ArrayList<Class<? extends ConnectionType>>();

src/main/java/org/lsc/service/MultipleDstService.java

@@ -169,7 +169,7 @@ public List<String> getWriteDatasetIds() {
 	}
 
     /**
-     * @see org.lsc.service.IService.getSupportedConnectionType()
+     * @see org.lsc.service.IService#getSupportedConnectionType()
      */
     public Collection<Class<? extends ConnectionType>> getSupportedConnectionType() {
         Collection<Class<? extends ConnectionType>> list = new ArrayList<Class<? extends ConnectionType>>();

src/main/java/org/lsc/service/XALdifDstService.java

@@ -263,7 +263,7 @@ public List<String> getWriteDatasetIds() {
 
 
     /**
-     * @see org.lsc.service.IService.getSupportedConnectionType()
+     * @see org.lsc.service.IService#getSupportedConnectionType()
      */
     public Collection<Class<? extends ConnectionType>> getSupportedConnectionType() {
         Collection<Class<? extends ConnectionType>> list = new ArrayList<Class<? extends ConnectionType>>();

src/main/java/org/lsc/utils/RhinoDebugger.java

@@ -118,7 +118,7 @@ public void run() {
     /**
      * Is Debugger visible?
      * 
-     * @return
+     * @return true if {@link SwingGui} is visible
      */
     public boolean isVisible() {
         return debugGui != null && debugGui.isVisible();

src/main/java/org/lsc/utils/SetUtils.java

@@ -68,8 +68,7 @@ private SetUtils() {
 	 * Return a new HashSet containing all the Objects that are an Attribute's
 	 * values.
 	 * 
-	 * @param attr
-	 *            An Attribute containing values to extract.
+	 * @param attr An Attribute containing values to extract.
 	 * @return {@link HashSet}<Object> Values as a set. Never null.
 	 * @throws NamingException
 	 */
@@ -207,11 +206,9 @@ public static Set<Object> findMissingNeedles(Set<?> haystack, Set<Object> needle
 	 * in the same order. This method is type-aware and will intelligently compare
 	 * byte[], String, etc.
 	 * 
-	 * @param first
-	 *            First set of Objects to compare.
-	 * @param second
-	 *            Second set of Objects.
-	 * @return {@link boolean} if the order is the same.
+	 * @param first First set of Objects to compare.
+	 * @param second Second set of Objects.
+	 * @return true if the order is the same.
 	 */
 	public static boolean checkOrder(Set<?> first, Set<Object> second) {
 		if (first.size() != second.size()) {