Update ReadMe and comments (GoogleCloudPlatform#1426)

averikitsch · web-flow · commit 827291acbce1 · 2019-05-20T13:08:03.000-07:00
diff --git a/appengine-java11/guestbook-cloud-firestore/src/main/java/com/example/guestbook/Greeting.java b/appengine-java11/guestbook-cloud-firestore/src/main/java/com/example/guestbook/Greeting.java
@@ -22,7 +22,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** Greeting model. */
+/** Represents a greeting: id, guestbook reference, author, content, date. */
 @SuppressWarnings("JavadocMethod")
 public class Greeting {
 
diff --git a/appengine-java11/guestbook-cloud-firestore/src/main/java/com/example/guestbook/Guestbook.java b/appengine-java11/guestbook-cloud-firestore/src/main/java/com/example/guestbook/Guestbook.java
@@ -30,7 +30,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** Guestbook model. */
+/** Represents a guestbook: book name, book document reference. */
 @SuppressWarnings("JavadocMethod")
 public class Guestbook {
 
@@ -42,24 +42,24 @@ public class Guestbook {
 
   public Guestbook(String book) {
     this.book = book == null ? "default" : book;
-
     // Construct the Guestbook data.
     Map<String, Object> bookData = new HashMap<>();
     bookData.put("name", this.book);
     // [START gae_java11_firestore_book]
-    // Get Guestbook reference in the collection.
+    // The Guestbook document reference in the collection.
     bookRef = getFirestore().collection("Guestbooks").document(this.book);
-    // Add Guestbook to collection.
+    // Add the Guestbook to collection.
     bookRef.set(bookData);
     // [END gae_java11_firestore_book]
   }
 
+  /** Get the Firestore reference to the Guestbook document **/
   public DocumentReference getBookRef() {
     return bookRef;
   }
 
   // [START gae_java11_firestore_get_greetings]
-  /** Get greetings for the Guestbook */
+  /** Query Firstore for Guestbook greetings */
   public List<Greeting> getGreetings() {
     // Initialize a List for Greetings.
     ImmutableList.Builder<Greeting> greetings = new ImmutableList.Builder<Greeting>();
diff --git a/appengine-java11/guestbook-cloud-firestore/src/main/webapp/index.jsp b/appengine-java11/guestbook-cloud-firestore/src/main/webapp/index.jsp
@@ -35,10 +35,10 @@ limitations under the License.
     }
     pageContext.setAttribute("guestbookName", guestbookName);
 
-    // Create the correct Ancestor key
+    // Create a Guestbook object.
     Guestbook theBook = new Guestbook(guestbookName);
 
-    // Run an ancestor query to ensure we see the most up-to-date
+    // Run an query to ensure we see the most up-to-date
     // view of the Greetings belonging to the selected Guestbook.
     List<Greeting> greetings = theBook.getGreetings();
   %>
diff --git a/appengine-java11/oauth2/README.md b/appengine-java11/oauth2/README.md
@@ -1,7 +1,7 @@
 # Google OAuth 2.0 on Google App Engine Standard with Java 11
 
 This sample shows how to implement an OAuth 2.0 flow using the
-[Google OAuth Client Library for Java](client) to access protected data stored
+[Google OAuth Client Library for Java][client] to access protected data stored
 on Google services. OAuth 2.0 is a standard specification for allowing end
 users to securely authorize a client application to access protected
 server-side resources.
