diff options
author | Elwin Hammer <elwinhammer@gmail.com> | 2024-06-22 22:32:30 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-06-22 22:32:30 +0200 |
commit | a9eb2013e6b7297cfce4116179f4ab2d58d1c8d6 (patch) | |
tree | 0f16b75795d9926c5ea4a8ef52a695365837a8e4 /lib/pbdrv/ext/index.dox | |
parent | f121de7c7e3ca8f0dc526973a5ee2586485aad22 (diff) | |
parent | d6440954806d381dae5b3df65b43192f897018c6 (diff) |
Merge pull request #21 from lonkaars/master
Updating branch
Diffstat (limited to 'lib/pbdrv/ext/index.dox')
-rw-r--r-- | lib/pbdrv/ext/index.dox | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/lib/pbdrv/ext/index.dox b/lib/pbdrv/ext/index.dox new file mode 100644 index 0000000..f7d2bc6 --- /dev/null +++ b/lib/pbdrv/ext/index.dox @@ -0,0 +1,24 @@ +// vim:ft=doxygen +/** +\ingroup pbdrv +\ingroup pbdrv-mod +\defgroup pb_ext Extensions +\brief Platform-specific \ref pbdrv implementations + +Extensions provide platform-specific implementations for various functions used +in \ref pbdrv, and allows \ref pbdrv to remain completely portable. Extensions +are used in both \ref pbdrv and \ref pbdrv-mod. + +In order to use an extension, include the appropriate CMake lists file for your +target platform after the \ref pbdrv include: + +```cmake +# include pbdrv +add_subdirectory(lib/pbdrv) + +# use stdlib extension (for use with C standard library) +include(lib/pbdrv/ext/stdlib/include.cmake) + +``` + +*/ |