Applied doxy fixes

include/VA.h

@@ -36,7 +36,7 @@ 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 a [copy of the License](LICENSE.md) with the VA software package.
+You should also have received acopy of the License with the VA software package.
 
 @section getting_started Getting started
 

include/VAAudioSignalSource.h

@@ -57,13 +57,13 @@ public:
 
 	//! Type ID getter
 	/**
-	  * @return Returns the ID (one out of #SoundSourceTypes)
+	  * @return Returns the ID (one out of AudioSignalSourceType)
 	  */
 	virtual int GetType() const = 0;
 
 	//! Type getter (human readable string)
 	/**
-	  * @return Returns the type (one out of #SoundSourceTypes as a human readable string)
+	  * @return Returns the type (one out of AudioSignalSourceType as a human readable string)
 	  */
 	virtual std::string GetTypeString() const = 0;
 
@@ -101,19 +101,18 @@ public:
 	/**
 	  * Returns the data pointer to the next audio block of the sound source.
 	  *
-	  * @param[in] oStreamState Information on stream state
+	  * @param[in] pStreamInfo Information on stream state
 	  *
 	  * @return Pointer to the audio data array containing data for next block (NULL if no data available)
 	  *
-	  * @note This method is called by the core to fetch data. If the core
-	  *       receives a NULL pointer it will be interpreted as silence.
+	  * @note This method is called by the core to fetch data. If the core receives a NULL pointer it will be interpreted as silence.
 	  */
 	virtual const float* GetStreamBlock( const CVAAudiostreamState* pStreamInfo ) = 0;
 
 	//! Parameter getter interaction hook
 	/**
 	  * @param[in] oIn Parameter request set
-	  * @param[out] Parameters
+	  * @return Parameters
 	  */
 	virtual CVAStruct GetParameters( const CVAStruct& oIn ) const = 0;
 

include/VABase.h

@@ -198,12 +198,12 @@ inline VABASE_API VAVec3 operator-( const VAVec3& oSummand1, const VAVec3& oSumm
 
 //!< Scalar multiply operator for vectors
 /**
-  * @param[in] oVec VEctor
+  * @param[in] oVec Vector
   * @param[in] dScalar Scalar
   *
-  * @param Scaled vector
+  * @return Scaled vector
   */
-inline VABASE_API VAVec3 operator*( const VAVec3& oVec, double dScalar )
+inline VABASE_API VAVec3 operator*( const VAVec3& oVec, const double dScalar )
 {
 	VAVec3 vScaledVector = oVec;
 	vScaledVector.x *= dScalar;
@@ -541,11 +541,11 @@ public:
 	//! Initializing constructor
 	/**
 	  * @param[in] sID Identifier string
-	  * @param[in] iType
+	  * @param[in] iType Type
 	  * @param[in] sName Name of signal source info
 	  * @param[in] sDesc Brief description of signal source info
 	  * @param[in] sState State description of signal source info
-	  * @param[in] iReference Usage reference counter
+	  * @param[in] iReferences Usage reference counter
 	  */
 	inline CVASignalSourceInfo( const std::string& sID, const int iType, const std::string& sName, const std::string& sDesc, const std::string& sState, const int iReferences )
 		: sID( sID )

include/VAInterface.h

@@ -201,7 +201,7 @@ public:
 
 	//! Attaches a handler for core events to the core instance
 	/**
-	* @oaram[in] pEventHandler Event handler pointer
+	* @param[in] pEventHandler Event handler pointer
 	 * @note Attaching event handlers it always possible,
 	 *            regardless of the state of the core.
 	 *            This method can therefore be called anytime,
@@ -211,7 +211,7 @@ public:
 
 	//! Detaches a handler for core events from the core instance
 	/**
-	 * @oaram[in] pEventHandler Event handler pointer
+	 * @param[in] pEventHandler Event handler pointer
 	 * @note Detaching event handlers it always possible,
 	 *            regardless of the state of the core.
 	 *            This method can therefore be called anytime,
@@ -263,7 +263,7 @@ public:
 	  *
 	  * @return	Encapsulated file paths
 	  *
-	  * @warn This call may take a while and can result in a lot of return data.
+	  * @warning This call may take a while and can result in a lot of return data.
 	  */
 	virtual CVAStruct GetFileList( const bool bRecursive = true, const std::string& sFileSuffixFilter = "*" ) const = 0;
 
@@ -351,6 +351,7 @@ public:
 	//! Directivity parameter getter
 	/**
 	  * @param[in] iID  Identifier
+	  * @param[in] oParams  Parameters
 	  * @return Parameters
 	  */
 	virtual CVAStruct GetDirectivityParameters( const int iID, const CVAStruct& oParams ) const = 0;
@@ -485,7 +486,7 @@ public:
 	
 	//! Get geometry mesh ids
 	/**
-	  * @param[out] viID All available geometry mesh identifiers
+	  * @param[out] viIDs All available geometry mesh identifiers
 	  *
 	  */
 	virtual void GetGeometryMeshIDs( std::vector< int >& viIDs ) const = 0;
@@ -561,7 +562,7 @@ public:
 	/**
 	  * Creates a signal source which streams the samples of a buffer.
 	  *
-	  * @param[in] oSample Buffer samples
+	  * @param[in] oSamples Buffer samples
 	  * @param[in] sName		Name (optional, e.g. "Trumpet")
 	  *
 	  * @return Signal source ID
@@ -578,7 +579,7 @@ public:
 	  * Creates a signal source which streams the samples of a buffer with more than one channel.
 	  * Useful for prototyping, i.e. for switching channels during playback or mixing.
 	  *
-	  * @param[in] oSample Buffer sample vector
+	  * @param[in] voSamples Buffer sample vector
 	  * @param[in] sName		Name (optional, e.g. "Trumpet")
   	  *
 	  * @return Signal source ID
@@ -640,6 +641,7 @@ public:
 
 	//! Creates a rotating engine source
 	/**
+	  * @param[in] oParams  Parameters
 	  * @param[in] sName Name of the engine
 	  * @return ID of signal source
 	  */
@@ -647,7 +649,9 @@ public:
 
 	//! Creates a machine signal source
 	/**
+	  * @param[in] oParams  Parameters
 	  * @param[in] sName Name of the machine
+	  *@return Signal source identifier
 	  */
 	virtual std::string CreateSignalSourceMachine( const CVAStruct& oParams, const std::string& sName = "" ) = 0;
 
@@ -655,8 +659,7 @@ public:
 	/**
 	  * Deletes a signal source. This is only possible if it is not in use.
 	  *
-	  * @return true, if the signal source has been deleted
-	  *         false, otherwise
+	  * @return True, if the signal source has been deleted, false otherwise
 	  */
 	virtual bool DeleteSignalSource( const std::string& sID ) = 0;
 
@@ -666,7 +669,7 @@ public:
 	  * by the core. The core assignes it an ID, which makes it usable for
 	  * auralization.
 	  *
-	  * @param[in] pSource	Signal source instance
+	  * @param[in] pSignalSource	Signal source instance
 	  * @param[in] sName		Name (optional, z.B. "My tone generator")
 	  *
 	  * @return Signal source ID
@@ -680,10 +683,9 @@ public:
 	  * Unregisters an (external) signal source from the core.
 	  * This is only possible, if the signal source is not in use.
 	  *
-	  * @param[in] pSource	Signal source instance
+	  * @param[in] pSignalSource	Signal source instance
 	  *
-	  * @return true, if the signal source has been unregistered
-	  *         false, otherwise
+	  * @return true, if the signal source has been unregistered, false otherwise
 	  *
 	  * @note This function is only locally available, but not remote
 	  */
@@ -714,7 +716,7 @@ public:
 	  * Start, stop or pause the playback of an audiofile using the playback action flags (bit-vector).
 	  *
 	  * @param[in] sSignalSourceID Signal source identifier
-	  * @param[in iPlaybackAction Playback action integer
+	  * @param[in] iPlaybackAction Playback action integer
 	  */
 	virtual void SetSignalSourceBufferPlaybackAction( const std::string& sSignalSourceID, const int iPlaybackAction ) = 0;
 
@@ -961,7 +963,7 @@ public:
 	/**
 	  * This method creates a new sound source and returns its ID.
 	  * This sound source will be skipped for rendering from any other
-	  * but the given renderer. See \GetRenderingModules to get a list
+	  * but the given renderer. See GetRenderingModules() to get a list
 	  * of available renderers and their name identifier.
 	  *
 	  * @param[in]	sRendererID		Identifier of target renderer
@@ -1037,7 +1039,7 @@ public:
 	  * moving source geometry is relevant for occlusion of other source-receivere-paths, like
 	  * cars, trains, etc.
 	  *
-	  * @param[in] iID	Sound source identifier
+	  * @param[in] iSoundReceiverID	Sound source identifier
 	  * @param[in] iGeometryMeshID Geo mesh identifier
 	  *
 	  */
@@ -1054,13 +1056,13 @@ public:
 	  * @param[in] sSignalSourceID	Signal source identifier
 	  *
 	  */
-	virtual void SetSoundSourceSignalSource( const int iSoundSourceID, const std::string& sSignalSourceID ) = 0;
+	virtual void SetSoundSourceSignalSource( const int iID, const std::string& sSignalSourceID ) = 0;
 
 	//! Detach signal source from a sound sourve
 	/**
 	  * Detaches a connected signal source from a sound source. Signal source will not be removed.
 	  *
-	  * @param[iniID]	Sound source identifier
+	  * @param[in] iID	Sound source identifier
 	  */
 	inline void RemoveSoundSourceSignalSource( const int iID )
 	{
@@ -1072,16 +1074,19 @@ public:
 
 	//! Auralisierungsmodus einer Schallquelle setzen (Bitvektor)
 	/**
-	 * Mit dieser Methode wird der Auralisierungsmodus für eine Schallquelle festgelegt.
-	 */
-	virtual void SetSoundSourceAuralizationMode( const int iSoundSourceID, const int iAuralizationMode ) = 0;
+	  * Mit dieser Methode wird der Auralisierungsmodus für eine Schallquelle festgelegt.
+	  *
+	  * @param[in] iID Sound source identifier
+	  * @param[in] iAuralizationMode Auralizaion mode bit-vector
+	  */
+	virtual void SetSoundSourceAuralizationMode( const int iID, const int iAuralizationMode ) = 0;
 
 	//! Set sound source parameters
 	/**
 	  * This general parameter setter can be used for quick solutions changing
 	  * sound source parameters without introducing new methods to the main interface.
 	  *
-	  * @param[in] iSoundSourceID Sound source identifier
+	  * @param[in] iID Sound source identifier
 	  * @param[in] oParams Magic struct with the parameters
 	  */
 	virtual void SetSoundSourceParameters( const int iID, const CVAStruct& oParams ) = 0;
@@ -1091,7 +1096,7 @@ public:
 	  * This general parameter getter can be used for quick solutions retrieving
 	  * sound receiver parameters without introducing new methods to the main interface.
 	  *
-	  * @param[in] iSoundSourceID Sound source identifier
+	  * @param[in] iID Sound source identifier
 	  * @param[in] oParams Magic struct with the parameters that are requested
 	  * @return Magic struct with the parameter values requested
 	  */
@@ -1108,6 +1113,7 @@ public:
 	/**
 	  * In order to remove an assigned directivity, you can pass -1 to the method.
 	  * @param[in] iID Sound source identifier
+	  * @param[in] iDirectivityID Directivity identifier
 	  */
 	virtual void SetSoundSourceDirectivity( const int iID, const int iDirectivityID ) = 0;
 
@@ -1244,7 +1250,7 @@ public:
 
 	//! Enables or disables a virtual sound receiver (removes the sound receiver from audio processing)
 	/**
-	  * @param[in] iSoundReceiverID	SoundReceiver identifier
+	  * @param[in] iID	SoundReceiver identifier
 	  * @param[in] bEnabled		Enable (true) or disable (false) sound source
 	  *
 	  * @sa GetSoundReceiverEnabled()
@@ -1253,7 +1259,7 @@ public:
 
 	//! Returns sound receiver enabled/disabled status
 	/**
-	  * @param[in] iSoundReceiverID	SoundReceiver identifier
+	  * @param[in] iID	SoundReceiver identifier
 	  * @return				Enabled (true) or disabled (false)
 	  *
 	  * @sa SetSoundReceiverEnabled()
@@ -1280,7 +1286,7 @@ public:
 	  * This general parameter setter can be used for quick solutions changing
 	  * sound receiver parameters without introducing new methods to the main interface.
 	  *
-	  * @param[in] iSoundReceiverID SoundReceiver identifier
+	  * @param[in] iID SoundReceiver identifier
 	  * @param[in] oParams Magic struct with the parameters
 	  */
 	virtual void SetSoundReceiverParameters( const int iID, const CVAStruct& oParams ) = 0;
@@ -1290,8 +1296,8 @@ public:
 	  * This general parameter getter can be used for quick solutions retrieving
 	  * sound receiver parameters without introducing new methods to the main interface.
 	  *
-	  * @param[in] iSoundReceiverID SoundReceiver identifier
-	  * @param[in] oParams Magic struct with the parameters that are requested
+	  * @param[in] iID SoundReceiver identifier
+	  * @param[in] oArgs Magic struct with the parameters that are requested
 	  * @return Magic struct with the parameter values requested
 	  */
 	virtual CVAStruct GetSoundReceiverParameters( const int iID, const CVAStruct& oArgs ) const = 0;
@@ -1517,7 +1523,7 @@ public:
 	  * @param[in] sModuleID Module identifier
 	  * @param[in] dGain Gain
 	  *
-	  * @warn Setting gains will potentially penetrate a calibrated rendering and reproduction chain
+	  * @warning Setting gains will potentially penetrate a calibrated rendering and reproduction chain
 	  */
 	virtual void SetRenderingModuleGain( const std::string& sModuleID, const double dGain ) = 0;
 
@@ -1553,7 +1559,7 @@ public:
 	/**
 	  * @param[in] sModuleID Module identifier
 	  * @param[in] oParams Magic request parameters
-	  * @retirn Magic parameters
+	  * @return Magic parameters
 	  */
 	virtual CVAStruct GetRenderingModuleParameters( const std::string& sModuleID, const CVAStruct& oParams ) const = 0;
 
@@ -1584,7 +1590,7 @@ public:
 	  * @param[in] sModuleID Module identifier
 	  * @param[in] dGain Gain factor
 	  *
-	  * @warn Setting gains will potentially penetrate a calibrated rendering and reproduction chain
+	  * @warning Setting gains will potentially penetrate a calibrated rendering and reproduction chain
 	  */
 	virtual void SetReproductionModuleGain( const std::string& sModuleID, const double dGain ) = 0;
 
@@ -1606,7 +1612,7 @@ public:
 	/**
 	  * @param[in] sModuleID Module identifier
 	  * @param[in] oParams Magic request parameters
-	  * @retirn Magic parameters
+	  * @return Magic parameters
 	  */
 	virtual CVAStruct GetReproductionModuleParameters( const std::string& sModuleID, const CVAStruct& oParams ) const = 0;
 
@@ -1621,7 +1627,7 @@ public:
 	/**
 	  * @param[in] dGain Gain factor [0 .. 1]
 	  *
-	  * @warn Setting gains will potentially penetrate a calibrated rendering and reproduction chain
+	  * @warning Setting gains will potentially penetrate a calibrated rendering and reproduction chain
 	  */
 	virtual void SetInputGain( const double dGain ) = 0;
 	
@@ -1647,7 +1653,7 @@ public:
 	/**
 	  * @param[in] dGain Gain factor [0 .. 1]
 	  *
-	  * @warn Setting gains will potentially penetrate a calibrated rendering and reproduction chain
+	  * @warning Setting gains will potentially penetrate a calibrated rendering and reproduction chain
 	  */
 	virtual void SetOutputGain( const double dGain ) = 0;
 	
@@ -1659,9 +1665,8 @@ public:
 
 	//! Sets the global audio interface input gain
 	/**
-	  * @param[in] dGain Gain factor [0 .. 1]
+	  * @param[in] bMuted True to mute
 	  *
-	  * @warn Setting gains will potentially penetrate a calibrated rendering and reproduction chain
 	  */
 	virtual void SetOutputMuted( const bool bMuted = true ) = 0;
 

src/VACore.cpp

@@ -81,6 +81,7 @@ bool IVAInterface::AddSearchPath( const std::string& sPath )
 	return bPathFound;
 }
 
+/* moved to base
 bool IVAInterface::IsValidAuralizationMode( const int iAuralizationMode )
 {
 	return ( iAuralizationMode >= 0 ) && ( iAuralizationMode <= 2047 );
@@ -91,7 +92,7 @@ bool IVAInterface::IsValidVolume( const double dVolume )
 	return ( dVolume >= 0 );
 }
 
-bool IVAInterface::IsValidAudiofileSignalSourcePlaybackAction( const int iAction )
+bool IVAInterface::GetBufferSignalSourcePlaybackActionValid( const int iAction )
 {
 	if( iAction == IVAInterface::VA_PLAYBACK_ACTION_PAUSE )
 		return true;
@@ -102,6 +103,7 @@ bool IVAInterface::IsValidAudiofileSignalSourcePlaybackAction( const int iAction
 
 	return false;
 }
+*/
 
 std::string IVAInterface::GetLogLevelStr( const int iLogLevel )
 {