Applied doxy fixes

parent c346e2a1
......@@ -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
......
......@@ -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;
......
......@@ -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 )
......
This diff is collapsed.
......@@ -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 )
{
......
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