IDEMPIERE-5838 Base: Improve readability of code (#2179)

* IDEMPIERE-5838 Base: Improve readability of code

* IDEMPIERE-5838 Base: Improve readability of code

org.adempiere.base/src/com/akunagroup/uk/postcode/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Deprecated
+ */
+package com.akunagroup.uk.postcode;

org.adempiere.base/src/org/adempiere/base/AbstractProductPricing.java

@@ -27,6 +27,9 @@ import org.compiere.model.I_M_RMALine;
 import org.compiere.model.I_M_RequisitionLine;
 import org.compiere.util.Env;
 
+/**
+ * Abstract base class for {@link IProductPricing} implementation
+ */
 public abstract class AbstractProductPricing implements IProductPricing {
 	
 	protected int 		  m_M_Product_ID;

org.adempiere.base/src/org/adempiere/base/AnnotationBasedColumnCalloutFactory.java

@@ -47,9 +47,9 @@ import io.github.classgraph.ClassGraph.ScanResultProcessor;
 import io.github.classgraph.ClassInfo;
 
 /**
- * 
+ * Abstract base class for annotation driven implementation of {@link IColumnCalloutFactory}.<br/>
+ * Subclass would override the {@link #getPackages()} method to provide the packages for {@link Callout} annotation scanning and discovery.
  * @author hengsin
- *
  */
 public abstract class AnnotationBasedColumnCalloutFactory extends AnnotationBasedFactory implements IColumnCalloutFactory {
 

org.adempiere.base/src/org/adempiere/base/BaseActivator.java

@@ -36,8 +36,8 @@ import org.osgi.framework.Filter;
 import org.osgi.util.tracker.ServiceTracker;
 
 /**
+ * Activator for org.adempiere.base bundle.
  * @author hengsin
- *
  */
 public class BaseActivator implements BundleActivator {
 

org.adempiere.base/src/org/adempiere/base/DefaultAnnotationBasedColumnCalloutFactory.java

@@ -27,9 +27,8 @@ package org.adempiere.base;
 import org.osgi.service.component.annotations.Component;
 
 /**
- * 
+ * Default implementation of {@link AnnotationBasedColumnCalloutFactory} that would scan the org.adempiere.model package 
  * @author hengsin
- *
  */
 @Component(immediate = true, service = IColumnCalloutFactory.class)
 public class DefaultAnnotationBasedColumnCalloutFactory extends AnnotationBasedColumnCalloutFactory {

org.adempiere.base/src/org/adempiere/base/DefaultAnnotationBasedEventManager.java

@@ -26,6 +26,9 @@ package org.adempiere.base;
 
 import org.osgi.service.component.annotations.Component;
 
+/**
+ * Default implementation of {@link AnnotationBasedEventManager} that would scan the org.adempiere.base.event.delegate package.
+ */
 @Component(immediate = true, service = {DefaultAnnotationBasedEventManager.class})
 public class DefaultAnnotationBasedEventManager extends AnnotationBasedEventManager {
 

org.adempiere.base/src/org/adempiere/base/DefaultAnnotationBasedProcessFactory.java

@@ -27,9 +27,11 @@ package org.adempiere.base;
 import org.osgi.service.component.annotations.Component;
 
 /**
- * 
+ * Default implementation of {@link AnnotationBasedProcessFactory} that would scan the following packages:<br/>
+ * "org.adempiere.process","org.compiere.impexp","org.compiere.print","org.compiere.process",
+ * "org.compiere.report","org.compiere.sla","org.compiere.wf","org.eevolution.process",
+ * "org.globalqss.process","org.idempiere.broadcast.process","org.idempiere.fa.process" and "org.idempiere.process" 
  * @author hengsin
- *
  */
 @Component(immediate = true, service = IProcessFactory.class, property = {"service.ranking:Integer=-1"})
 public final class DefaultAnnotationBasedProcessFactory extends AnnotationBasedProcessFactory {

org.adempiere.base/src/org/adempiere/base/IMappedDocumentFactory.java

@@ -53,9 +53,7 @@ public interface IMappedDocumentFactory {
 	public void removeMapping(String gaap, String tableName);
 
 	/**
-	 * 
+	 * Parameter class for doc supplier
-	 * parameter class for doc supplier
-	 *
 	 */
 	public final static class Parameter {
 		public MAcctSchema as;

org.adempiere.base/src/org/adempiere/base/ModelGeneratorApplication.java

@@ -29,6 +29,7 @@ import org.osgi.framework.BundleException;
 import org.osgi.framework.FrameworkUtil;
 
 /**
+ * Eclipse application to launch the swing based model generation dialog.
  * @author hengsin
  * @author tbayen - command line start
  *

org.adempiere.base/src/org/adempiere/base/PackInFolderApplication.java

@@ -41,8 +41,8 @@ import org.eclipse.equinox.app.IApplication;
 import org.eclipse.equinox.app.IApplicationContext;
 
 /**
+ * Eclipse application that would launch the org.adempiere.pipo2.PackInFolder process to import 2pack archives inside a predefine folder. 
  * @author Carlos Ruiz (globalqss)
- *
  */
 public class PackInFolderApplication implements IApplication {
 

org.adempiere.base/src/org/adempiere/base/PostMigrationApplication.java

@@ -25,8 +25,9 @@ import org.eclipse.equinox.app.IApplication;
 import org.eclipse.equinox.app.IApplicationContext;
 
 /**
+ * Eclipse application to run processes that must be executed (sequence check, role access update and synchronize terminology)  
+ * after the execution of migration scripts 
  * @author hengsin
- *
  */
 public class PostMigrationApplication implements IApplication {
 

org.adempiere.base/src/org/adempiere/base/annotation/Callouts.java

@@ -31,9 +31,8 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
 /**
- * 
+ * To support the use of multiple {@link Callout} annotation 
  * @author hengsin
- *
  */
 @Retention(RUNTIME)
 @Target(ElementType.TYPE)

org.adempiere.base/src/org/adempiere/base/annotation/Process.java

@@ -18,6 +18,9 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Annotation for iDempiere process
+ */
 @Retention(RUNTIME)
 @Target(TYPE)
 public @interface Process {

org.adempiere.base/src/org/adempiere/base/annotation/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide annotations for callout, model event, import event and process
+ */
+package org.adempiere.base.annotation;

org.adempiere.base/src/org/adempiere/base/ds/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide service discovery implementation for OSGi declarative service.
+ */
+package org.adempiere.base.ds;

org.adempiere.base/src/org/adempiere/base/equinox/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide service discovery implementation for Equinox extension
+ */
+package org.adempiere.base.equinox;

org.adempiere.base/src/org/adempiere/base/event/EventProperty.java

@@ -14,9 +14,8 @@
 package org.adempiere.base.event;
 
 /**
- *
+ * Value object for name based event property 
  * @author hengsin
- *
  */
 public class EventProperty {
 	public String name;

org.adempiere.base/src/org/adempiere/base/event/annotations/AfterLoadPref.java

@@ -32,14 +32,13 @@ import java.lang.annotation.Target;
 
 import org.adempiere.base.event.IEventTopics;
 
+/**
+ * Method annotation for handling of after load preference event  
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.PREF_AFTER_LOAD)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterLoadPref {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/AfterLogin.java

@@ -32,14 +32,13 @@ import java.lang.annotation.Target;
 
 import org.adempiere.base.event.IEventTopics;
 
+/**
+ * Method annotation for handling of after login event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.AFTER_LOGIN)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterLogin {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/AfterLoginEventDelegate.java

@@ -30,8 +30,7 @@ import org.osgi.service.event.Event;
 
 /**
  * Event delegate for login event.<br/>
- * To handle login event, create a subclass of this and uses the {@link AfterLogin} annotation to
+ * To handle login event, create a subclass of this and implement the {@link #onAfterLogin(LoginEventData)} method.
- * annotate the method for the login event topic.
  * @author hengsin
  */
 public abstract class AfterLoginEventDelegate extends EventDelegate {
@@ -44,7 +43,7 @@ public abstract class AfterLoginEventDelegate extends EventDelegate {
 	}
 
 	/**
-	 * 
+	 * Get data object for login event
 	 * @return {@link LoginEventData}
 	 */
 	protected LoginEventData getLoginEventData() {

org.adempiere.base/src/org/adempiere/base/event/annotations/BroadcastMsg.java

@@ -32,14 +32,13 @@ import java.lang.annotation.Target;
 
 import org.adempiere.base.event.IEventTopics;
 
+/**
+ * Method annotation for handling of broadcast message event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.BROADCAST_MESSAGE)
-/**
- * 
- * @author hengsin
- *
- */
 public @interface BroadcastMsg {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/EventDelegate.java

@@ -27,12 +27,10 @@ package org.adempiere.base.event.annotations;
 import org.osgi.service.event.Event;
 
 /**
- * 
  * Annotation driven event delegate base class that works together with {@link BaseEventHandler}.<br/>
  * Subclass implementation doesn't have to be thread safe as event delegate is create and throw away for each event call.<br/>
- * Subclass should use {@link EventTopic} or one of its derived annotation to define the event topic to handle
+ * Subclass should use {@link EventTopic} or one of its derived annotation to define the event topic to handle.
  * @author hengsin
- *
  */
 public class EventDelegate {
 

org.adempiere.base/src/org/adempiere/base/event/annotations/EventTopic.java

@@ -31,13 +31,17 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Method annotation for OSGi event topic. <br/>
+ * Developer usually use one of the predefined event topic annotation (for e.g {@link AfterLogin}) instead of using this annotation directly. 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target({ METHOD, ANNOTATION_TYPE })
-/**
- * 
- * @author hengsin
- *
- */
 public @interface EventTopic {
+	/**
+	 * Get OSGi event topic name
+	 * @return event topic name
+	 */
 	String topic();
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/ModelEventDelegate.java

@@ -30,7 +30,7 @@ import org.osgi.service.event.Event;
 /**
  * Event delegate for PO related event.<br/>
  * To handle a model event, create a subclass of this and uses the model event annotation (BeforeChange, BeforeComplete, etc)
- * to annotate the method for a specific model event topic.
+ * to annotate the event handling method.
  * @author hengsin
  *
  * @param <T>
@@ -49,6 +49,7 @@ public class ModelEventDelegate<T extends PO> extends EventDelegate {
 	}
 
 	/**
+	 * Get PO model for event
 	 * @return PO model (MBPartner, MOrder, etc)
 	 */
 	protected T getModel() {

org.adempiere.base/src/org/adempiere/base/event/annotations/RequestSendEMail.java

@@ -32,14 +32,13 @@ import java.lang.annotation.Target;
 
 import org.adempiere.base.event.IEventTopics;
 
+/**
+ * Method annotation for handling of send request email event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.REQUEST_SEND_EMAIL)
-/**
- * 
- * @author hengsin
- *
- */
 public @interface RequestSendEMail {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/RequestSendEmailEventDelegate.java

@@ -58,7 +58,7 @@ public abstract class RequestSendEmailEventDelegate extends EventDelegate {
 	}
 
 	/**
-	 * Override this to handle event
+	 * Override this to handle RequestSendEMail event
 	 * @param requestSendEMailEventData 
 	 */
 	protected abstract void onRequestSendEmail(RequestSendEMailEventData requestSendEMailEventData);

org.adempiere.base/src/org/adempiere/base/event/annotations/SimpleEventHandler.java

@@ -26,10 +26,12 @@ package org.adempiere.base.event.annotations;
 
 import java.util.function.Function;
 
+import org.adempiere.base.AnnotationBasedEventManager;
 import org.osgi.service.event.Event;
 
 /**
- * Event handler that delegate to {@link EventDelegate} instance (create for each event call).
+ * Event handler that delegate to {@link EventDelegate} instance (create for each event call).<br/>
+ * This is use by {@link AnnotationBasedEventManager} and usually developer doesn't have to use this class directly.
  * @author hengsin
  *
  */

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/AfterClose.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after close document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_AFTER_CLOSE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterClose {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/AfterComplete.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after complete document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_AFTER_COMPLETE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterComplete {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/AfterPost.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after post document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_AFTER_POST)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterPost {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/AfterPrepare.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after prepare document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_AFTER_PREPARE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterPrepare {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/AfterReactivate.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after re-activate document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_AFTER_REACTIVATE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterReactivate {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/AfterReverseAccrual.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after reverse accrual document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_AFTER_REVERSEACCRUAL)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterReverseAccrual {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/AfterReverseCorrect.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after reverse correct document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_AFTER_REVERSECORRECT)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterReverseCorrect {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/AfterVoid.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after void document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_AFTER_VOID)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterVoid {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/BeforeClose.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before close document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_BEFORE_CLOSE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeClose {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/BeforeComplete.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before complete document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_BEFORE_COMPLETE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeComplete {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/BeforePost.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before post document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_BEFORE_POST)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforePost {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/BeforePrepare.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before prepare document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_BEFORE_PREPARE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforePrepare {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/BeforeReactivate.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before re-activate document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_BEFORE_REACTIVATE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeReactivate {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/BeforeReverseAccrual.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before reverse accrual document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_BEFORE_REVERSEACCRUAL)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeReverseAccrual {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/BeforeReverseCorrect.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before reverse correct document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_BEFORE_REVERSECORRECT)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeReverseCorrect {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/BeforeVoid.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before void document action event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOC_BEFORE_VOID)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeVoid {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/DocAction.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for get available document actions event 
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.DOCACTION)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface DocAction {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/FactsValidate.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for accounting facts validation event  
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.ACCT_FACTS_VALIDATE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface FactsValidate {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/FactsValidateDelegate.java

@@ -31,9 +31,9 @@ import org.compiere.model.PO;
 import org.osgi.service.event.Event;
 
 /**
- * Event delegate for facts validate event.<br/>
+ * Event delegate for accounting facts validation event.<br/>
  * To handle facts validate event, create a subclass of this and uses the {@link FactsValidate} annotation
- * to annotate the method for the FactsValidate event topic. 
+ * to annotate the event handling method. 
  * @author hengsin
  */
 public abstract class FactsValidateDelegate<T extends PO> extends ModelEventDelegate<T> {

org.adempiere.base/src/org/adempiere/base/event/annotations/doc/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide method annotations for handling of document action and posting events 
+ */
+package org.adempiere.base.event.annotations.doc;

org.adempiere.base/src/org/adempiere/base/event/annotations/imp/AfterImport.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after import event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.IMPORT_AFTER_IMPORT)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterImport {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/imp/AfterValidate.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after validate event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.IMPORT_AFTER_VALIDATE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterValidate {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/imp/BeforeImport.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before import event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.IMPORT_BEFORE_IMPORT)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeImport {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/imp/BeforeValidate.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before validate event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.IMPORT_BEFORE_VALIDATE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeValidate {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/imp/ImportEventDelegate.java

@@ -32,7 +32,7 @@ import org.osgi.service.event.Event;
 /**
  * Event delegate for import event.<br/>
  * To handle an import event, create a sub class of this and uses the import event annotation (AfterImport, BeforeImport, etc)
- * to annotate method for a specific import event topic. 
+ * to annotate the event handling method. 
  * @author hengsin
  */
 public class ImportEventDelegate extends EventDelegate {
@@ -45,7 +45,7 @@ public class ImportEventDelegate extends EventDelegate {
 	}
 
 	/**
-	 * 
+	 * Get data object for import event
 	 * @return {@link ImportEventData}
 	 */
 	protected ImportEventData getImportEventData() {

org.adempiere.base/src/org/adempiere/base/event/annotations/imp/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide annotation for the handling of import event
+ */
+package org.adempiere.base.event.annotations.imp;

org.adempiere.base/src/org/adempiere/base/event/annotations/package-info.java

@@ -0,0 +1,28 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide classes and annotation for OSGi event handling. <br/>
+ * Developer create subclass of event delegate (or one of its more specialized subclass like model event delegate) and
+ * uses method annotation to handle OSGi event. 
+ */
+package org.adempiere.base.event.annotations;

org.adempiere.base/src/org/adempiere/base/event/annotations/po/AfterChange.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after change event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic =  IEventTopics.PO_AFTER_CHANGE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterChange {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/AfterChangeReplication.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for replication after change event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.PO_AFTER_CHANGE_REPLICATION)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterChangeReplication {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/AfterDelete.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after delete event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.PO_AFTER_DELETE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterDelete {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/AfterNew.java

@@ -33,13 +33,12 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after new event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.PO_AFTER_NEW)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterNew {
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/AfterNewReplication.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for replication after new event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.PO_AFTER_NEW_REPLICATION)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterNewReplication {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/BeforeChange.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before change event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic =  IEventTopics.PO_BEFORE_CHANGE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeChange {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/BeforeDelete.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before delete event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.PO_BEFORE_DELETE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeDelete {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/BeforeDeleteReplication.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for replication before delete event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.PO_BEFORE_DELETE_REPLICATION)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeDeleteReplication {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/BeforeNew.java

@@ -33,13 +33,12 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before new event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
-/**
- * 
- * @author hengsin
- * 
- */
 @EventTopic(topic = IEventTopics.PO_BEFORE_NEW)
 public @interface BeforeNew {
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/PostCreate.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for post create event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.PO_POST_CREATE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface PostCreate {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/PostDelete.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for post delete event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.PO_POST_DELETE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface PostDelete {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/PostUpdate.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for post update event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.PO_POST_UPADTE)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface PostUpdate {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/po/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide annotation for model (PO) event.
+ */
+package org.adempiere.base.event.annotations.po;

org.adempiere.base/src/org/adempiere/base/event/annotations/process/AfterProcess.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for after process event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.AFTER_PROCESS)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface AfterProcess {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/process/BeforeProcess.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for before process event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.BEFORE_PROCESS)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface BeforeProcess {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/process/PostProcess.java

@@ -33,14 +33,13 @@ import java.lang.annotation.Target;
 import org.adempiere.base.event.IEventTopics;
 import org.adempiere.base.event.annotations.EventTopic;
 
+/**
+ * Method annotation for post process event
+ * @author hengsin
+ */
 @Retention(RUNTIME)
 @Target(METHOD)
 @EventTopic(topic = IEventTopics.POST_PROCESS)
-/**
- * 
- * @author hengsin
- * 
- */
 public @interface PostProcess {
 
 }

org.adempiere.base/src/org/adempiere/base/event/annotations/process/ProcessEventDelegate.java

@@ -32,7 +32,7 @@ import org.osgi.service.event.Event;
 /**
  * Event delegate for handling of process event.<br/>
  * To handle a process related event topic, create a sub class of this and uses the process annotation
- * (AfterProcess, BeforeProcess or PostProcess) to annotate the method for a specific process event topic.
+ * (AfterProcess, BeforeProcess or PostProcess) to annotate the event handling method.
  * @author hengsin
  *
  */
@@ -43,6 +43,7 @@ public class ProcessEventDelegate extends EventDelegate {
 	}
 
 	/**
+	 * Get process info
 	 * @return {@link ProcessInfo}
 	 */
 	protected ProcessInfo getProcessInfo() {

org.adempiere.base/src/org/adempiere/base/event/annotations/process/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide annotation for process event
+ */
+package org.adempiere.base.event.annotations.process;

org.adempiere.base/src/org/adempiere/base/event/delegate/AddressValidationEventDelegate.java

@@ -38,16 +38,14 @@ import org.compiere.model.MSysConfig;
 import org.osgi.service.event.Event;
 
 /**
- * 
+ * Event delegate to perform validation for insert and update of MLocation record.
  * @author hengsin
- *
  */
 @EventTopicDelegate
 @ModelEventTopic(modelClass = MLocation.class)
 public class AddressValidationEventDelegate extends ModelEventDelegate<MLocation> {
 
 	/**
-	 * 
 	 * @param po
 	 * @param event
 	 */

org.adempiere.base/src/org/adempiere/base/event/delegate/AutoProduceEventDelegate.java

@@ -48,15 +48,13 @@ import org.eevolution.model.MPPProductBOMLine;
 import org.osgi.service.event.Event;
 
 /**
- * 
+ * Event delegate to implement auto produce for shipment
  * @author hengsin
- *
  */
 @EventTopicDelegate
 @ModelEventTopic(modelClass = MInOut.class)
 public class AutoProduceEventDelegate extends ModelEventDelegate<MInOut> {
 	/**
-	 * 
 	 * @param po
 	 * @param event
 	 */

org.adempiere.base/src/org/adempiere/base/event/delegate/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide event delegate implementation for address validation and auto produce
+ */
+package org.adempiere.base.event.delegate;

org.adempiere.base/src/org/adempiere/base/event/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide interface and classes for working with and handling different types of OSGi events 
+ */
+package org.adempiere.base.event;

org.adempiere.base/src/org/adempiere/base/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide interface and default implementation of iDempiere core services (model factory, callout factory, etc)
+ */
+package org.adempiere.base;

org.adempiere.base/src/org/adempiere/base/sso/ISSOPrincipalFactory.java

@@ -15,8 +15,8 @@ package org.adempiere.base.sso;
 import org.compiere.model.I_SSO_PrincipalConfig;
 
 /**
+ * Factory interface for single sign on service
  * @author Logilite Technologies
- *
  */
 public interface ISSOPrincipalFactory
 {

org.adempiere.base/src/org/adempiere/base/sso/ISSOPrincipalService.java

@@ -21,6 +21,7 @@ import javax.servlet.http.HttpServletResponse;
 import org.compiere.util.Language;
 
 /**
+ * Single sign on service interface
  * @author Logilite Technologies
  */
 public interface ISSOPrincipalService

org.adempiere.base/src/org/adempiere/base/sso/SSOUtils.java

@@ -24,6 +24,7 @@ import org.compiere.model.MSSOPrincipalConfig;
 import org.compiere.util.CCache;
 
 /**
+ * Utility methods for single sign on support.
  * @author Logilite Technologies
  */
 public class SSOUtils
@@ -52,6 +53,10 @@ public class SSOUtils
 		ignoreResourceURL.add("res");
 	}
 
+	/**
+	 * Get single sign on service
+	 * @return single sign on service
+	 */
 	public static ISSOPrincipalService getSSOPrincipalService()
 	{
 		ISSOPrincipalService principal = null;
@@ -91,9 +96,9 @@ public class SSOUtils
 	}
 
 	/**
-	 * Create Error page for error message
+	 * Create HTML page for error message
 	 * @param error
-	 * @return
+	 * @return HTML error page
 	 */
 	public static String getCreateErrorResponce(String error)
 	{
@@ -118,10 +123,10 @@ public class SSOUtils
 	}
 
 	/**
-	 * if Resource request then it do not redirected to identity provider for authentication
+	 * If request is a resource request, do not redirected to identity provider for authentication
 	 * @param request
 	 * @param isWebUI
-	 * @return
+	 * @return true if request is a resource request
 	 */
 	public static boolean isResourceRequest(HttpServletRequest request, boolean isWebUI)
 	{

org.adempiere.base/src/org/adempiere/base/sso/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide interface and classes for single sign on support.
+ */
+package org.adempiere.base.sso;

org.adempiere.base/src/org/adempiere/base/upload/IUploadHandler.java

@@ -28,16 +28,18 @@ package org.adempiere.base.upload;
 import org.compiere.model.MAuthorizationAccount;
 
 /**
- * handler interface for upload request
+ * Handler interface for upload of media
  * @author hengsin
  */
 public interface IUploadHandler {
 	/**
+	 * Get label/name for this handler.
 	 * @return label for handler
 	 */
 	public String getLabel();
 	
 	/**
+	 * Upload media to external authorized account
 	 * @param media
 	 * @param account external account to upload to (for e.g, Google drive account)
 	 * @return {@link UploadResponse}

org.adempiere.base/src/org/adempiere/base/upload/IUploadService.java

@@ -26,7 +26,7 @@
 package org.adempiere.base.upload;
 
 /**
- * interface for upload service
+ * Interface for upload service
  * @author hengsin
  *
  */

org.adempiere.base/src/org/adempiere/base/upload/UploadMedia.java

@@ -28,9 +28,8 @@ package org.adempiere.base.upload;
 import java.io.InputStream;
 
 /**
- * representation of media
+ * Representation of upload media
  * @author hengsin
- *
  */
 public class UploadMedia {
 
@@ -54,6 +53,7 @@ public class UploadMedia {
 	}
 
 	/**
+	 * Get content type of media
 	 * @return content type of media
 	 */
 	public String getContentType() {
@@ -61,6 +61,7 @@ public class UploadMedia {
 	}
 
 	/**
+	 * Get media name
 	 * @return name/label of media
 	 */
 	public String getName() {
@@ -68,6 +69,7 @@ public class UploadMedia {
 	}
 
 	/**
+	 * Get input stream for media content
 	 * @return {@link InputStream} for media content
 	 */
 	public InputStream getInputStream() {
@@ -75,6 +77,7 @@ public class UploadMedia {
 	}
 
 	/**
+	 * Get length of media content
 	 * @return length of media content
 	 */
 	public long getContentLength() {

org.adempiere.base/src/org/adempiere/base/upload/UploadResponse.java

@@ -28,7 +28,6 @@ package org.adempiere.base.upload;
 /**
  * Response from upload service
  * @author hengsin
- *
  */
 public class UploadResponse {
 	
@@ -46,6 +45,7 @@ public class UploadResponse {
 	}
 
 	/**
+	 * Get external link URL to the uploaded file
 	 * @return link URL to the uploaded file
 	 */
 	public String getLink() {
@@ -53,6 +53,7 @@ public class UploadResponse {
 	}
 
 	/**
+	 * Get label for the uploaded file
 	 * @return label for the uploaded file
 	 */
 	public String getLinkLabel() {

org.adempiere.base/src/org/adempiere/base/upload/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide interface and classes for external upload support.
+ */
+package org.adempiere.base.upload;

org.adempiere.base/src/org/adempiere/exceptions/AdempiereException.java

@@ -20,16 +20,15 @@ import org.compiere.util.Env;
 import org.compiere.util.Msg;
 
 /**
- * Runtime exception that occurs inside the Adempiere core
+ * Runtime exception that occurs inside iDempiere core
  * @author Teo Sarca, SC ARHIPAC SERVICE SRL
  */
 public class AdempiereException extends RuntimeException {
 	/**
-	 * 
+	 * generated serial id
 	 */
 	private static final long serialVersionUID = 2340179640558569534L;
 
-
 	/**
 	 * Default Constructor (saved logger error will be used as message)
 	 */
@@ -37,7 +36,6 @@ public class AdempiereException extends RuntimeException {
 		this(getMessageFromLogger());
 	}
 	
-
 	/**
 	 * @param message
 	 */
@@ -67,11 +65,14 @@ public class AdempiereException extends RuntimeException {
 		return msg;
 	}
 	
+	/**
+	 * Get environment context
+	 * @return context
+	 */
 	protected Properties getCtx() {
 		return Env.getCtx();
 	}
 
-
 	/**
 	 * @return error message from logger
 	 * @see org.compiere.util.CLogger#retrieveError()

org.adempiere.base/src/org/adempiere/exceptions/AverageCostingNegativeQtyException.java

@@ -15,7 +15,7 @@
 package org.adempiere.exceptions;
 
 /**
- * 
+ * Exception raise when current quantity of a product's average costing record become negative 
  * @author hengsin
  *
  */

org.adempiere.base/src/org/adempiere/exceptions/AverageCostingZeroQtyException.java

@@ -15,9 +15,8 @@
 package org.adempiere.exceptions;
 
 /**
- * 
+ * Exception raise when current quantity of a product's average costing record is zero
  * @author hengsin
- *
  */
 public class AverageCostingZeroQtyException extends AdempiereException {
 

org.adempiere.base/src/org/adempiere/exceptions/DBException.java

@@ -28,7 +28,6 @@ import org.compiere.util.Env;
 import org.compiere.util.Msg;
 import org.compiere.util.Util;
 
-
 /**
  * This RuntimeException is used to pass SQLException up the chain of calling
  * methods to determine what to do where needed.

org.adempiere.base/src/org/adempiere/exceptions/PORelationException.java

@@ -15,12 +15,13 @@ package org.adempiere.exceptions;
 
 import java.util.logging.Level;
 
+import org.adempiere.model.MRelationType;
 import org.compiere.model.PO;
 import org.compiere.util.CLogger;
 import org.compiere.util.Msg;
 
 /**
- * 
+ * Exception related to invalid {@link MRelationType} configuration.
  * @author Tobias Schoeneberg, www.metas.de - FR [ 2897194 ] Advanced Zoom and
  *         RelationTypes
  */

org.adempiere.base/src/org/adempiere/exceptions/TaxCriteriaNotFoundException.java

@@ -13,7 +13,6 @@
  *****************************************************************************/
 package org.adempiere.exceptions;
 
-
 /**
  * Throw when a tax criteria was not found
  * @author Teo Sarca, www.arhipac.ro

org.adempiere.base/src/org/adempiere/exceptions/WarehouseInvalidForOrgException.java

@@ -15,7 +15,6 @@
  *****************************************************************************/
 package org.adempiere.exceptions;
 
-
 /**
  * Throw when there is no Warehouse for Organization.
  * @author victor.perez@e-evolution.com, www.e-evolution.com

org.adempiere.base/src/org/adempiere/exceptions/package-info.java

@@ -0,0 +1,27 @@
+
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide exception classes
+ */
+package org.adempiere.exceptions;

org.adempiere.base/src/org/adempiere/impexp/package-info.java

@@ -0,0 +1,26 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source                      *
+ * http://www.idempiere.org                                            *
+ *                                                                     *
+ * Copyright (C) Contributors                                          *
+ *                                                                     *
+ * This program is free software; you can redistribute it and/or       *
+ * modify it under the terms of the GNU General Public License         *
+ * as published by the Free Software Foundation; either version 2      *
+ * of the License, or (at your option) any later version.              *
+ *                                                                     *
+ * This program is distributed in the hope that it will be useful,     *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of      *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the        *
+ * GNU General Public License for more details.                        *
+ *                                                                     *
+ * You should have received a copy of the GNU General Public License   *
+ * along with this program; if not, write to the Free Software         *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,          *
+ * MA 02110-1301, USA.                                                 *
+ **********************************************************************/
+
+/**
+ * Provide classes for import and export of data using csv or excel format
+ */
+package org.adempiere.impexp;

org.adempiere.base/src/org/adempiere/model/CalloutInfoWindow.java

@@ -33,8 +33,8 @@ import org.compiere.util.DisplayType;
 import org.compiere.util.Env;
 
 /**
+ * Callout for AD_InfoWindow and AD_InfoColumn
  * @author hengsin
- *
  */
 @Callout(tableName = "AD_InfoWindow", columnName = "AD_Table_ID")
 @Callout(tableName = "AD_InfoColumn", columnName = {"AD_Element_ID","AD_Reference_ID"})

org.adempiere.base/src/org/adempiere/model/DocActionDelegate.java

@@ -50,7 +50,7 @@ import org.compiere.util.TimeUtil;
 import org.compiere.util.Util;
 
 /**
- * Helper class for implementation of {@link DocAction} interface.
+ * Helper class to simplify the implementation of {@link DocAction} interface.
  * @see {@link MProjectIssue} for example usage.
  * @author hengsin
  */

org.adempiere.base/src/org/adempiere/model/GenericPO.java

@@ -34,7 +34,7 @@ import org.compiere.process.DocAction;
 /**
  * Generic PO implementation, this can be use together with ModelValidator as alternative to the classic 
  * generated model class and extend ( X_ and M_ ) approach.
- * 
+ * <p>
  * Originally for used to insert/update data from adempieredata.xml file in 2pack.
  * @author Marco LOMBARDO
  * @contributor Low Heng Sin
@@ -155,7 +155,7 @@ public class GenericPO extends PO implements DocAction {
 		return docActionDelegate.getDocStatus();
 	}
 
-	/**************************************************************************
+	/**
 	 * 	Process document
 	 *	@param processAction document action
 	 *	@return true if performed
@@ -280,7 +280,7 @@ public class GenericPO extends PO implements DocAction {
 		return docActionDelegate.reActivateIt();
 	}	//	reActivateIt
 
-	/*************************************************************************
+	/**
 	 * 	Get Summary
 	 *	@return Summary of Document
 	 */
@@ -348,7 +348,7 @@ public class GenericPO extends PO implements DocAction {
  */
 class PropertiesWrapper extends Properties {
 	/**
-	 * 
+	 * generated serial id
 	 */
 	private static final long serialVersionUID = 8887531951501323594L;
 	protected Properties source;

org.adempiere.base/src/org/adempiere/model/GridTabWrapper.java

@@ -28,7 +28,7 @@ import org.compiere.util.CLogger;
 import org.compiere.util.Env;
 
 /**
- * Wrap GridTab to ADempiere Model Interface (i.e. generated interfaces).<br/>
+ * Wrap GridTab to iDempiere Model Interface (i.e. generated interfaces).<br/>
  * Usage example:
  * <pre>
  * I_A_Asset_Disposed bean = GridTabWrapper.create(mTab, I_A_Asset_Disposed.class); 
@@ -44,10 +44,10 @@ public class GridTabWrapper implements InvocationHandler
 	
 	/**
 	 * Create wrapper of type cl for gridTab.
-	 * @param <T>
+	 * @param <T> iDempiere Model Interface (i.e. generated I_* interfaces) type
 	 * @param gridTab
-	 * @param cl
+	 * @param cl iDempiere Model Interface (i.e. generated I_* interfaces) class
-	 * @return wrapper instance for gridTab
+	 * @return wrapped instance for gridTab
 	 */
 	@SuppressWarnings("unchecked")
 	public static <T> T create(GridTab gridTab, Class<T> cl)
@@ -68,7 +68,7 @@ public class GridTabWrapper implements InvocationHandler
 		this.m_gridTab = gridTab;
 	}
 	
-//	@Override
+	@Override
 	public Object invoke(Object proxy, Method method, Object[] args)
 	throws Throwable
 	{
@@ -133,7 +133,8 @@ public class GridTabWrapper implements InvocationHandler
 	}
 	
 	/**
-	 * @return GridTab
+	 * Get wrap GridTab instance
+	 * @return Wrap grid tab instance
 	 */
 	public GridTab getGridTab()
 	{
@@ -151,12 +152,12 @@ public class GridTabWrapper implements InvocationHandler
 	}
 	
 	/**
-	 * Load object that is referenced by given property.
+	 * Load object that is referenced by given property.<br/>
 	 * Example: getReferencedObject("M_Product", method) should load the M_Product record
 	 * with ID given by M_Product_ID property name;
 	 * @param propertyName
 	 * @param method
-	 * @return
+	 * @return referenced instance
 	 */
 	private final Object getReferencedObject(String propertyName, Method method)
 	{

org.adempiere.base/src/org/adempiere/model/IAddressValidation.java

@@ -20,7 +20,6 @@ import org.compiere.model.MAddressTransaction;
 /**
  * Address validation interface
  * @author Elaine
- *
  */
 public interface IAddressValidation {
 	/**