From 92198a40c008ceb808d8e47cacd52b6dc6809812 Mon Sep 17 00:00:00 2001
From: prabathabey <prabathabey@git.com>
Date: Fri, 27 Mar 2015 13:02:41 +0530
Subject: [PATCH] More code cleanups

---
 .../carbon/device/mgt/core/api/mgt/APIConfig.java    | 12 ++++++++++++
 .../mgt/core/api/mgt/config/APIPublisherConfig.java  |  4 ++++
 2 files changed, 16 insertions(+)

diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/api/mgt/APIConfig.java b/components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/api/mgt/APIConfig.java
index 834bb9e77f..242f3b8360 100644
--- a/components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/api/mgt/APIConfig.java
+++ b/components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/api/mgt/APIConfig.java
@@ -27,6 +27,18 @@ import javax.xml.bind.annotation.XmlTransient;
 /**
  * This bean class carries the properties used by some API that needs to be published within the underlying
  * API-Management infrastructure.
+ *
+ * A sample API configuration accepted by this particular bean class would look like what's shown below.
+ * e.g.
+ *
+ * <API>
+ *      <Name>enrollment</Name>
+ *      <Owner>admin</Owner>
+ *      <Context>/enrol</Context>
+ *      <Version>1.0.0</Version>
+ *      <Endpoint>http://localhost:9763/</Endpoint>
+ *      <Transports>http,https</Transports>
+ * </API>
  */
 @XmlRootElement(name = "API")
 public class APIConfig {
diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/api/mgt/config/APIPublisherConfig.java b/components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/api/mgt/config/APIPublisherConfig.java
index 8c4c9483d3..91d3f46108 100644
--- a/components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/api/mgt/config/APIPublisherConfig.java
+++ b/components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/api/mgt/config/APIPublisherConfig.java
@@ -36,6 +36,10 @@ import javax.xml.bind.annotation.XmlRootElement;
 import java.io.File;
 import java.util.List;
 
+/**
+ * This class carries all API configurations used by device management components, that need to be published within
+ * the underlying API-Management infrastructure.
+ */
 @XmlRootElement(name = "APIPublisherConfig")
 public class APIPublisherConfig {