Skip to content

Commit 4f267fc

Browse files
committed
Sync SDL3 wiki -> header
[ci skip]
1 parent 692c71a commit 4f267fc

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

include/SDL3/SDL_dlopennote.h

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
* dynamic shared library dependencies.
2929
*
3030
* If you determine that your toolchain doesn't support dlopen notes, you can
31-
* disable this feature by defining `SDL_DISABLE_DLOPEN_NOTES`. You can use this
32-
* CMake snippet to check for support:
31+
* disable this feature by defining `SDL_DISABLE_DLOPEN_NOTES`. You can use
32+
* this CMake snippet to check for support:
3333
*
3434
* ```cmake
3535
* set(CHECK_ELF_DLNOTES_SRC [==[
@@ -54,9 +54,11 @@
5454
#define SDL_dlopennote_h
5555

5656
/**
57-
* Use this macro with SDL_ELF_NOTE_DLOPEN() to note that a dynamic shared library dependency is optional.
57+
* Use this macro with SDL_ELF_NOTE_DLOPEN() to note that a dynamic shared
58+
* library dependency is optional.
5859
*
59-
* Optional functionality uses the dependency, the binary will work and the dependency is only needed for full-featured installations.
60+
* Optional functionality uses the dependency, the binary will work and the
61+
* dependency is only needed for full-featured installations.
6062
*
6163
* \since This macro is available since SDL 3.4.0.
6264
*
@@ -67,9 +69,11 @@
6769
#define SDL_ELF_NOTE_DLOPEN_PRIORITY_SUGGESTED "suggested"
6870

6971
/**
70-
* Use this macro with SDL_ELF_NOTE_DLOPEN() to note that a dynamic shared library dependency is recommended.
72+
* Use this macro with SDL_ELF_NOTE_DLOPEN() to note that a dynamic shared
73+
* library dependency is recommended.
7174
*
72-
* Important functionality needs the dependency, the binary will work but in most cases the dependency should be provided.
75+
* Important functionality needs the dependency, the binary will work but in
76+
* most cases the dependency should be provided.
7377
*
7478
* \since This macro is available since SDL 3.4.0.
7579
*
@@ -80,9 +84,11 @@
8084
#define SDL_ELF_NOTE_DLOPEN_PRIORITY_RECOMMENDED "recommended"
8185

8286
/**
83-
* Use this macro with SDL_ELF_NOTE_DLOPEN() to note that a dynamic shared library dependency is required.
87+
* Use this macro with SDL_ELF_NOTE_DLOPEN() to note that a dynamic shared
88+
* library dependency is required.
8489
*
85-
* Core functionality needs the dependency, the binary will not work if it cannot be found.
90+
* Core functionality needs the dependency, the binary will not work if it
91+
* cannot be found.
8692
*
8793
* \since This macro is available since SDL 3.4.0.
8894
*
@@ -173,6 +179,7 @@
173179
* ```
174180
*
175181
* Or if you support multiple versions of a library, you can list them:
182+
*
176183
* ```c
177184
* // Our app supports SDL1, SDL2, and SDL3 by dynamically loading them
178185
* SDL_ELF_NOTE_DLOPEN(

0 commit comments

Comments
 (0)