Commit d63159b2 authored by Dipl.-Ing. Jonas Stienen's avatar Dipl.-Ing. Jonas Stienen
Browse files

Comments for Doxygen, and minor interface change

parent 10a3c3ed
......@@ -28,15 +28,22 @@ namespace VACore
{
//! Factory method - creates a VACore instance
/**
* @input oArgs Arguments with configuration for the core
* @output Pointer to the core instance (VA interface API from VABase)
* @param[in] oArgs Arguments with configuration for the core
* @return Pointer to the core instance (VA interface API from VABase)
*/
VACORE_API IVAInterface* CreateCoreInstance( const CVAStruct& oArgs );
//! Factore method - create a VACore instance with configuration file
/**
* @param[in] sConfigFile Configuration file, or default file
* @return Pointer to the core instance (VA interface API from VABase)
*/
VACORE_API IVAInterface* CreateCoreInstance( const std::string& sConfigFile = VACORE_DEFAULT_CONFIGFILE );
//! Returns the filesystem path of the VACore shared lib (e.g. VACore.dll)
/**
* @return Core library path
*/
VACORE_API std::string GetCoreLibFilePath();
} // End of namespace "VACore"
......
......@@ -35,6 +35,8 @@ public:
//! Create a network signal source (not connected)
CVANetworkStreamAudioSignalSource();
//! Destructor
virtual ~CVANetworkStreamAudioSignalSource();
//! Start to listen on server socket
......
......@@ -42,21 +42,21 @@ class IVAPoolObjectFactory;
* objects without a standard constructor can be used. Use the default factory
* template class to create objects throughout it's standard constructor.
*
* \note Not thread safe, thread safety has to be provided by user
* @note Not thread safe, thread safety has to be provided by user
*/
class VACORE_API IVAObjectPool : public IVAUncopyable
{
public:
//! Factory method
/**
* \param iInitialSize Initial size of pool / number of objects
* \param iDelta Indicator for allocation/deallocation of objects
* \param pFactory Factory method of pool objects
* \param bDeleteFactory Set true if destructor available
* @param[in] iInitialSize Initial size of pool / number of objects
* @param[in] iDelta Indicator for allocation/deallocation of objects
* @param[in] pFactory Factory method of pool objects
* @param[in] bDeleteFactory Set true if destructor available
*
* \return Pointer to the newly created pool of unused objects
* @return Pointer to the newly created pool of unused objects
*/
static IVAObjectPool* Create( int iInitialSize, int iDelta, IVAPoolObjectFactory* pFactory, bool bDeleteFactory );
static IVAObjectPool* Create( const int iInitialSize, const int iDelta, IVAPoolObjectFactory* pFactory, const bool bDeleteFactory );
//! Destructor
virtual ~IVAObjectPool() {};
......@@ -64,6 +64,8 @@ public:
//! Name setter
/**
* Set name of the pool (for debugging purposes only)
*
* @param[in] sName Verbatim name
*/
virtual void SetName( const std::string& sName ) = 0;
......@@ -76,35 +78,35 @@ public:
//! Number of free object slots
/**
* \return Number of free objects that can be requested
* @return Number of free objects that can be requested
*/
virtual int GetNumFree() const = 0;
//! Number of used object slots
/**
* \return Number of used objects that can be requested
* @return Number of used objects that can be requested
*/
virtual int GetNumUsed() const = 0;
//! Pool size getter
/**
* \return Number of available slots for objects
* @return Number of available slots for objects
*/
virtual int GetSize() const = 0;
//! Increase pool size
/**
* \param iDelta Number of slots to be allocated
* @param[in] iDelta Number of slots to be allocated
*
* \param Returns number of created object slots (iDelta)
* @return Returns number of created object slots (iDelta)
*/
virtual int Grow( int iDelta ) = 0;
virtual int Grow( const int iDelta ) = 0;
//! Request a free object slot in pool
/**
* Sets the refernce counter of the pool object to 1.
*
* \return Pointer to the new object
* @return Pointer to the new object
*/
virtual CVAPoolObject* RequestObject() = 0;
......@@ -112,6 +114,7 @@ protected:
//! Release-Hook (used by IVAPoolObject implementations)
/**
* Releases object to the pool if no reference available anymore
* @param[in] pObject Object pointer
*/
virtual void ReleaseObject( CVAPoolObject* pObject ) = 0;
......
......@@ -41,7 +41,7 @@ public:
* \param pFactory Factory zur Erzeugung der Pool-Objekte
* \param bDeleteFactory bergebene Factory im Destruktor freigeben?
*/
CVAObjectPool( int iInitialSize, int iDelta, IVAPoolObjectFactory* pFactory, bool bDeleteFactory );
CVAObjectPool( const int iInitialSize, const int iDelta, IVAPoolObjectFactory* pFactory, const bool bDeleteFactory );
// Destruktor
virtual ~CVAObjectPool();
......@@ -63,7 +63,7 @@ public:
// Anzahl der (freien) Objekte vergrern
// (Rckgabe: Anzahl der erzeugten Elemente)
int Grow( int iDelta );
int Grow( const int iDelta );
// Freies Objekt anfordern.
// (Setzt den Referenzzhler des Objektes auf 1)
......
Supports Markdown
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