FINRACT-456 Javadoc generation possible now

2017-05-18 18:52:23 +02:00
parent 0c658956b9
commit af9fecb72c
57 changed files with 172 additions and 149 deletions
@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Class-Path: 
+
@@ -92,6 +92,7 @@ rat {
 excludes = [
 	'**/licenses/**',
 	'**/*.md',
+	'**/MANIFEST.MF',
 	'**/*.txt',
 	'**/*.log',
 	'**/fineractdev-eclipse-preferences.epf',
@@ -379,18 +379,17 @@ public class AccountingProcessorHelper {
     * The target accounts for debits and credits are switched in case of a
     * reversal
     * 
-     * @param office
-     * @param accountTypeToBeDebited
-     *            Enum of the placeholder GLAccount to be debited
-     * @param accountTypeToBeCredited
-     *            Enum of the placeholder of the GLAccount to be credited
-     * @param loanProductId
-     * @param paymentTypeId
-     * @param loanId
-     * @param transactionId
-     * @param transactionDate
-     * @param amount
-     * @param isReversal
+     * @param office office
+     * @param currencyCode currencyCode
+     * @param accountTypeToBeDebited  Enum of the placeholder GLAccount to be debited
+     * @param accountTypeToBeCredited Enum of the placeholder of the GLAccount to be credited
+     * @param loanProductId loanProductId
+     * @param loanId loanId
+     * @param transactionId transactionId
+     * @param transactionDate transactionDate
+     * @param totalAmount totalAmount
+     * @param isReversal isReversal
+     * @param chargePaymentDTOs chargePaymentDTOs
     */
    public void createAccrualBasedJournalEntriesAndReversalsForLoanCharges(final Office office, final String currencyCode,
            final Integer accountTypeToBeDebited, final Integer accountTypeToBeCredited, final Long loanProductId, final Long loanId,
@@ -568,17 +567,17 @@ public class AccountingProcessorHelper {
     * reversal
     * 
     * @param office
-     * @param accountTypeToBeDebited
-     *            Enum of the placeholder GLAccount to be debited
-     * @param accountTypeToBeCredited
-     *            Enum of the placeholder of the GLAccount to be credited
+     * @param currencyCode
+     * @param accountTypeToBeDebited Enum of the placeholder GLAccount to be debited
+     * @param accountTypeToBeCredited Enum of the placeholder of the GLAccount to be credited
     * @param savingsProductId
     * @param paymentTypeId
-     * @param loanId
+     * @param savingsId
     * @param transactionId
     * @param transactionDate
     * @param amount
     * @param isReversal
+     * @param taxDetails
     */
    public void createCashBasedJournalEntriesAndReversalsForSavingsTax(final Office office, final String currencyCode,
            final CASH_ACCOUNTS_FOR_SAVINGS accountTypeToBeDebited, final CASH_ACCOUNTS_FOR_SAVINGS accountTypeToBeCredited,
@@ -726,18 +725,18 @@ public class AccountingProcessorHelper {
     * The target accounts for debits and credits are switched in case of a
     * reversal
     * 
-     * @param office
-     * @param accountTypeToBeDebited
-     *            Enum of the placeholder GLAccount to be debited
-     * @param accountTypeToBeCredited
-     *            Enum of the placeholder of the GLAccount to be credited
-     * @param savingsProductId
-     * @param paymentTypeId
-     * @param loanId
-     * @param transactionId
-     * @param transactionDate
-     * @param amount
-     * @param isReversal
+     * @param office office
+     * @param currencyCode currencyCode
+     * @param accountTypeToBeDebited Enum of the placeholder GLAccount to be debited
+     * @param accountTypeToBeCredited Enum of the placeholder of the GLAccount to be credited
+     * @param savingsProductId savingsProductId
+     * @param paymentTypeId paymentTypeId
+     * @param loanId loanId
+     * @param transactionId transactionId
+     * @param transactionDate transactionDate
+     * @param totalAmount totalAmount
+     * @param isReversal isReversal
+     * @param chargePaymentDTOs chargePaymentDTOs
     */
    public void createCashBasedJournalEntriesAndReversalsForSavingsCharges(final Office office, final String currencyCode,
            final CASH_ACCOUNTS_FOR_SAVINGS accountTypeToBeDebited, final CASH_ACCOUNTS_FOR_SAVINGS accountTypeToBeCredited,
@@ -33,9 +33,9 @@ import org.springframework.stereotype.Component;
 * Implements {@link org.apache.fineract.batch.command.CommandStrategy} and
 * applies a new loan on an existing client. It passes the contents of the body
 * from the BatchRequest to
- * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and gets back
+ * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and gets back
 * the response. This class will also catch any errors raised by
- * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and map those
+ * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and map those
 * errors to appropriate status codes in BatchResponse.
 * 
 * @author Rishabh Shukla
@@ -33,9 +33,9 @@ import org.springframework.stereotype.Component;
 * Implements {@link org.apache.fineract.batch.command.CommandStrategy} and
 * applies a new savings on an existing client. It passes the contents of the
 * body from the BatchRequest to
- * {@link org.apache.fineract.portfolio.client.api.SavingsAccountsApiResource} and
+ * {@link org.apache.fineract.portfolio.savings.api.SavingsAccountsApiResource} and
 * gets back the response. This class will also catch any errors raised by
- * {@link org.apache.fineract.portfolio.client.api.SavingsAccountsApiResource} and
+ * {@link org.apache.fineract.portfolio.savings.api.SavingsAccountsApiResource} and
 * map those errors to appropriate status codes in BatchResponse.
 * 
 * @author Rishabh Shukla
@@ -33,9 +33,9 @@ import org.springframework.stereotype.Component;
 * Implements {@link org.apache.fineract.batch.command.CommandStrategy} to handle
 * approval of a pending loan. It passes the contents of the body from the
 * BatchRequest to
- * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and gets
+ * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and gets
 * back the response. This class will also catch any errors raised by
- * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and map
+ * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and map
 * those errors to appropriate status codes in BatchResponse.
 * 
 * @author Rishabh Shukla
@@ -33,9 +33,9 @@ import org.springframework.stereotype.Component;
 * Implements {@link org.apache.fineract.batch.command.CommandStrategy} and
 * Collect Charges for a Loan. It passes the contents of the body from the
 * BatchRequest to
- * {@link org.apache.fineract.portfolio.client.api.LoanChargesApiResource} and
+ * {@link org.apache.fineract.portfolio.loanaccount.api.LoanChargesApiResource} and
 * gets back the response. This class will also catch any errors raised by
- * {@link org.apache.fineract.portfolio.client.api.LoanChargesApiResource} and map
+ * {@link org.apache.fineract.portfolio.loanaccount.api.LoanChargesApiResource} and map
 * those errors to appropriate status codes in BatchResponse.
 * 
 * @author Rishabh Shukla
@@ -32,9 +32,9 @@ import org.springframework.stereotype.Component;
 /**
 * Implements {@link org.apache.fineract.batch.command.CommandStrategy} and Create
 * Charge for a Loan. It passes the contents of the body from the BatchRequest
- * to {@link org.apache.fineract.portfolio.client.api.LoanChargesApiResource} and
+ * to {@link org.apache.fineract.portfolio.loanaccount.api.LoanChargesApiResource} and
 * gets back the response. This class will also catch any errors raised by
- * {@link org.apache.fineract.portfolio.client.api.LoanChargesApiResource} and map
+ * {@link org.apache.fineract.portfolio.loanaccount.api.LoanChargesApiResource} and map
 * those errors to appropriate status codes in BatchResponse.
 * 
 * @author Rishabh Shukla
@@ -33,9 +33,9 @@ import org.springframework.stereotype.Component;
 * Implements {@link org.apache.fineract.batch.command.CommandStrategy} to handle
 * disburse of a loan. It passes the contents of the body from the
 * BatchRequest to
- * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and gets
+ * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and gets
 * back the response. This class will also catch any errors raised by
- * {@link org.apache.fineract.portfolio.client.api.LoansApiResource} and map
+ * {@link org.apache.fineract.portfolio.loanaccount.api.LoansApiResource} and map
 * those errors to appropriate status codes in BatchResponse.
 * 
 * @author Rishabh Shukla
@@ -46,7 +46,7 @@ public class BatchRequestJsonHelper extends FromJsonHelper {
     * JSON string.
     * 
     * @param json
-     * @return List<BatchRequest>
+     * @return List&lt;BatchRequest&gt;
     */
    public List<BatchRequest> extractList(final String json) {
        final Type listType = new TypeToken<List<BatchRequest>>() {}.getType();
@@ -45,7 +45,7 @@ public interface BatchApiService {
     * 
     * @param requestList
     * @param uriInfo
-     * @return List<BatchResponse>
+     * @return List&lt;BatchResponse&gt;
     */
    List<BatchResponse> handleBatchRequestsWithoutEnclosingTransaction(List<BatchRequest> requestList, UriInfo uriInfo);

@@ -59,7 +59,7 @@ public interface BatchApiService {
     * 
     * @param requestList
     * @param uriInfo
-     * @return List<BatchResponse>
+     * @return List&lt;BatchResponse&gt;
     */
    List<BatchResponse> handleBatchRequestsWithEnclosingTransaction(List<BatchRequest> requestList, UriInfo uriInfo);
 }
@@ -91,7 +91,7 @@ public class ResolutionHelper {
     * dependency hierarchy of that particular list.
     * 
     * @param batchRequests
-     * @return List<ArrayList<BatchRequestNode>>
+     * @return List&lt;ArrayList&lt;BatchRequestNode&gt;&gt;
     */
    public List<BatchRequestNode> getDependingRequests(final List<BatchRequest> batchRequests) {
        final List<BatchRequestNode> rootRequests = new ArrayList<>();
@@ -128,7 +128,7 @@ public class ResolutionHelper {
     * Request.
     * 
     * @param request
-     * @param lastResponse
+     * @param parentResponse
     * @return BatchRequest
     */
    public BatchRequest resoluteRequest(final BatchRequest request, final BatchResponse parentResponse) {
@@ -21,8 +21,8 @@ package org.apache.fineract.commands.annotation;
 import java.lang.annotation.*;

 /**
- * Specifies the command type for the annotated class.<br/>
- * <br/>
+ * Specifies the command type for the annotated class.<br>
+ * <br>
 * The entity name (e.g. CLIENT, SAVINGSACCOUNT, LOANPRODUCT) and the action (e.g. CREATE, DELETE) must be given.
 *
 * @author Markus Geiss
@@ -35,8 +35,9 @@ import org.springframework.stereotype.Component;
 import java.util.HashMap;

 /**
- * {@link CommandHandlerProvider} provides {@link NewCommandSourceHandler}s for a given entity and action.<br/>
- * <br/>
+ * {@link CommandHandlerProvider} provides {@link NewCommandSourceHandler}s for a given entity and action.
+ * <br>
+ * <br>
 * A {@link NewCommandSourceHandler} can be registered and the annotation {@link CommandType} is used to determine
 * the entity and the action the handler is capable to process.
 *
@@ -60,8 +61,8 @@ public class CommandHandlerProvider implements ApplicationContextAware {
    }

    /**
-     * Returns a handler for the given entity and action.<br/>
-     * <br/>
+     * Returns a handler for the given entity and action.<br>
+     * <br>
     * Throws an {@link UnsupportedCommandException} if no handler
     * for the given entity, action combination can be found.
     * @param entity the entity to lookup the handler, must be given.
@@ -34,7 +34,7 @@ import org.springframework.stereotype.Component;
 * <li>Pretty printing through pretty=true, defaults to false</li>
 * <li>Partial response through fields=id, name etc, when empty, the full data
 * is returned by default.</li>
- * </ul
+ * </ul>
 */
@Component
 public class ApiRequestParameterHelper {
@@ -32,7 +32,7 @@ import org.springframework.context.annotation.PropertySource;
 * Base Spring Configuration with what's common to all Configuration subclasses.
 *
 * Notably the EnableAutoConfiguration excludes relevant for (and often adjusted
- * when upgrading versions of) Spring Boot, the "old" (pre. Spring Boot &
+ * when upgrading versions of) Spring Boot, the "old" (pre. Spring Boot &amp;
 * MariaDB4j) fineract appContext.xml which all configurations need, and the
 * web.xml successor WebXmlConfiguration.
 *
@@ -28,7 +28,7 @@ import org.springframework.context.annotation.ImportResource;
 * Configuration just adds the JNDI-based DataSource lookup to its
 * AbstractApplicationConfiguration.
 *
- * This (intentionally) only configures the original (pre-Spring Boot &
+ * This (intentionally) only configures the original (pre-Spring Boot &amp;
 * MariaDB4j) fineract Spring Beans, and does NOT include the embedded Tomcat
 * (incl. TomcatSSLConfiguration) nor the MariaDB4jSetupService or
 * MariaDB4jDataSourceConfiguration, and not even the DataSourceConfiguration
@@ -31,7 +31,7 @@ import com.google.gson.GsonBuilder;

 /**
 * <p>
- * A google gson implementation of {@link ExcludeNothingJsonSerializer}
+ * A google gson implementation of 
 * contract.
 * </p>
 * 
@@ -31,7 +31,7 @@ import com.google.gson.GsonBuilder;

 /**
 * <p>
- * A google gson implementation of {@link ExcludeNothingJsonSerializer}
+ * A google gson implementation of 
 * contract.
 * </p>
 * 
@@ -31,7 +31,7 @@ import com.google.gson.GsonBuilder;

 /**
 * <p>
- * A google gson implementation of {@link ExcludeNothingJsonSerializer}
+ * A google gson implementation of 
 * contract.
 * </p>
 * 
@@ -115,7 +115,7 @@ public class FromJsonHelper {
    /**
     * @param parentPropertyName
     *            The full json path to this property,the value is appended to
-     *            the parameter name while generating an error message <br/>
+     *            the parameter name while generating an error message <br>
     *            Ex: property "name" in Object "person" would be named as
     *            "person.name"
     * @param object
@@ -121,7 +121,7 @@ public class ContentRepositoryUtils {
    /**
     * Extracts Image from a Data URL
     * 
-     * @param mimeType
+     * @param dataURL mimeType
     */
    public static Base64EncodedImage extractImageFromDataURL(final String dataURL) {
        String fileExtension = "";
@@ -322,7 +322,7 @@ public class ReportMailingJob extends AbstractAuditableCustom<AppUser, Long> {
     * update the stretchy report entity associated with the credit check 
     * 
     * @param stretchyReport -- Report entity
-     * @return None
+     * 
     **/
    public void update(final Report stretchyReport) {
        if (stretchyReport != null) {
@@ -333,7 +333,7 @@ public class ReportMailingJob extends AbstractAuditableCustom<AppUser, Long> {
    /** 
     * delete the report mailing job, set the isDeleted property to 1 and alter the name 
     * 
-     * @return None
+     * 
     **/
    public void delete() {
        this.isDeleted = true;
@@ -491,7 +491,7 @@ public class ReportMailingJob extends AbstractAuditableCustom<AppUser, Long> {
    /** 
     * increase the numberOfRuns by 1 
     * 
-     * @return None
+     * 
     **/
    public void increaseNumberOfRunsByOne() {
        this.numberOfRuns++;
@@ -501,7 +501,7 @@ public class ReportMailingJob extends AbstractAuditableCustom<AppUser, Long> {
     * update the previousRunStatus 
     * 
     * @param previousRunStatus -- the status of the previous job execution
-     * @return None
+     * 
     **/
    public void updatePreviousRunStatus(final String previousRunStatus) {
        if (!StringUtils.isEmpty(previousRunStatus)) {
@@ -513,7 +513,7 @@ public class ReportMailingJob extends AbstractAuditableCustom<AppUser, Long> {
     * update the previousRunDateTime
     * 
     * @param previousRunDateTime -- previous run date
-     * @return None
+     * 
     **/
    public void updatePreviousRunDateTime(final DateTime previousRunDateTime) {
        if (previousRunDateTime != null) {
@@ -525,7 +525,7 @@ public class ReportMailingJob extends AbstractAuditableCustom<AppUser, Long> {
     * update the nextRunDateTime
     * 
     * @param nextRunDateTime -- the next run DateTime
-     * @return None
+     * 
     **/
    public void updateNextRunDateTime(final DateTime nextRunDateTime) {
        if (nextRunDateTime != null) {
@@ -540,7 +540,7 @@ public class ReportMailingJob extends AbstractAuditableCustom<AppUser, Long> {
    /** 
     * deactivate the report mailing job by setting the isActive property to 0 
     * 
-     * @return None
+     * 
     **/
    public void deactivate() {
        this.isActive = false;
@@ -550,7 +550,7 @@ public class ReportMailingJob extends AbstractAuditableCustom<AppUser, Long> {
     * update the previousRunErrorLog property
     * 
     * @param previousRunErrorLog -- the previous job run error log
-     * @return None
+     * 
     **/
    public void updatePreviousRunErrorLog(final String previousRunErrorLog) {
        this.previousRunErrorLog = previousRunErrorLog;
@@ -301,7 +301,7 @@ public class ReportMailingJobWritePlatformServiceImpl implements ReportMailingJo
     * @param reportMailingJob -- the report mailing job entity
     * @param errorLog -- StringBuilder object containing the error log if any
     * @param jobStartDateTime -- the start DateTime of the job
-     * @return None
+     * 
     **/
    private void updateReportMailingJobAfterJobExecution(final ReportMailingJob reportMailingJob, final StringBuilder errorLog, 
            final DateTime jobStartDateTime) {
@@ -374,7 +374,7 @@ public class ReportMailingJobWritePlatformServiceImpl implements ReportMailingJo
     * @param errorLog -- StringBuilder object containing the error log if any
     * @param jobStartDateTime -- the start DateTime of the job
     * @param jobRunStatus -- the status of the job (success/error)
-     * @return None
+     * 
     **/
    private void createReportMailingJobRunHistroryAfterJobExecution(final ReportMailingJob reportMailingJob, final StringBuilder errorLog, 
            final DateTime jobStartDateTime, final String jobRunStatus) {
@@ -391,7 +391,7 @@ public class ReportMailingJobWritePlatformServiceImpl implements ReportMailingJo
     *
     * @param jsonCommand -- JsonCommand object
     * @param dve -- data integrity exception object
-     * @return None
+     * 
     **/
    private void handleDataIntegrityIssues(final JsonCommand jsonCommand, final DataIntegrityViolationException dve) {
        final Throwable realCause = dve.getMostSpecificCause();
@@ -63,7 +63,7 @@ public class ReportMailingJobValidator {
     * validate the request to create a new report mailing job 
     * 
     * @param jsonCommand -- the JSON command object (instance of the JsonCommand class)
-     * @return None
+     * 
     **/
    public void validateCreateRequest(final JsonCommand jsonCommand) {
        final String jsonString = jsonCommand.json();
@@ -142,7 +142,7 @@ public class ReportMailingJobValidator {
     * validate the request to update a report mailing job 
     * 
     * @param jsonCommand -- the JSON command object (instance of the JsonCommand class)
-     * @return None
+     * 
     **/
    public void validateUpdateRequest(final JsonCommand jsonCommand) {
        final String jsonString = jsonCommand.json();
@@ -309,7 +309,7 @@ public class ReportMailingJobValidator {
     * throw a PlatformApiDataValidationException exception if there are validation errors
     * 
     * @param dataValidationErrors -- list of ApiParameterError objects
-     * @return None
+     * 
     **/
    private void throwExceptionIfValidationWarningsExist(final List<ApiParameterError> dataValidationErrors) {
        if (!dataValidationErrors.isEmpty()) { 
@@ -22,7 +22,7 @@ package org.apache.fineract.infrastructure.security.exception;
 * {@link RuntimeException} thrown when an invalid tenant identifier is used in
 * request to platform.
 * 
- * @see CustomRequestHeaderAuthenticationFilter
+ * 
 */
 public class InvalidTenantIdentiferException extends RuntimeException {

@@ -30,7 +30,7 @@ public class SmsMessageApiResponseData {
 	/** 
 	 * SmsMessageApiResponseData constructor
 	 * 
-	 * @return void 
+	 *  
 	 **/
 	private SmsMessageApiResponseData(Integer httpStatusCode, List<SmsMessageDeliveryReportData> data) {
 		this.httpStatusCode = httpStatusCode;
@@ -40,7 +40,7 @@ public class SmsMessageApiResponseData {
 	/** 
 	 * Default SmsMessageApiResponseData constructor 
 	 * 
-	 * @return void
+	 * 
 	 **/
 	protected SmsMessageApiResponseData() {}
 	
@@ -33,7 +33,7 @@ public class SmsMessageDeliveryReportData {
 	/** 
 	 * SmsMessageDeliveryReportData constructor
 	 * 
-	 * @return void 
+	 *  
 	 **/
 	private SmsMessageDeliveryReportData(Long id, String externalId, String addedOnDate, String deliveredOnDate, 
 			Integer deliveryStatus, Boolean hasError, String errorMessage) {
@@ -49,7 +49,7 @@ public class SmsMessageDeliveryReportData {
 	/** 
 	 * Default SmsMessageDeliveryReportData constructor 
 	 * 
-	 * @return void
+	 * 
 	 **/
 	protected SmsMessageDeliveryReportData() {}
 	
@@ -34,7 +34,7 @@ import org.joda.time.LocalDate;
 * information, teller, and more.
 *
 * @author Markus Geiss
-<<<<<<< HEAD
+
 * @since 2.0.0
 * @see org.apache.fineract.organisation.teller.domain.Cashier
 * @since 2.0.0
@@ -86,24 +86,27 @@ public final class CashierData implements Serializable {

    /**
     * Creates a new cashier.
-     * <p/>
+     * 
     * <p>The valid from/to dates may be used to define a time period in which
     * the cashier is assignable to a teller.</p>
-     * <p/>
+     * 
     * <p>The start/end times may be used to define a time period in which
     * the cashier works part time.</p>
     *
-     * @param id          the primary key of this cashier
-     * @param officeId    the primary key of the related office
-     * @param staffId     the primary key of the related staff
-     * @param tellerId    the primary key of the related teller
+     * @param id the primary key of this cashier
+     * @param officeId the primary key of the related office
+     * @param officeName the primary key of the related staff
+     * @param staffId the primary key of the related teller
+     * @param staffName
+     * @param tellerId the primary key of the related teller
+     * @param tellerName
     * @param description the description of this cashier
-     * @param validFrom   the valid from date of this cashier
-     * @param validTo     the valid to date of this cashier
-     * @param partTime    the part time flag of this cashier
-     * @param startTime   the start time of this cashier
-     * @param endTime     the end time of this cashier
-     * @return the cashier
+     * @param startDate the valid from date of this cashier
+     * @param endDate  the valid to date of this cashier
+     * @param isFullDay the part time flag of this cashier
+     * @param startTime the start time of this cashier
+     * @param endTime  the end time of this cashier
+     * @return
     */
    public static CashierData instance(final Long id, final Long officeId, String officeName, 
    		final Long staffId, final String staffName, final Long tellerId, final String tellerName,
@@ -169,7 +172,7 @@ public final class CashierData implements Serializable {

    /**
     * Returns the valid from date of this cashier.
-     * <p/>
+     * 
     * <p>The valid from/to dates may be used to define a time period in which
     * the cashier is assignable to a teller.</p>
     *
@@ -181,7 +184,7 @@ public final class CashierData implements Serializable {

    /**
     * Returns the valid to date of this cashier.
-     * <p/>
+     * 
     * <p>The valid from/to dates may be used to define a time period in which
     * the cashier is assignable to a teller.</p>
     *
@@ -202,7 +205,7 @@ public final class CashierData implements Serializable {

    /**
     * Returns the start time of this cashier.
-     * <p/>
+     * 
     * <p>The start/end times may be used to define a time period in which
     * the cashier works part time.</p>
     *
@@ -214,7 +217,7 @@ public final class CashierData implements Serializable {

    /**
     * Returns the end time of this cashier.
-     * <p/>
+     * 
     * <p>The start/end times may be used to define a time period in which
     * the cashier works part time.</p>
     *
@@ -32,7 +32,7 @@ import java.util.Date;
 * {@code TellerData} represents an immutable data object for teller data.
 *
 * @version 1.0
-<<<<<<< HEAD
+
 * @since 2.0.0
 * @see java.io.Serializable
 * @since 2.0.0
@@ -25,7 +25,7 @@ import java.util.Date;
 * {@code TellerJournalData} represents an immutable journal data object.
 *
 * @version 1.0.0
-<<<<<<< HEAD
+
 * @since 2.0.0
 * @see java.io.Serializable
 * @since 2.0.0
@@ -27,7 +27,7 @@ import java.util.Date;
 * {@code TellerTransactionData} represents an immutable data object for a transction.
 *
 * @version 1.0.0
-<<<<<<< HEAD
+
 * @since 2.0.0
 * @see java.io.Serializable
 * @since 2.0.0
@@ -324,7 +324,7 @@ public class Cashier extends AbstractPersistableCustom<Long> {

    /**
     * Returns the valid from date of this cashier.
-     * <p/>
+     * 
     * <p>
     * The valid from/to dates may be used to define a time period in which the
     * cashier is assignable to a teller.
@@ -346,13 +346,13 @@ public class Cashier extends AbstractPersistableCustom<Long> {

    /**
     * Sets the valid from date of this cashier.
-     * <p/>
+     * 
     * <p>
     * The valid from/to dates may be used to define a time period in which the
     * cashier is assignable to a teller.
     * </p>
     * 
-     * @param validFrom
+     * @param  startDate validFrom
     *            the valid from date of this cashier
     */
    public void setStartDate(Date startDate) {
@@ -361,7 +361,7 @@ public class Cashier extends AbstractPersistableCustom<Long> {

    /**
     * Returns the valid to date of this cashier.
-     * <p/>
+     * 
     * <p>
     * The valid from/to dates may be used to define a time period in which the
     * cashier is assignable to a teller.
@@ -383,13 +383,13 @@ public class Cashier extends AbstractPersistableCustom<Long> {

    /**
     * Sets the valid to date of this cashier.
-     * <p/>
+     * 
     * <p>
     * The valid from/to dates may be used to define a time period in which the
     * cashier is assignable to a teller.
     * </p>
     * 
-     * @param validTo
+     * @param endDate validTo
     *            the valid to date of this cashier
     */
    public void setEndDate(Date endDate) {
@@ -409,7 +409,7 @@ public class Cashier extends AbstractPersistableCustom<Long> {
    /**
     * Sets the part time flag of this cashier.
     * 
-     * @param partTime
+     * @param isFullDay partTime
     *            the part time flag of this cashier
     */
    public void setFullDay(Boolean isFullDay) {
@@ -418,7 +418,7 @@ public class Cashier extends AbstractPersistableCustom<Long> {

    /**
     * Returns the start time of this cashier.
-     * <p/>
+     * 
     * <p>
     * The start/end times may be used to define a time period in which the
     * cashier works part time.
@@ -432,7 +432,7 @@ public class Cashier extends AbstractPersistableCustom<Long> {

    /**
     * Set the start time of this cashier.
-     * <p/>
+     * 
     * <p>
     * The start/end times may be used to define a time period in which the
     * cashier works part time.
@@ -447,7 +447,7 @@ public class Cashier extends AbstractPersistableCustom<Long> {

    /**
     * Returns the end time of this cashier.
-     * <p/>
+     * 
     * <p>
     * The start/end times may be used to define a time period in which the
     * cashier works part time.
@@ -461,7 +461,7 @@ public class Cashier extends AbstractPersistableCustom<Long> {

    /**
     * Sets the end time of this cashier.
-     * <p/>
+     * 
     * <p>
     * The start/end times may be used to define a time period in which the
     * cashier works part time.
@@ -213,7 +213,7 @@ public class CashierTransaction extends AbstractPersistableCustom<Long> {
    /**
     * Sets the transaction type of this cashier transaction.
     *
-     * @param description the transaction type of this cashier transaction
+     * @param txnType description the transaction type of this cashier transaction
     */
    public void setTxnType(Integer txnType) {
        this.txnType = txnType;
@@ -239,7 +239,7 @@ public class CashierTransaction extends AbstractPersistableCustom<Long> {
    /**
     * Sets the transaction date of this cashier transaction.
     *
-     * @param transaction date of this cashier transaction
+     * @param txnDate transaction date of this cashier transaction
     */
    public void setTxnDate(Date txnDate) {
        this.txnDate = txnDate;
@@ -107,8 +107,8 @@ public enum CalendarFrequencyType {
     * To convert from period frequency type tp calendar frequency type. This
     * method requires code refactoring.
     * 
-     * @param periodFrequencyType
-     * @return
+     * @param periodFrequencyType periodFrequencyType
+     * @return CalendarFrequencyType
     */
    public static CalendarFrequencyType from(final PeriodFrequencyType periodFrequencyType) {
        switch (periodFrequencyType) {
@@ -144,8 +144,8 @@ public class ClientTransaction extends AbstractPersistableCustom<Long> {
     * Converts the content of this Client Transaction to a map which can be
     * passed to the accounting module
     * 
-     * @param currencyData
-     * @return
+     * 
+     * 
     */
    public Map<String, Object> toMapData() {
        final Map<String, Object> thisTransactionData = new LinkedHashMap<>();
@@ -21,9 +21,10 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- * <ul>
+ * 
 * People typically use either of the following settings when calculating there
 * interest using the daily method:
+ * <ul>
 * <li>Actual or</li>
 * <li>30</li>
 * </ul>
@@ -22,9 +22,10 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- * <ul>
+ * 
 * People typically use either of the following settings when calculating there
 * interest using the daily method:
+ * <ul>
 * <li>Actual or</li>
 * <li>360 or</li>
 * <li>364 or</li>
@@ -5582,14 +5582,17 @@ public class Loan extends AbstractPersistableCustom<Long> {
    }

    /**
+     * @param applicationCurrency
     * @param restCalendarInstance
     *            TODO
     * @param compoundingCalendarInstance
     *            TODO
+     * @param loanCalendar
     * @param floatingRateDTO
     *            TODO
-     * @param isChangeEmiIfRepaymentDateSameAsDisbursementDateEnabled 
-     * @param loanCalendarInstance
+     * @param isSkipRepaymentonmonthFirst
+     * @param numberofdays
+     * @param holidayDetailDTO
     *            Used for accessing the loan's calendar object
     * @return application terms of the Loan object
     **/
@@ -741,10 +741,14 @@ public class LoanCharge extends AbstractPersistableCustom<Long> {
    }

    /**
+     * @param incrementBy
+     * 
+     * @param installmentNumber
+     * 
     * @param feeAmount
     *            TODO
-     * @param processAmount
-     *            Amount used to pay off this charge
+     * 
+     * 
     * @return Actual amount paid on this charge
     */
    public Money updatePaidAmountBy(final Money incrementBy, final Integer installmentNumber, final Money feeAmount) {
@@ -32,7 +32,7 @@ import org.apache.fineract.organisation.monetary.domain.Money;
 * Encapsulates all the summary details of a {@link Loan}.
 * 
 * {@link LoanSummary} fields are updated through a scheduled job. see -
- * {@link UpdateLoanSummariesScheduledJob}.
+ * 
 */
@Embeddable
 public final class LoanSummary {
@@ -386,6 +386,11 @@ public class LoanTransaction extends AbstractPersistableCustom<Long> {
     * 
     * This accumulates the values passed to the already existent values for
     * each of the portions.
+     * 
+     * @param principal principal
+     * @param interest interest
+     * @param feeCharges feeCharges
+     * @param penaltyCharges penaltyCharges
     */
    public void updateComponents(final Money principal, final Money interest, final Money feeCharges, final Money penaltyCharges) {
        final MonetaryCurrency currency = principal.getCurrency();
@@ -39,7 +39,7 @@ import org.joda.time.LocalDate;
 * <li>Equal principal payments</li>
 * <li>Equal installment payments</li>
 * </ol>
- * </p>
+ * <p></p>
 * 
 * <p>
 * When amortized using <i>equal principal payments</i>, the <b>principal
@@ -58,7 +58,7 @@ public class LoanRescheduleRequestDataValidator {
     * 
     * @param jsonCommand
     *            the JSON command object (instance of the JsonCommand class)
-     * @return void
+     * 
     **/
    public void validateForCreateAction(final JsonCommand jsonCommand, final Loan loan) {

@@ -191,7 +191,7 @@ public class LoanRescheduleRequestDataValidator {
     * 
     * @param jsonCommand
     *            the JSON command object (instance of the JsonCommand class)
-     * @return void
+     * 
     **/
    public void validateForApproveAction(final JsonCommand jsonCommand, LoanRescheduleRequest loanRescheduleRequest) {
        final String jsonString = jsonCommand.json();
@@ -261,7 +261,7 @@ public class LoanRescheduleRequestDataValidator {
     * 
     * @param jsonCommand
     *            the JSON command object (instance of the JsonCommand class)
-     * @return void
+     * 
     **/
    public void validateForRejectAction(final JsonCommand jsonCommand, LoanRescheduleRequest loanRescheduleRequest) {
        final String jsonString = jsonCommand.json();
@@ -267,7 +267,7 @@ public class LoanRescheduleRequest extends AbstractPersistableCustom<Long> {
 	 * 
 	 * @param approvedByUser the user who approved the request
 	 * @param approvedOnDate the date of the approval
-	 * @return void
+	 * 
 	 **/
 	public void approve(final AppUser approvedByUser, final LocalDate approvedOnDate) {
 		
@@ -284,7 +284,7 @@ public class LoanRescheduleRequest extends AbstractPersistableCustom<Long> {
 	 * 
 	 * @param approvedByUser the user who approved the request
 	 * @param approvedOnDate the date of the approval
-	 * @return void
+	 * 
 	 **/
 	public void reject(final AppUser approvedByUser, final LocalDate approvedOnDate) {
 		
@@ -29,7 +29,7 @@ public class LoanRescheduleRequestNotFoundException extends AbstractPlatformReso
 	 * LoanRescheduleRequestNotFoundException constructor 
 	 * 
 	 * @param requestId the loan reschedule request identifier
-	 * @return void
+	 * 
 	 **/
 	public LoanRescheduleRequestNotFoundException(final Long requestId) {
 		super("error.msg.loan.reschedule.request.id.invalid", 
@@ -118,7 +118,7 @@ public class LoanRescheduleRequestWritePlatformServiceImpl implements LoanResche
    /**
     * LoanRescheduleRequestWritePlatformServiceImpl constructor
     * 
-     * @return void
+     * 
     **/
    @Autowired
    public LoanRescheduleRequestWritePlatformServiceImpl(final CodeValueRepositoryWrapper codeValueRepositoryWrapper,
@@ -585,7 +585,7 @@ public class LoanRescheduleRequestWritePlatformServiceImpl implements LoanResche
     *
     * @param dve
     *            data integrity violation exception
-     * @return void
+     * 
     **/
    private void handleDataIntegrityViolation(final DataIntegrityViolationException dve) {

@@ -447,7 +447,7 @@ public class LoanWritePlatformServiceJpaRepositoryImpl implements LoanWritePlatf
     * 
     * @param loan
     *            the disbursed loan
-     * @return void
+     * 
     **/
    private void createStandingInstruction(Loan loan) {

@@ -22,9 +22,10 @@ import java.util.HashMap;
 import java.util.Map;

 /***
- * <ul>
+ * 
 * People typically use either of the following settings when defining interest
 * recalculation method:
+ * <ul>
 * <li>NONE</li>
 * <li>INTEREST</li>
 * <li>FEE</li>
@@ -22,9 +22,10 @@ import java.util.HashMap;
 import java.util.Map;

 /***
- * <ul>
+ * 
 * People typically use either of the following settings when defining interest
 * recalculation method:
+ * <ul>
 * <li>SAME_AS_REPAYMENT_PERIOD</li>
 * <li>DAILY</li>
 * <li>WEEKLY</li>
@@ -22,9 +22,9 @@ import java.util.HashMap;
 import java.util.Map;

 /***
- * <ul>
- * People typically use either of the following settings when defining interest
+ * * People typically use either of the following settings when defining interest
 * recalculation method:
+ * <ul>
 * <li>RESCHEDULE_NEXT_REPAYMENTS</li>
 * <li>REDUCE_NUMBER_OF_INSTALLMENTS</li>
 * <li>REDUCE_EMI_AMOUNT</li>
@@ -26,7 +26,7 @@ import org.apache.fineract.portfolio.savings.domain.RecurringDepositAccount;

 /**
 * An enumeration of different options available on account closure
- * {@link FixedDepositAccount} & {@link RecurringDepositAccount}.
+ * {@link FixedDepositAccount} &amp; {@link RecurringDepositAccount}.
 */
 public enum DepositAccountOnClosureType {

@@ -22,9 +22,10 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- * <ul>
+ * 
 * People typically use either of the following settings when calculating there
 * interest using the daily method:
+ * <ul>
 * <li>360 and</li>
 * <li>365</li>
 * </ul>
@@ -22,8 +22,9 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- * <ul>
+ * 
 * There are two methods to calculate the interest on a savings account:
+ * <ul>
 * <li>The daily balance method; and</li>
 * <li>The average daily balance method.</li>
 * </ul>
@@ -191,7 +191,7 @@ public class DepositAccountDomainServiceJpa implements DepositAccountDomainServi
         */
        updateExistingTransactionsDetails(account, existingTransactionIds, existingReversedTransactionIds);
        /*
-         * <<<<<<< HEAD final SavingsAccountTransactionDTO transactionDTO = new
+         *  final SavingsAccountTransactionDTO transactionDTO = new
         * SavingsAccountTransactionDTO(fmt, transactionDate, transactionAmount,
         * paymentDetail, new Date()); final SavingsAccountTransaction deposit =
         * account.deposit(transactionDTO); boolean isInterestTransfer = false;
@@ -1315,7 +1315,7 @@ public class SavingsAccountWritePlatformServiceJpaRepositoryImpl implements Savi
     * Disable all standing instructions linked to the savings account if the status is "closed" 
     * 
     * @param savingsAccount -- the savings account object
-     * @return None
+     * 
     **/
    @Transactional
    private void disableStandingInstructionsLinkedToClosedSavings(final SavingsAccount savingsAccount) {
@@ -140,11 +140,12 @@ public class TransferWritePlatformServiceJpaRepositoryImpl implements TransferWr
    }

    /****
-     * Variables that would make sense <br/>
+     * Variables that would make sense <br>
     * <ul>
     * <li>inheritDestinationGroupLoanOfficer: Default true</li>
     * <li>newStaffId: Optional field with Id of new Loan Officer to be linked
     * to this client and all his JLG loans for this group</li>
+     * </ul>
     * ***/
    @Transactional
    public void transferClientBetweenGroups(final Group sourceGroup, final Client client, final Group destinationGroup,
@@ -248,10 +249,9 @@ public class TransferWritePlatformServiceJpaRepositoryImpl implements TransferWr

    /**
     * This API is meant for transferring clients between branches mainly by
-     * Organizations following an Individual lending Model <br/>
+     * Organizations following an Individual lending Model <br>
     * 
     * @param clientId
-     * @param destinationOfficeId
     * @param jsonCommand
     * @return
     **/
@@ -277,13 +277,12 @@ public class TransferWritePlatformServiceJpaRepositoryImpl implements TransferWr

    /**
     * This API is meant for transferring clients between branches mainly by
-     * Organizations following an Individual lending Model <br/>
+     * Organizations following an Individual lending Model <br>
     * If the Client is linked to any Groups, we can optionally choose to have
     * all the linkages broken and all JLG Loans are converted into Individual
     * Loans
     * 
     * @param clientId
-     * @param destinationOfficeId
     * @param jsonCommand
     * @return
     **/
@@ -306,13 +305,12 @@ public class TransferWritePlatformServiceJpaRepositoryImpl implements TransferWr

    /**
     * This API is meant for transferring clients between branches mainly by
-     * Organizations following an Individual lending Model <br/>
+     * Organizations following an Individual lending Model <br>
     * If the Client is linked to any Groups, we can optionally choose to have
     * all the linkages broken and all JLG Loans are converted into Individual
     * Loans
     * 
     * @param clientId
-     * @param destinationOfficeId
     * @param jsonCommand
     * @return
     **/