|
23 | 23 | * Marks a field as excluded from the database instance. |
24 | 24 | * |
25 | 25 | * <h3>Kotlin Note</h3> |
26 | | - * When applying this annotation to a property of a Kotlin class, the <code>@get</code> use-site |
27 | | - * target should always be used. There is no need to use the <code>@set</code> use-site target as |
28 | | - * this annotation is <em>only</em> considered when <em>writing</em> instances into Firestore, and |
29 | | - * is ignored when <em>reading</em> instances from Firestore. |
| 26 | + * When applying this annotation to a property of a Kotlin class, the {@code @get} use-site target |
| 27 | + * should always be used. There is no need to use the {@code @set} use-site target as this |
| 28 | + * annotation is <em>only</em> considered when <em>writing</em> instances into Firestore, and is |
| 29 | + * ignored when <em>reading</em> instances from Firestore. |
30 | 30 | * <p> |
31 | 31 | * Here is an example of a class that can both be written into and read from Firestore whose |
32 | | - * <code>bar</code> property will never be written into Firestore: |
| 32 | + * {@code bar} property will never be written into Firestore: |
33 | 33 | * <pre> |
34 | 34 | * data class Pojo(var foo: String? = null, @get:Exclude var bar: String? = null) { |
35 | 35 | * constructor() : this(null, null) // Used by Firestore to create new instances |
|
41 | 41 | * <pre> |
42 | 42 | * data class Pojo(val foo: String? = null, @get:Exclude val bar: String? = null) |
43 | 43 | * </pre> |
44 | | - * That is, <code>var</code> can be tightened to <code>val</code> and the secondary no-argument |
45 | | - * constructor can be omitted. |
| 44 | + * That is, {@code var} can be tightened to {@code val} and the secondary no-argument constructor |
| 45 | + * can be omitted. |
46 | 46 | */ |
47 | 47 | @Retention(RetentionPolicy.RUNTIME) |
48 | 48 | @Target({ElementType.METHOD, ElementType.FIELD}) |
|
0 commit comments