gfxdev
/
caudio
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Activity

Updated documentation on cAudio.h and added a Doxyfile for easy doxygen documentation

This commit is contained in:
wildicv 2012-06-24 16:12:44 -07:00
parent bae82cb46e
commit 5d082f26fd
3 changed files with 1840 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1837
Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff

2
README.md
View File

@ -10,7 +10,7 @@ This is the new cAudio 2.2.0 Dev . This release is mainly a bug fix release.
* Replace include guards with #pragma once
* Bug fixes,
* cAudio Source are now cleared
* Updated cAudio.h documentation and created doxyfile for easy documentation generation
# Compiling
## Windows

6
cAudio/include/cAudio.h
View File

@ -52,16 +52,14 @@
*
* \section intro Introduction
*
* Welcome to the Main API Documentation for cAudio 2.1.0. cAudio is an advanced C++ wrapper around OpenAL, a professional and powerful
* Welcome to the Main API Documentation for cAudio 2.2.0. cAudio is an advanced C++ wrapper around OpenAL, a professional and powerful
* audio library. Thus cAudio provides you with a number of classes to allow you to easily manipulate your audio world and
* intergrate audio effects like reverberation, doppler, attenuation, ect. cAudio also has a plugin system, allowing developers to extend
* the functionality of the library. Furthermore, cAudio is released under the zlib license, meaning it is free for you to use in your projects,
* even if they are commercial. Of course, we suggest you read the full text of the license by looking at the local license.txt file or cAudio.h.
*
* Included with the SDK is a number of tutorials. We suggest you begin with them as they will guide you through the basics of cAudio usage
* and work up to more advanced topics. If you find you need more help, found a bug, or just want to talk about cAudio, please visit our forums
* at <A HREF="http://www.deathtouchstudios.com/phpBB3/index.php" >http://www.deathtouchstudios.com/phpBB3/index.php</A>.
*
* and work up to more advanced topics.
* \section links Links
*
* <A HREF="namespacec_audio.html">Namespaces</A>: Central namespace for the entire engine. A good place to begin looking.<BR>