More doxy comments

parent 7eb57640
......@@ -121,13 +121,22 @@ public:
//! Returns the core version
/**
* @param [out] pVersionInfo Core version information
*/
virtual void GetVersionInfo( CVAVersionInfo* pVersionInfo ) const = 0;
//! Set the output stream for debug messages
/**
* @param [in] posDebug Debug output stream
*/
virtual void SetDebugStream( std::ostream* posDebug ) = 0;
//! Returns the state of the core
/**
* @return Core state
*/
virtual int GetState() const = 0;
//! Initializes the core
......@@ -167,22 +176,24 @@ public:
//! Full reset of the core. Clears all scene objects, resources, etc.
/**
* TODO Detailled documentation
* Clear all scenes, removes sound entities, resets states and medium values
*/
virtual void Reset() = 0;
//! Attaches a handler for core events to the core instance
/**
* @oaram[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,
* also before initialization and after finalization.
*/
virtual void AttachEventHandler( IVAEventHandler* pCoreEventHandler ) = 0;
virtual void AttachEventHandler( IVAEventHandler* pEventHandler ) = 0;
//! Detaches a handler for core events from the core instance
/**
* @oaram[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,
......@@ -191,13 +202,26 @@ public:
* \note When the method returns, it is guaranteed that the handler will not
* receive any further core events and may safely be destroyed.
*/
virtual void DetachEventHandler( IVAEventHandler* pCoreEventHandler ) = 0;
virtual void DetachEventHandler( IVAEventHandler* pEventHandler ) = 0;
//! Get all registered modules of the core
/**
* @param[out] voModuleInfos Vector with module infos
*/
virtual void GetModules( std::vector< CVAModuleInfo >& voModuleInfos ) const = 0;
//! Calls a module and returns the answer
/**
* This method is useful for prototyping. There is no general documentation possible. Special calls have to be extracted from C++ code
* in core. It is recommended to implement at least a help text that will be returned if the 'help' or 'info' key is set to any value.
* Also, a true-valued 'verbose' key flag should activate verbose return or output on debug stream.
*
* @param[in] sModuleName Full qualifier of module identifier (may include ':' separator)
* @param[in] oArgs Magic struct that is interpreted by module
*
* @return Magic return struct
*/
virtual CVAStruct CallModule( const std::string& sModuleName, const CVAStruct& oArgs ) = 0;
......
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