Skip to content

Commit d5ed567

Browse files
authored
docs: fix some missing doxygen parameters (#236)
Fixes a couple of doxygen complaints for parameter names.
1 parent 4fe8a7a commit d5ed567

File tree

3 files changed

+11
-20
lines changed

3 files changed

+11
-20
lines changed

libs/common/include/launchdarkly/bindings/c/context_builder.h

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -65,20 +65,21 @@ LDContextBuilder_AddKind(LDContextBuilder builder,
6565
char const* key);
6666

6767
/**
68-
* Add or update an attribute in the specified kind.
68+
* Add or update a top-level attribute in the specified kind.
6969
*
7070
* Adding a LDValue to the builder will consume that value.
7171
* You should not access the value after adding it to the builder, and you
7272
* do not need to call LDValue_Free on the value.
7373
*
74+
* @param builder. The builder. Must not be NULL.
7475
* @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.
7677
* @param val The value of the attribute to add. Must not be NULL.
7778
*/
7879
LD_EXPORT(bool)
7980
LDContextBuilder_Attributes_Set(LDContextBuilder builder,
8081
char const* kind,
81-
char const* attr_key,
82+
char const* attr_name,
8283
LDValue val);
8384

8485
/**
@@ -96,6 +97,7 @@ LDContextBuilder_Attributes_Set(LDContextBuilder builder,
9697
* convenience which also adds the attribute to the private attributes list,
9798
* as if using LDContextBuilder_Attributes_AddPrivateAttribute.
9899
*
100+
* @param builder The builder. Must not be NULL.
99101
* @param kind The kind to set the private attribute for. Must not be NULL.
100102
* @param attr_key The key of the private attribute. Must not be NULL.
101103
* @param val The value of the private attribute. Must not be NULL.
@@ -114,6 +116,7 @@ LDContextBuilder_Attributes_SetPrivate(LDContextBuilder builder,
114116
* This method will make a copy of the name string, and the caller remains
115117
* responsible for the original name string.
116118
*
119+
* @param builder The builder. Must not be NULL.
117120
* @param kind The kind to set the name for. Must not be NULL.
118121
* @param name The name to set. Must not be NULL.
119122
*/
@@ -128,6 +131,7 @@ LDContextBuilder_Attributes_SetName(LDContextBuilder builder,
128131
* If true, the context will _not_ appear on the Contexts page in the
129132
* LaunchDarkly dashboard.
130133
*
134+
* @param builder The builder. Must not be NULL.
131135
* @param kind The kind to set the anonymous attribute for. Must not be NULL.
132136
* @param anonymous The value to set the anonymous attribute to.
133137
*/
@@ -166,27 +170,14 @@ LDContextBuilder_Attributes_SetAnonymous(LDContextBuilder builder,
166170
* The attributes "kind" and "key", and the "_meta" attributes cannot be
167171
* made private.
168172
*
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.
183174
* @param kind The kind to set the attribute as private for. Must not be NULL.
184175
* @param attr_ref An attribute reference. Must not be NULL.
185176
*/
186177
LD_EXPORT(bool)
187178
LDContextBuilder_Attributes_AddPrivateAttribute(LDContextBuilder builder,
188179
char const* kind,
189-
char const* attr_key);
180+
char const* attr_ref);
190181
#ifdef __cplusplus
191182
}
192183
#endif

libs/common/include/launchdarkly/bindings/c/object_builder.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ LD_EXPORT(void) LDObjectBuilder_Free(LDObjectBuilder builder);
3636
* be accessed, and the caller doesn't need to call LDValue_Free. The key will
3737
* be copied.
3838
*
39-
* @param array_builder The object builder to add the value to.
39+
* @param builder The object builder to add the value to.
4040
* @param key The key for the value being added. Must not be NULL.
4141
* @param val The value to add. Must not be NULL.
4242
*/

libs/common/include/launchdarkly/bindings/c/value.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ LD_EXPORT(void) LDValue_Free(LDValue val);
136136

137137
/**
138138
* Returns the type of an LDValue.
139-
* @param value LDValue to inspect. Must not be NULL.
139+
* @param val LDValue to inspect. Must not be NULL.
140140
* @return Type of the LDValue, or LDValueType_Unrecognized if the type is
141141
* unrecognized.
142142
*/

0 commit comments

Comments
 (0)