@@ -65,20 +65,21 @@ LDContextBuilder_AddKind(LDContextBuilder builder,
65
65
char const * key );
66
66
67
67
/**
68
- * Add or update an attribute in the specified kind.
68
+ * Add or update a top-level attribute in the specified kind.
69
69
*
70
70
* Adding a LDValue to the builder will consume that value.
71
71
* You should not access the value after adding it to the builder, and you
72
72
* do not need to call LDValue_Free on the value.
73
73
*
74
+ * @param builder. The builder. Must not be NULL.
74
75
* @param kind The kind to add the attribute to. Must not be NULL.
75
- * @param attr_key The key of the attribute to add. Must not be NULL.
76
+ * @param attr_name The name of the attribute to add. Must not be NULL.
76
77
* @param val The value of the attribute to add. Must not be NULL.
77
78
*/
78
79
LD_EXPORT (bool )
79
80
LDContextBuilder_Attributes_Set (LDContextBuilder builder ,
80
81
char const * kind ,
81
- char const * attr_key ,
82
+ char const * attr_name ,
82
83
LDValue val );
83
84
84
85
/**
@@ -96,6 +97,7 @@ LDContextBuilder_Attributes_Set(LDContextBuilder builder,
96
97
* convenience which also adds the attribute to the private attributes list,
97
98
* as if using LDContextBuilder_Attributes_AddPrivateAttribute.
98
99
*
100
+ * @param builder The builder. Must not be NULL.
99
101
* @param kind The kind to set the private attribute for. Must not be NULL.
100
102
* @param attr_key The key of the private attribute. Must not be NULL.
101
103
* @param val The value of the private attribute. Must not be NULL.
@@ -114,6 +116,7 @@ LDContextBuilder_Attributes_SetPrivate(LDContextBuilder builder,
114
116
* This method will make a copy of the name string, and the caller remains
115
117
* responsible for the original name string.
116
118
*
119
+ * @param builder The builder. Must not be NULL.
117
120
* @param kind The kind to set the name for. Must not be NULL.
118
121
* @param name The name to set. Must not be NULL.
119
122
*/
@@ -128,6 +131,7 @@ LDContextBuilder_Attributes_SetName(LDContextBuilder builder,
128
131
* If true, the context will _not_ appear on the Contexts page in the
129
132
* LaunchDarkly dashboard.
130
133
*
134
+ * @param builder The builder. Must not be NULL.
131
135
* @param kind The kind to set the anonymous attribute for. Must not be NULL.
132
136
* @param anonymous The value to set the anonymous attribute to.
133
137
*/
@@ -166,27 +170,14 @@ LDContextBuilder_Attributes_SetAnonymous(LDContextBuilder builder,
166
170
* The attributes "kind" and "key", and the "_meta" attributes cannot be
167
171
* made private.
168
172
*
169
- * In this example, firstName is marked as private, but lastName is not:
170
- *
171
- * ```
172
- * [TODO]
173
- * ```
174
- *
175
- * This is a metadata property, rather than an attribute that can be
176
- * addressed in evaluations: that is, a rule clause that references the
177
- * attribute name "privateAttributes", will not use this value, but would
178
- * use a "privateAttributes" attribute set on the context.
179
- *
180
- * This method will make a copy of the attr_ref string, and the caller remains
181
- * responsible for the original name string.
182
- *
173
+ * @param builder The builder. Must not be NULL.
183
174
* @param kind The kind to set the attribute as private for. Must not be NULL.
184
175
* @param attr_ref An attribute reference. Must not be NULL.
185
176
*/
186
177
LD_EXPORT (bool )
187
178
LDContextBuilder_Attributes_AddPrivateAttribute (LDContextBuilder builder ,
188
179
char const * kind ,
189
- char const * attr_key );
180
+ char const * attr_ref );
190
181
#ifdef __cplusplus
191
182
}
192
183
#endif
0 commit comments