Add comment in snippet classes reminding to update docs upon change

mziccard · mziccard · commit b8b2612780ed · 2016-02-10T18:10:34.000+01:00
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/snippets/CreateTableAndLoadData.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/snippets/CreateTableAndLoadData.java
@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/*
+ * EDITING INSTRUCTIONS
+ * This file is referenced in READMEs and javadoc. Any change to this file should be reflected in
+ * project's READMEs and package-info.java.
+ */
+
 package com.google.gcloud.examples.bigquery.snippets;
 
 import com.google.gcloud.bigquery.BigQuery;
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/snippets/InsertDataAndQueryTable.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/snippets/InsertDataAndQueryTable.java
@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/*
+ * EDITING INSTRUCTIONS
+ * This file is referenced in READMEs and javadoc. Any change to this file should be reflected in
+ * project's READMEs and package-info.java.
+ */
+
 package com.google.gcloud.examples.bigquery.snippets;
 
 import com.google.gcloud.bigquery.BigQuery;
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/snippets/AddEntitiesAndRunQuery.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/snippets/AddEntitiesAndRunQuery.java
@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/*
+ * EDITING INSTRUCTIONS
+ * This file is referenced in READMEs and javadoc. Any change to this file should be reflected in
+ * project's READMEs and package-info.java.
+ */
+
 package com.google.gcloud.examples.datastore.snippets;
 
 import com.google.gcloud.datastore.Datastore;
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/snippets/CreateEntity.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/snippets/CreateEntity.java
@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/*
+ * EDITING INSTRUCTIONS
+ * This file is referenced in READMEs and javadoc. Any change to this file should be reflected in
+ * project's READMEs and package-info.java.
+ */
+
 package com.google.gcloud.examples.datastore.snippets;
 
 import com.google.gcloud.datastore.Datastore;
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/snippets/UpdateEntity.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/snippets/UpdateEntity.java
@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/*
+ * EDITING INSTRUCTIONS
+ * This file is referenced in READMEs and javadoc. Any change to this file should be reflected in
+ * project's READMEs and package-info.java.
+ */
+
 package com.google.gcloud.examples.datastore.snippets;
 
 import com.google.gcloud.datastore.Datastore;
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/snippets/GetOrCreateProject.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/snippets/GetOrCreateProject.java
@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/*
+ * EDITING INSTRUCTIONS
+ * This file is referenced in READMEs and javadoc. Any change to this file should be reflected in
+ * project's READMEs and package-info.java.
+ */
+
 package com.google.gcloud.examples.resourcemanager.snippets;
 
 import com.google.gcloud.resourcemanager.Project;
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/snippets/UpdateAndListProjects.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/snippets/UpdateAndListProjects.java
@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/*
+ * EDITING INSTRUCTIONS
+ * This file is referenced in READMEs and javadoc. Any change to this file should be reflected in
+ * project's READMEs and package-info.java.
+ */
+
 package com.google.gcloud.examples.resourcemanager.snippets;
 
 import com.google.gcloud.resourcemanager.Project;
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/snippets/CreateAndListBucketsAndBlobs.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/snippets/CreateAndListBucketsAndBlobs.java
@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/*
+ * EDITING INSTRUCTIONS
+ * This file is referenced in READMEs and javadoc. Any change to this file should be reflected in
+ * project's READMEs and package-info.java.
+ */
+
 package com.google.gcloud.examples.storage.snippets;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/snippets/CreateBlob.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/snippets/CreateBlob.java
@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/*
+ * EDITING INSTRUCTIONS
+ * This file is referenced in READMEs and javadoc. Any change to this file should be reflected in
+ * project's READMEs and package-info.java.
+ */
+
 package com.google.gcloud.examples.storage.snippets;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/snippets/UpdateBlob.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/snippets/UpdateBlob.java
@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/*
+ * EDITING INSTRUCTIONS
+ * This file is referenced in READMEs and javadoc. Any change to this file should be reflected in
+ * project's READMEs and package-info.java.
+ */
+
 package com.google.gcloud.examples.storage.snippets;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
