Skip to content

Commit 558d3f7

Browse files
authored
chore: add @file directive to C bindings (#135)
Doxygen requires `@file` directives in files that contain global functions, which for us is the C bindings.
1 parent 084cfd6 commit 558d3f7

File tree

12 files changed

+17
-3
lines changed

12 files changed

+17
-3
lines changed

libs/client-sdk/include/launchdarkly/client_side/bindings/c/sdk.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
/** @file sdk.h
2+
* @brief LaunchDarkly Client-side C Bindings.
3+
*/
14
// NOLINTBEGIN modernize-use-using
2-
35
#pragma once
46

57
#include <launchdarkly/bindings/c/config/config.h>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file */
12
// NOLINTBEGIN modernize-use-using
23

34
#pragma once

libs/common/include/launchdarkly/bindings/c/config/builder.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file */
12
// NOLINTBEGIN modernize-use-using
23

34
#pragma once

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file */
12
// NOLINTBEGIN modernize-use-using
23

34
#pragma once

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file */
12
// NOLINTBEGIN modernize-use-using
23

34
#pragma once

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file */
12
// NOLINTBEGIN modernize-use-using
23

34
#pragma once

libs/common/include/launchdarkly/bindings/c/data/evaluation_detail.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file */
12
// NOLINTBEGIN modernize-use-using
23

34
#pragma once

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file */
12
// NOLINTBEGIN modernize-use-using
23

34
#pragma once
@@ -18,7 +19,7 @@ extern "C" { // only need to export C interface if
1819
* Freeing an LDListenerConnection does not disconnect the connection. If it is
1920
* deleted, without being disconnected, then the listener will remain active
2021
* until the associated SDK is freed.
21-
*/
22+
*/
2223
typedef struct _LDListenerConnection* LDListenerConnection;
2324

2425
/**
@@ -27,7 +28,8 @@ typedef struct _LDListenerConnection* LDListenerConnection;
2728
* @param connection The connection for the listener to disconnect.
2829
* Must not be NULL.
2930
*/
30-
LD_EXPORT(void) LDListenerConnection_Disconnect(LDListenerConnection connection);
31+
LD_EXPORT(void)
32+
LDListenerConnection_Disconnect(LDListenerConnection connection);
3133

3234
/**
3335
* Free a listener connection.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file */
12
// NOLINTBEGIN modernize-use-using
23

34
#pragma once

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file */
12
// NOLINTBEGIN modernize-use-using
23

34
#pragma once

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file */
12
// NOLINTBEGIN modernize-use-using
23

34
#pragma once

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file */
12
// NOLINTBEGIN modernize-use-using
23

34
#pragma once

0 commit comments

Comments
 (0)