commit 249f616b13bdbd73b0a3fb1af00a8ad90892ade7
author Florina Muntenescu <florinam@google.com> Tue Oct 17 16:07:01 2017 +0100
committer Florina Muntenescu <florinam@google.com> Tue Oct 17 16:07:01 2017 +0100
tree aae23f2778707c2bf38bd02ae46fa830707ee25d
parent b376ec7f518d1bd82634315ded03cca0aed3ef48

Replace some characters with the HTML entities for correct
rendering. Added missing work and paragraph.

Bug: 67890576
Test: NA
Change-Id: Icb5bc81f0c8f3b3e7050196db60078fff46fb641

room/common/src/main/java/android/arch/persistence/room/Relation.java

diff --git a/room/common/src/main/java/android/arch/persistence/room/Relation.java b/room/common/src/main/java/android/arch/persistence/room/Relation.java
index 7206699..d55bbfe 100644
--- a/room/common/src/main/java/android/arch/persistence/room/Relation.java
+++ b/room/common/src/main/java/android/arch/persistence/room/Relation.java
@@ -28,6 +28,8 @@
  * <pre>
  * {@literal @}Entity
  * public class Pet {
+ *     {@literal @} PrimaryKey
+ *     int id;
  *     int userId;
  *     String name;
  *     // other fields
@@ -41,8 +43,8 @@
  *
  * {@literal @}Dao
  * public interface UserPetDao {
- *     {@literal @}Query("SELECT id, name from User WHERE age &gt; :minAge")
- *     public List&lt;UserNameAndAllPets&gt; loadUserAndPets(int minAge);
+ *     {@literal @}Query("SELECT id, name from User")
+ *     public List&lt;UserNameAndAllPets&gt; loadUserAndPets();
  * }
  * </pre>
  * <p>
@@ -63,16 +65,16 @@
  *   {@literal @}Embedded
  *   public User user;
  *   {@literal @}Relation(parentColumn = "id", entityColumn = "userId", entity = Pet.class)
- *   public List<PetNameAndId> pets;
+ *   public List&lt;PetNameAndId&gt; pets;
  * }
  * {@literal @}Dao
  * public interface UserPetDao {
- *     {@literal @}Query("SELECT * from User WHERE age &gt; :minAge")
- *     public List&lt;UserAllPets&gt; loadUserAndPets(int minAge);
+ *     {@literal @}Query("SELECT * from User")
+ *     public List&lt;UserAllPets&gt; loadUserAndPets();
  * }
  * </pre>
  * <p>
- * In the example above, {@code PetNameAndId} is a regular but all of fields are fetched
+ * In the example above, {@code PetNameAndId} is a regular Pojo but all of fields are fetched
  * from the {@code entity} defined in the {@code @Relation} annotation (<i>Pet</i>).
  * {@code PetNameAndId} could also define its own relations all of which would also be fetched
  * automatically.
@@ -85,7 +87,7 @@
  *   public User user;
  *   {@literal @}Relation(parentColumn = "id", entityColumn = "userId", entity = Pet.class,
  *           projection = {"name"})
- *   public List<String> petNames;
+ *   public List&lt;String&gt; petNames;
  * }
  * </pre>
  * <p>
@@ -93,7 +95,7 @@
  * cannot have relations. This is a design decision to avoid common pitfalls in {@link Entity}
  * setups. You can read more about it in the main Room documentation. When loading data, you can
  * simply work around this limitation by creating Pojo classes that extend the {@link Entity}.
- *
+ * <p>
  * Note that the {@code @Relation} annotated field cannot be a constructor parameter, it must be
  * public or have a public setter.
  */