Skip to content

Commit

Permalink
Fix/add JavaDoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Morgan committed Sep 10, 2009
1 parent 098a1f6 commit c9b5b58
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 1 deletion.
10 changes: 10 additions & 0 deletions src/org/hyperic/hq/hqapi1/AlertApi.java
Expand Up @@ -35,6 +35,16 @@
import java.util.Map;
import java.util.HashMap;

/**
* The Hyperic HQ Alert API.
* <br><br>
* 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) {
Expand Down
2 changes: 1 addition & 1 deletion src/org/hyperic/hq/hqapi1/EscalationActionBuilder.java
Expand Up @@ -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 {

Expand Down
10 changes: 10 additions & 0 deletions src/org/hyperic/hq/hqapi1/MetricDataApi.java
Expand Up @@ -14,6 +14,16 @@
import java.util.Map;
import java.util.HashMap;

/**
* The Hyperic HQ MetricData API.
* <br><br>
* 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) {
Expand Down
3 changes: 3 additions & 0 deletions src/org/hyperic/hq/hqapi1/XmlUtil.java
Expand Up @@ -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;
Expand Down

0 comments on commit c9b5b58

Please sign in to comment.