docs: label legacy storage classes in documentation (#267)

Fixes #254
googleapis · Apr 17, 2020 · 50e5938 · 50e5938
1 parent e11ff16
commit 50e5938
Showing 1 changed file with 34 additions and 14 deletions.
diff --git a/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java b/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClass.java
@@ -20,8 +20,9 @@
 import com.google.cloud.StringEnumValue;
 
 /**
- * Enums for the storage classes. See https://cloud.google.com/storage/docs/storage-classes for
- * details.
+ * Enums for the storage classes. See <a
+ * href="https://cloud.google.com/storage/docs/storage-classes">https://cloud.google.com/storage/docs/storage-classes</a>
+ * for details.
  */
 public final class StorageClass extends StringEnumValue {
   private static final long serialVersionUID = -6938125060419556331L;
@@ -42,42 +43,61 @@ public StorageClass apply(String constant) {
       new StringEnumType(StorageClass.class, CONSTRUCTOR);
 
   /**
-   * Standard storage class. See: https://cloud.google.com/storage/docs/storage-classes for details
+   * Standard storage class.
+   *
+   * @see <a
+   *     href="https://cloud.google.com/storage/docs/storage-classes#standard">https://cloud.google.com/storage/docs/storage-classes#standard</a>
    */
   public static final StorageClass STANDARD = type.createAndRegister("STANDARD");
 
   /**
-   * Nearline storage class. See: https://cloud.google.com/storage/docs/storage-classes for details
+   * Nearline storage class.
+   *
+   * @see <a
+   *     href="https://cloud.google.com/storage/docs/storage-classes#nearline">https://cloud.google.com/storage/docs/storage-classes#nearline</a>
    */
   public static final StorageClass NEARLINE = type.createAndRegister("NEARLINE");
 
   /**
-   * Coldline storage class. See: https://cloud.google.com/storage/docs/storage-classes for details
+   * Coldline storage class.
+   *
+   * @see <a
+   *     href="https://cloud.google.com/storage/docs/storage-classes#coldline">https://cloud.google.com/storage/docs/storage-classes#coldline</a>
    */
   public static final StorageClass COLDLINE = type.createAndRegister("COLDLINE");
 
   /**
-   * Archive storage class. See: https://cloud.google.com/storage/docs/storage-classes for details
+   * Archive storage class.
+   *
+   * @see <a
+   *     href="https://cloud.google.com/storage/docs/storage-classes#archive">https://cloud.google.com/storage/docs/storage-classes#archive</a>
    */
   public static final StorageClass ARCHIVE = type.createAndRegister("ARCHIVE");
 
   /**
-   * Regional storage class. This is supported as a legacy storage class and will be deprecated in
-   * the future. See: https://cloud.google.com/storage/docs/storage-classes for details
+   * Legacy Regional storage class, use {@link #STANDARD} instead. This class will be deprecated in
+   * the future.
+   *
+   * @see <a
+   *     href="https://cloud.google.com/storage/docs/storage-classes#legacy">https://cloud.google.com/storage/docs/storage-classes#legacy</a>
    */
   public static final StorageClass REGIONAL = type.createAndRegister("REGIONAL");
 
   /**
-   * Multi-regional storage class. This is supported as a legacy storage class and will be
-   * deprecated in the future. See: https://cloud.google.com/storage/docs/storage-classes for
-   * details
+   * Legacy Multi-regional storage class, use {@link #STANDARD} instead. This class will be
+   * deprecated in the future.
+   *
+   * @see <a
+   *     href="https://cloud.google.com/storage/docs/storage-classes#legacy">https://cloud.google.com/storage/docs/storage-classes#legacy</a>
    */
   public static final StorageClass MULTI_REGIONAL = type.createAndRegister("MULTI_REGIONAL");
 
   /**
-   * Durable Reduced Availability storage class. This is supported as a legacy storage class and
-   * will be deprecated in the future. See: https://cloud.google.com/storage/docs/storage-classes
-   * for details
+   * Legacy Durable Reduced Availability storage class, use {@link #STANDARD} instead. This class
+   * will be deprecated in the future.
+   *
+   * @see <a
+   *     href="https://cloud.google.com/storage/docs/storage-classes#legacy">https://cloud.google.com/storage/docs/storage-classes#legacy</a>
    */
   public static final StorageClass DURABLE_REDUCED_AVAILABILITY =
       type.createAndRegister("DURABLE_REDUCED_AVAILABILITY");