Updated documentation to reflect the new 2.3.0 branch
This commit is contained in:
parent
c356c71b64
commit
2e0234d469
2
Doxyfile
2
Doxyfile
|
@ -33,7 +33,7 @@ PROJECT_NAME = cAudio
|
||||||
# This could be handy for archiving the generated documentation or
|
# This could be handy for archiving the generated documentation or
|
||||||
# if some version control system is used.
|
# if some version control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER = 2.2.0
|
PROJECT_NUMBER = 2.3.0
|
||||||
|
|
||||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||||
# for a project that appears at the top of each page and should give viewer
|
# for a project that appears at the top of each page and should give viewer
|
||||||
|
|
15
README.md
15
README.md
|
@ -1,17 +1,10 @@
|
||||||
# Version 2.2.0 dev
|
# Version 2.3.0 dev
|
||||||
|
|
||||||
This is the new cAudio 2.2.0 Dev . This release is mainly a bug fix release.
|
This is the development branch for cAudio 2.3.0 development.
|
||||||
|
If you need a stable version of cAudio please use the 2.2.0 tag.
|
||||||
|
|
||||||
## Change log
|
## Change log
|
||||||
|
*Nothing yet
|
||||||
* C# Bindings as well has tutorials and demo application
|
|
||||||
* CMake Build System
|
|
||||||
* Remove unneeded mutex/locks from dataFactory->CreateDataSource
|
|
||||||
* 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
|
## Windows
|
||||||
|
|
||||||
|
|
|
@ -52,7 +52,7 @@
|
||||||
*
|
*
|
||||||
* \section intro Introduction
|
* \section intro Introduction
|
||||||
*
|
*
|
||||||
* Welcome to the Main API Documentation for cAudio 2.2.0. cAudio is an advanced C++ wrapper around OpenAL, a professional and powerful
|
* Welcome to the Main API Documentation for cAudio 2.3.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
|
* 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
|
* 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,
|
* the functionality of the library. Furthermore, cAudio is released under the zlib license, meaning it is free for you to use in your projects,
|
||||||
|
|
Loading…
Reference in New Issue