Skip to content

Commit 28003bd

Browse files
authored
docs: substitute 'client' for 'server' in server-side Config Builder bindings (#301)
Must've been a copy paste error.
1 parent f1e93cd commit 28003bd

File tree

1 file changed

+20
-20
lines changed
  • libs/server-sdk/include/launchdarkly/server_side/bindings/c/config

1 file changed

+20
-20
lines changed

libs/server-sdk/include/launchdarkly/server_side/bindings/c/config/builder.h

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,23 @@ LD_EXPORT(LDServerConfigBuilder) LDServerConfigBuilder_New(char const* sdk_key);
2929

3030
/**
3131
* Sets a custom URL for the polling service.
32-
* @param b Client config builder. Must not be NULL.
32+
* @param b Server config builder. Must not be NULL.
3333
* @param url Target URL. Must not be NULL.
3434
*/
3535
LD_EXPORT(void)
3636
LDServerConfigBuilder_ServiceEndpoints_PollingBaseURL(LDServerConfigBuilder b,
3737
char const* url);
3838
/**
3939
* Sets a custom URL for the streaming service.
40-
* @param b Client config builder. Must not be NULL.
40+
* @param b Server config builder. Must not be NULL.
4141
* @param url Target URL. Must not be NULL.
4242
*/
4343
LD_EXPORT(void)
4444
LDServerConfigBuilder_ServiceEndpoints_StreamingBaseURL(LDServerConfigBuilder b,
4545
char const* url);
4646
/**
4747
* Sets a custom URL for the events service.
48-
* @param b Client config builder. Must not be NULL.
48+
* @param b Server config builder. Must not be NULL.
4949
* @param url Target URL. Must not be NULL.
5050
*/
5151
LD_EXPORT(void)
@@ -54,7 +54,7 @@ LDServerConfigBuilder_ServiceEndpoints_EventsBaseURL(LDServerConfigBuilder b,
5454
/**
5555
* Sets a custom URL for a Relay Proxy instance. The streaming,
5656
* polling, and events URLs are set automatically.
57-
* @param b Client config builder. Must not be NULL.
57+
* @param b Server config builder. Must not be NULL.
5858
* @param url Target URL. Must not be NULL.
5959
*/
6060
LD_EXPORT(void)
@@ -64,7 +64,7 @@ LDServerConfigBuilder_ServiceEndpoints_RelayProxyBaseURL(
6464

6565
/**
6666
* Sets an identifier for the application.
67-
* @param b Client config builder. Must not be NULL.
67+
* @param b Server config builder. Must not be NULL.
6868
* @param app_id Non-empty string. Must be <= 64 chars. Must be alphanumeric,
6969
* '-', '.', or '_'. Must not be NULL.
7070
*/
@@ -74,7 +74,7 @@ LDServerConfigBuilder_AppInfo_Identifier(LDServerConfigBuilder b,
7474

7575
/**
7676
* Sets a version for the application.
77-
* @param b Client config builder. Must not be NULL.
77+
* @param b Server config builder. Must not be NULL.
7878
* @param app_version Non-empty string. Must be <= 64 chars. Must be
7979
* alphanumeric,
8080
* '-', '.', or '_'. Must not be NULL.
@@ -86,7 +86,7 @@ LDServerConfigBuilder_AppInfo_Version(LDServerConfigBuilder b,
8686
/**
8787
* Enables or disables "Offline" mode. True means
8888
* Offline mode is enabled.
89-
* @param b Client config builder. Must not be NULL.
89+
* @param b Server config builder. Must not be NULL.
9090
* @param offline True if offline.
9191
*/
9292
LD_EXPORT(void)
@@ -95,7 +95,7 @@ LDServerConfigBuilder_Offline(LDServerConfigBuilder b, bool offline);
9595
/**
9696
* Specify if event-sending should be enabled or not. By default,
9797
* events are enabled.
98-
* @param b Client config builder. Must not be NULL.
98+
* @param b Server config builder. Must not be NULL.
9999
* @param enabled True to enable event-sending.
100100
*/
101101
LD_EXPORT(void)
@@ -105,7 +105,7 @@ LDServerConfigBuilder_Events_Enabled(LDServerConfigBuilder b, bool enabled);
105105
* Sets the capacity of the event processor. When more events are generated
106106
* within the processor's flush interval than this value, events will be
107107
* dropped.
108-
* @param b Client config builder. Must not be NULL.
108+
* @param b Server config builder. Must not be NULL.
109109
* @param capacity Event queue capacity.
110110
*/
111111
LD_EXPORT(void)
@@ -115,7 +115,7 @@ LDServerConfigBuilder_Events_Capacity(LDServerConfigBuilder b, size_t capacity);
115115
* Sets the flush interval of the event processor. The processor queues
116116
* outgoing events based on the capacity parameter; these events are then
117117
* delivered based on the flush interval.
118-
* @param b Client config builder. Must not be NULL.
118+
* @param b Server config builder. Must not be NULL.
119119
* @param milliseconds Interval between automatic flushes.
120120
*/
121121
LD_EXPORT(void)
@@ -141,7 +141,7 @@ LDServerConfigBuilder_Events_FlushIntervalMs(LDServerConfigBuilder b,
141141
* necessary to call either of these methods, as the default behavior is to
142142
* treat all attributes as non-private unless otherwise specified.
143143
*
144-
* @param b Client config builder. Must not be NULL.
144+
* @param b Server config builder. Must not be NULL.
145145
* @param all_attributes_private True for behavior of (1), false for default
146146
* behavior of (2) or (3).
147147
*/
@@ -152,7 +152,7 @@ LDServerConfigBuilder_Events_AllAttributesPrivate(LDServerConfigBuilder b,
152152
/**
153153
* Specifies a single private attribute. May be called multiple times
154154
* with additional private attributes.
155-
* @param b Client config builder. Must not be NULL.
155+
* @param b Server config builder. Must not be NULL.
156156
* @param attribute_reference Attribute to mark private.
157157
*/
158158
LD_EXPORT(void)
@@ -166,7 +166,7 @@ LDServerConfigBuilder_Events_PrivateAttribute(LDServerConfigBuilder b,
166166
* builder indicates the data source will use streaming. Setting a polling
167167
* builder will indicate the use of polling.
168168
*
169-
* @param b Client config builder. Must not be NULL.
169+
* @param b Server config builder. Must not be NULL.
170170
* @param stream_builder The streaming builder. The builder is consumed; do not
171171
* free it.
172172
*/
@@ -182,7 +182,7 @@ LDServerConfigBuilder_DataSource_MethodStream(
182182
* builder indicates the data source will use streaming. Setting a polling
183183
* builder will indicate the use of polling.
184184
*
185-
* @param b Client config builder. Must not be NULL.
185+
* @param b Server config builder. Must not be NULL.
186186
* @param poll_builder The polling builder. The builder is consumed; do not free
187187
* it.
188188
*/
@@ -261,7 +261,7 @@ LDServerDataSourcePollBuilder_Free(LDServerDataSourcePollBuilder b);
261261
* This should be used for wrapper SDKs to set the wrapper name.
262262
*
263263
* Wrapper information will be included in request headers.
264-
* @param b Client config builder. Must not be NULL.
264+
* @param b Server config builder. Must not be NULL.
265265
* @param wrapper_name Name of the wrapper.
266266
*/
267267
LD_EXPORT(void)
@@ -272,7 +272,7 @@ LDServerConfigBuilder_HttpProperties_WrapperName(LDServerConfigBuilder b,
272272
* This should be used for wrapper SDKs to set the wrapper version.
273273
*
274274
* Wrapper information will be included in request headers.
275-
* @param b Client config builder. Must not be NULL.
275+
* @param b Server config builder. Must not be NULL.
276276
* @param wrapper_version Version of the wrapper.
277277
*/
278278
LD_EXPORT(void)
@@ -284,7 +284,7 @@ LDServerConfigBuilder_HttpProperties_WrapperVersion(
284284
* Set a custom header value. May be called more than once with additional
285285
* headers.
286286
*
287-
* @param b Client config builder. Must not be NULL.
287+
* @param b Server config builder. Must not be NULL.
288288
* @param key Name of the header. Must not be NULL.
289289
* @param value Value of the header. Must not be NULL.
290290
*/
@@ -295,14 +295,14 @@ LDServerConfigBuilder_HttpProperties_Header(LDServerConfigBuilder b,
295295

296296
/**
297297
* Disables the default SDK logging.
298-
* @param b Client config builder. Must not be NULL.
298+
* @param b Server config builder. Must not be NULL.
299299
*/
300300
LD_EXPORT(void)
301301
LDServerConfigBuilder_Logging_Disable(LDServerConfigBuilder b);
302302

303303
/**
304304
* Configures the SDK with basic logging.
305-
* @param b Client config builder. Must not be NULL.
305+
* @param b Server config builder. Must not be NULL.
306306
* @param basic_builder The basic logging builder. Must not be NULL.
307307
*/
308308
LD_EXPORT(void)
@@ -311,7 +311,7 @@ LDServerConfigBuilder_Logging_Basic(LDServerConfigBuilder b,
311311

312312
/**
313313
* Configures the SDK with custom logging.
314-
* @param b Client config builder. Must not be NULL.
314+
* @param b Server config builder. Must not be NULL.
315315
* @param custom_builder The custom logging builder. Must not be NULL.
316316
*/
317317
LD_EXPORT(void)

0 commit comments

Comments
 (0)