Commit 79f02598 authored by Dipl.-Ing. Jonas Stienen's avatar Dipl.-Ing. Jonas Stienen

Updating comments

parents f33d5cb7 054172f0
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
@section vabase_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 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 The official website can be found at http://www.virtualacoustics.org.
@section vabase_sec VABase @section vabase_sec VABase
...@@ -44,7 +44,7 @@ You should also have received a copy of the License with the VA software package ...@@ -44,7 +44,7 @@ You should also have received a copy of the License with the VA software package
@section vabase_getting_started_sec Getting started @section vabase_getting_started_sec Getting started
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 a C++ developer and want to investigate the interface and integrate VA into your application, the first contact point should be the VABase interface represented 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 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. If you want to host a VA server or want to extend the core of VA by new rendering and reproduction modules, see #VACore.
......
...@@ -1068,13 +1068,19 @@ public: ...@@ -1068,13 +1068,19 @@ public:
{ {
SetSoundSourceSignalSource( iID, "" ); SetSoundSourceSignalSource( iID, "" );
}; };
//! Auralisierungsmodus einer Schallquelle zurückgeben (Bitvektor) //! Sound source auralization mode getter
/**
* Set an individual auralization mode for a given sound source.
*
* @param[in] iID Sound source identifier
* @return Auralizaion mode bit-vector
*/
virtual int GetSoundSourceAuralizationMode( const int iID ) const = 0; virtual int GetSoundSourceAuralizationMode( const int iID ) const = 0;
//! Auralisierungsmodus einer Schallquelle setzen (Bitvektor) //! Sound source auralization mode setter
/** /**
* Mit dieser Methode wird der Auralisierungsmodus für eine Schallquelle festgelegt. * Set an individual auralization mode for a given sound source.
* *
* @param[in] iID Sound source identifier * @param[in] iID Sound source identifier
* @param[in] iAuralizationMode Auralizaion mode bit-vector * @param[in] iAuralizationMode Auralizaion mode bit-vector
......
...@@ -29,7 +29,7 @@ public: ...@@ -29,7 +29,7 @@ public:
std::string sFlags; //!< List of properties (flags) (e.g. "debug", "SSE2") std::string sFlags; //!< List of properties (flags) (e.g. "debug", "SSE2")
std::string sComments; //!< Additional comments std::string sComments; //!< Additional comments
//! Als Zeichenkette zurckgeben //! Return VA version as formatted string
/** /**
* @return Version info as formatted string * @return Version info as formatted string
*/ */
......
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