diff options
author | sanine <sanine.not@pm.me> | 2022-08-25 14:54:53 -0500 |
---|---|---|
committer | sanine <sanine.not@pm.me> | 2022-08-25 14:54:53 -0500 |
commit | 37c97e345d12f95dde44e1d1a4c2f2aadd4615bc (patch) | |
tree | e1bb25bc855883062bdd7847ff2c04290f71c840 /portaudio/doc/src/srcguide.dox | |
parent | 5634c7b04da619669f2f29f6798c03982be05180 (diff) |
add initial structure
Diffstat (limited to 'portaudio/doc/src/srcguide.dox')
-rw-r--r-- | portaudio/doc/src/srcguide.dox | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/portaudio/doc/src/srcguide.dox b/portaudio/doc/src/srcguide.dox new file mode 100644 index 0000000..26fd941 --- /dev/null +++ b/portaudio/doc/src/srcguide.dox @@ -0,0 +1,55 @@ +/* + define all of the file groups used to structure the documentation. +*/ + +/** + @defgroup public_header Public API definitions for users of PortAudio +*/ + +/** + @internal + @defgroup common_src Source code common to all implementations +*/ + +/** + @internal + @defgroup win_src Source code common to all Windows implementations +*/ + +/** + @internal + @defgroup unix_src Source code common to all Unix implementations +*/ + +/** + @internal + @defgroup macosx_src Source code common to all Macintosh implementations +*/ + +/** + @internal + @defgroup hostapi_src Source code for specific Host APIs +*/ + +/** + @internal + @defgroup test_src Test programs +*/ + +/** + @defgroup examples_src Example programs demonstrating PortAudio usage +*/ + +/** + @internal + @page srcguide A guide to the PortAudio sources + + - \ref public_header + - \ref examples_src + - \ref common_src + - \ref win_src + - \ref unix_src + - \ref macosx_src + - \ref hostapi_src + - \ref test_src +*/
\ No newline at end of file |