Skip to content
Snippets Groups Projects
Commit a04c14ee authored by Oliver Bock's avatar Oliver Bock
Browse files

Doxygen updates

parent c88e95cd
No related branches found
No related tags found
No related merge requests found
......@@ -19,7 +19,7 @@
class AbstractGraphicsEngine
{
public:
/// Default destructor
/// Destructor
virtual ~AbstractGraphicsEngine();
/**
......
......@@ -21,9 +21,9 @@ class EinsteinS5R3Adapter
{
public:
/**
* Constructor
* \brief Constructor
*
* \param boincClient Pointer to the general BOINC client adapter instance
* \param boincClient Pointer to the parent BOINC client adapter instance
*/
EinsteinS5R3Adapter(BOINCClientAdapter* boincClient);
......@@ -69,8 +69,18 @@ public:
double wuCPUTime() const;
private:
/**
* \brief Parses science application specific information into local attributes
*
* The information is usually transferred via a shared memory area
* which is handled by the parent generic BOINC client adapter.
*
* \see boincClient
*/
void parseApplicationInformation();
/// Pointer to the (parent) BOINC client adapter
BOINCClientAdapter *boincClient;
/// Right ascension of the currently searched sky position
......
......@@ -14,6 +14,7 @@
class GraphicsEngineFactory
{
public:
/// Destructor
virtual ~GraphicsEngineFactory();
/// Identifiers of supported graphics engines
......@@ -44,7 +45,7 @@ public:
static AbstractGraphicsEngine * createInstance(Engines engine, Applications application);
private:
// Contructor (private since this a purely static factory)
/// Contructor (private since this a purely static factory)
GraphicsEngineFactory();
};
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment