Commit 2a94fd9a authored by wiebel's avatar wiebel

[CHANGE] fixed some typos and added some consts

parent de7a9362
......@@ -28,7 +28,7 @@
/**
* \par Description:
* Base class for alle classes needing to be executed in a separate thread.
* Base class for all classes needing to be executed in a separate thread.
*/
class WThreadedRunner
{
......
......@@ -33,7 +33,7 @@
#include "../graphicsEngine/WGraphicsEngine.h"
/**
/**
* \par Description
* Used for program wide access to the kernel.
*/
......@@ -73,17 +73,17 @@ WKernel* WKernel::getRunningKernel()
return kernel;
}
boost::shared_ptr<WGraphicsEngine> WKernel::getGraphicsEngine()
boost::shared_ptr<WGraphicsEngine> WKernel::getGraphicsEngine() const
{
return m_GraphicsEngine;
}
int WKernel::getArgumentCount()
int WKernel::getArgumentCount() const
{
return m_ArgC;
}
char** WKernel::getArguments()
char** WKernel::getArguments() const
{
return m_ArgV;
}
......@@ -156,7 +156,7 @@ void WKernel::init()
m_Gui = boost::shared_ptr<WMainApplication>( new WMainApplication() );
}
bool WKernel::isFinishRequested()
bool WKernel::isFinishRequested() const
{
return m_FinishRequested;
}
......
......@@ -62,7 +62,7 @@ public:
*/
WKernel( const WKernel& other );
/**
/**
* \par Description
* Starts execution.
*
......@@ -70,45 +70,45 @@ public:
*/
int run();
/**
/**
* \par Description
* Returns pointer to currently running instance of graphics engine.
*
*
* \return the ge instance.
*/
boost::shared_ptr<WGraphicsEngine> getGraphicsEngine();
boost::shared_ptr<WGraphicsEngine> getGraphicsEngine() const;
/**
/**
* \par Description
* Returns pointer to the currently running kernel.
*
*
* \return the kernel instance.
*/
static WKernel* getRunningKernel();
/**
/**
* \par Description
* Returns argument count.
*
*
* \return argument count.
*/
int getArgumentCount();
int getArgumentCount() const;
/**
/**
* \par Description
* Returns argument array specified to the app.
*
*
* \return the argument array.
*/
char** getArguments();
char** getArguments() const;
/**
/**
* \par Description
* Determines whether all threads should finish.
*
*
* \return true if so.
*/
bool isFinishRequested();
bool isFinishRequested() const ;
protected:
......@@ -124,7 +124,7 @@ protected:
*/
boost::shared_ptr<WGraphicsEngine> m_GraphicsEngine;
/**
/**
* \par Description
* The Gui.
*/
......@@ -143,19 +143,19 @@ private:
*/
void init();
/**
/**
* \par Description
* Number of arguments given to application.
*/
int m_ArgC;
/**
* \par Description
/**
* \par Description
* Arguments given to application
*/
char** m_ArgV;
/**
/**
* \par Description
* true if threads should finish.
*/
......
......@@ -41,12 +41,12 @@ WModule::WModule( const WModule& other )
*this = other;
}
std::string WModule::getName() const
const std::string WModule::getName() const
{
return "WModule";
}
std::string WModule::getDescription() const
const std::string WModule::getDescription() const
{
return "Plain module without functionality";
}
......
......@@ -36,8 +36,8 @@ class WModule: public WThreadedRunner
{
public:
/**
* \par Description
/**
* \par Description
* Constructs a new WModule instance
*/
WModule();
......@@ -55,23 +55,23 @@ public:
*/
WModule( const WModule& other );
/**
* \par Description
* Gives back the name of this module.
/**
* \par Description
* Gives back the name of this module.
* \return the module's name.
*/
virtual std::string getName() const;
virtual const std::string getName() const;
/**
* \par Description
* Gives bach a description of this module.
/**
* \par Description
* Gives back a description of this module.
* \return description to module.
*/
virtual std::string getDescription() const;
virtual const std::string getDescription() const;
protected:
/**
/**
* \par Description
* Entry point after loading the module. Runs in separate thread.
*/
......
......@@ -47,12 +47,12 @@ WTestModule::WTestModule( const WTestModule& other )
*this = other;
}
std::string WTestModule::getName() const
const std::string WTestModule::getName() const
{
return "Test Module";
}
std::string WTestModule::getDescription() const
const std::string WTestModule::getDescription() const
{
return "This module is for testing and development";
}
......
......@@ -60,14 +60,14 @@ public:
* Gives back the name of this module.
* \return the module's name.
*/
virtual std::string getName() const;
virtual const std::string getName() const;
/**
* \par Description
* Gives bach a description of this module.
* Gives back a description of this module.
* \return description to module.
*/
virtual std::string getDescription() const;
virtual const std::string getDescription() const;
protected:
......
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