diff --git a/src/org/hyperic/hq/hqapi1/AlertApi.java b/src/org/hyperic/hq/hqapi1/AlertApi.java index 3f2e3e67..dc34b92b 100644 --- a/src/org/hyperic/hq/hqapi1/AlertApi.java +++ b/src/org/hyperic/hq/hqapi1/AlertApi.java @@ -35,6 +35,16 @@ import java.util.Map; import java.util.HashMap; +/** + * The Hyperic HQ Alert API. + *

+ * This class provides access to the alerts within the HQ system. Each of the + * methods in this class return {@link org.hyperic.hq.hqapi1.types.Response} + * objects that wrap the result of the method with a + * {@link org.hyperic.hq.hqapi1.types.ResponseStatus} and a + * {@link org.hyperic.hq.hqapi1.types.ServiceError} that indicates the error + * if the response status is {@link org.hyperic.hq.hqapi1.types.ResponseStatus#FAILURE}. + */ public class AlertApi extends BaseApi { AlertApi(HQConnection conn) { diff --git a/src/org/hyperic/hq/hqapi1/EscalationActionBuilder.java b/src/org/hyperic/hq/hqapi1/EscalationActionBuilder.java index f75173c7..a21a5750 100644 --- a/src/org/hyperic/hq/hqapi1/EscalationActionBuilder.java +++ b/src/org/hyperic/hq/hqapi1/EscalationActionBuilder.java @@ -35,7 +35,7 @@ import java.util.List; /** - * Utility class to build @{link org.hyperic.hq.hqapi1.types.EscalationAction}s. + * Utility class to build {@link org.hyperic.hq.hqapi1.types.EscalationAction}s. */ public class EscalationActionBuilder { diff --git a/src/org/hyperic/hq/hqapi1/MetricDataApi.java b/src/org/hyperic/hq/hqapi1/MetricDataApi.java index b02198ff..29531873 100644 --- a/src/org/hyperic/hq/hqapi1/MetricDataApi.java +++ b/src/org/hyperic/hq/hqapi1/MetricDataApi.java @@ -14,6 +14,16 @@ import java.util.Map; import java.util.HashMap; +/** + * The Hyperic HQ MetricData API. + *

+ * This class provides access to the @{link MetricData} within the HQ system. Each of the + * methods in this class return {@link org.hyperic.hq.hqapi1.types.Response} + * objects that wrap the result of the method with a + * {@link org.hyperic.hq.hqapi1.types.ResponseStatus} and a + * {@link org.hyperic.hq.hqapi1.types.ServiceError} that indicates the error + * if the response status is {@link org.hyperic.hq.hqapi1.types.ResponseStatus#FAILURE}. + */ public class MetricDataApi extends BaseApi { MetricDataApi(HQConnection conn) { diff --git a/src/org/hyperic/hq/hqapi1/XmlUtil.java b/src/org/hyperic/hq/hqapi1/XmlUtil.java index e32abbb8..378a1777 100644 --- a/src/org/hyperic/hq/hqapi1/XmlUtil.java +++ b/src/org/hyperic/hq/hqapi1/XmlUtil.java @@ -35,6 +35,9 @@ import java.io.InputStream; import java.io.OutputStream; +/** + * Utility class to convert Java objects to XML and vice versa. + */ public class XmlUtil { private static JAXBContext CTX;