From 1dfcc6cde5334ba490f09b8f30191e15601ff657 Mon Sep 17 00:00:00 2001
From: Adam Lowe <adam.p.lowe@gmail.com>
Date: Tue, 24 Apr 2012 16:39:33 +0100
Subject: [PATCH] Nova VolumeClient: improving javadocs

---
 .../openstack/nova/v1_1/domain/Volume.java     | 18 +++++++++++++-----
 .../nova/v1_1/domain/VolumeAttachment.java     |  4 ++++
 .../nova/v1_1/domain/VolumeSnapshot.java       |  7 +++++++
 3 files changed, 24 insertions(+), 5 deletions(-)

diff --git a/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/Volume.java b/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/Volume.java
index 299e6d9c22..ab7017ae26 100644
--- a/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/Volume.java
+++ b/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/Volume.java
@@ -84,56 +84,67 @@ public class Volume {
       private String description;
       private Map<String, String> metadata = Maps.newHashMap();
 
+      /** @see Volume#getId() */
       public T id(String id) {
          this.id = id;
          return self();
       }
 
+      /** @see Volume#getStatus() */
       public T status(Status status) {
          this.status = status;
          return self();
       }
 
+      /** @see Volume#getSize() */
       public T size(int size) {
          this.size = size;
          return self();
       }
 
+      /** @see Volume#getZone() */
       public T zone(String zone) {
          this.zone = zone;
          return self();
       }
 
+      /** @see Volume#getCreated() */
       public T created(Date created) {
          this.created = created;
          return self();
       }
 
+      /** @see Volume#getAttachments() */
       public T attachments(Set<VolumeAttachment> attachments) {
          this.attachments = attachments;
          return self();
       }
-
+      
+      /** @see Volume#getVolumeType() */
       public T volumeType(String volumeType) {
          this.volumeType = volumeType;
          return self();
       }
 
+      /** @see Volume#getSnapshotId() */
       public T snapshotId(String snapshotId) {
          this.snapshotId = snapshotId;
          return self();
       }
-
+      
+      /** @see Volume#getMetadata() */
       public T metadata(Map<String, String> metadata) {
          this.metadata = metadata;
          return self();
       }
 
+      /** @see Volume#getName() */
       public T name(String name) {
          this.name = name;
          return self();
       }
 
+      /** @see Volume#getDescription() */
       public T description(String description) {
          this.description = description;
          return self();
@@ -247,9 +258,6 @@ public class Volume {
       return this.volumeType;
    }
 
-   /**
-    * @return the snapshot id this volume is associated with.
-    */
    @Nullable
    public String getSnapshotId() {
       return this.snapshotId;
diff --git a/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/VolumeAttachment.java b/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/VolumeAttachment.java
index b6a231d7d1..bc33a0ba63 100644
--- a/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/VolumeAttachment.java
+++ b/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/VolumeAttachment.java
@@ -46,21 +46,25 @@ public class VolumeAttachment {
       private String serverId;
       private String device;
 
+      /** @see VolumeAttachment#getId() */
       public T id(String id) {
          this.id = id;
          return self();
       }
 
+      /** @see VolumeAttachment#getVolumeId() */
       public T volumeId(String volumeId) {
          this.volumeId = volumeId;
          return self();
       }
 
+      /** @see VolumeAttachment#getServerId() */
       public T serverId(String serverId) {
          this.serverId = serverId;
          return self();
       }
 
+      /** @see VolumeAttachment#getDevice() */
       public T device(String device) {
          this.device = device;
          return self();
diff --git a/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/VolumeSnapshot.java b/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/VolumeSnapshot.java
index b20d47c467..d79d3d3231 100644
--- a/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/VolumeSnapshot.java
+++ b/apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v1_1/domain/VolumeSnapshot.java
@@ -52,36 +52,43 @@ public class VolumeSnapshot {
       private String name;
       private String description;
 
+      /** @see VolumeSnapshot#getId() */
       public T id(String id) {
          this.id = id;
          return self();
       }
 
+      /** @see VolumeSnapshot#getVolumeId() */
       public T volumeId(String volumeId) {
          this.volumeId = volumeId;
          return self();
       }
 
+      /** @see VolumeSnapshot#getStatus() */
       public T status(Volume.Status status) {
          this.status = status;
          return self();
       }
 
+      /** @see VolumeSnapshot#getSize() */
       public T size(int size) {
          this.size = size;
          return self();
       }
 
+      /** @see VolumeSnapshot#getCreated() */
       public T created(Date created) {
          this.created = created;
          return self();
       }
 
+      /** @see VolumeSnapshot#getName() */
       public T name(String name) {
          this.name = name;
          return self();
       }
 
+      /** @see VolumeSnapshot#getDescription() */
       public T description(String description) {
          this.description = description;
          return self();