Doxy main header for VA

parent d75937f4
......@@ -15,12 +15,16 @@
@mainpage
@section intro_sec Introduction
@section vabase_intro_sec Introduction
The Virtual Acoustics project is free, open source real-time auralization framework. It is distributed under the terms of the Apache License Version 2.0.
The official website can be found at http://www.virtualacoustics.org
@section license_sec License
@section vabase_sec VABase
VABase provides basic classes and a sophisticated interface calls #IVAInterface that is used throughout the entire
@section vabase_license_sec License
Copyright 2015-2017 Institute of Technical Acoustics (ITA), RWTH Aachen University
......@@ -36,12 +40,13 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
You should also have received acopy of the License with the VA software package.
You should also have received a copy of the License with the VA software package.
@section getting_started Getting started
@section vabase_getting_started_sec Getting started
If you are a C++ developer and want to integrate VA into your application, the first contact point should be the VABase interface representad by the #IVAInterface class.
If you are a C++ developer and want to investigate the interface and integrate VA into your application, the first contact point should be the VABase interface representad by the #IVAInterface class.
If you are planning to create a binding for any other programming and/or scripting language, also have a look at VANet and the #IVANetClient class.
If you want to host a VA server or want to extend the core of VA by new rendering and reproduction modules, see #VACore.
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment