Add javadoc to BlobId

mziccard · mziccard · commit 6de12f20c202 · 2015-11-11T15:35:36.000+01:00
diff --git a/gcloud-java-storage/src/main/java/com/google/gcloud/storage/BlobId.java b/gcloud-java-storage/src/main/java/com/google/gcloud/storage/BlobId.java
@@ -38,10 +38,16 @@ private BlobId(String bucket, String name) {
     this.name = name;
   }
 
+  /**
+   * Returns the name of the bucket containing the blob.
+   */
   public String bucket() {
     return bucket;
   }
 
+  /**
+   * Returns the name of the blob.
+   */
   public String name() {
     return name;
   }
@@ -72,6 +78,12 @@ StorageObject toPb() {
     return storageObject;
   }
 
+  /**
+   * Creates a blob identifier.
+   *
+   * @param bucket the name of the bucket that contains the blob
+   * @param name the name of the blob
+   */
   public static BlobId of(String bucket, String name) {
     return new BlobId(checkNotNull(bucket), checkNotNull(name));
   }

Original file line number	Diff line number	Diff line change
`@@ -38,10 +38,16 @@ private BlobId(String bucket, String name) {`
`38`	`38`	`this.name = name;`
`39`	`39`	`}`
`40`	`40`
	`41`	`+ /**`
	`42`	`+ * Returns the name of the bucket containing the blob.`
	`43`	`+ */`
`41`	`44`	`public String bucket() {`
`42`	`45`	`return bucket;`
`43`	`46`	`}`
`44`	`47`
	`48`	`+ /**`
	`49`	`+ * Returns the name of the blob.`
	`50`	`+ */`
`45`	`51`	`public String name() {`
`46`	`52`	`return name;`
`47`	`53`	`}`
`@@ -72,6 +78,12 @@ StorageObject toPb() {`
`72`	`78`	`return storageObject;`
`73`	`79`	`}`
`74`	`80`
	`81`	`+ /**`
	`82`	`+ * Creates a blob identifier.`
	`83`	`+ *`
	`84`	`+ * @param bucket the name of the bucket that contains the blob`
	`85`	`+ * @param name the name of the blob`
	`86`	`+ */`
`75`	`87`	`public static BlobId of(String bucket, String name) {`
`76`	`88`	`return new BlobId(checkNotNull(bucket), checkNotNull(name));`
`77`	`89`	`}`