From a04c14eebe83c52b773f960e39d87f27b36815d7 Mon Sep 17 00:00:00 2001
From: Oliver Bock <oliver.bock@aei.mpg.de>
Date: Fri, 11 Apr 2008 17:21:14 +0200
Subject: [PATCH] Doxygen updates
---
AbstractGraphicsEngine.h | 2 +-
EinsteinS5R3Adapter.h | 14 ++++++++++++--
GraphicsEngineFactory.h | 3 ++-
3 files changed, 15 insertions(+), 4 deletions(-)
diff --git a/AbstractGraphicsEngine.h b/AbstractGraphicsEngine.h
index 7bf88f7..eee066b 100644
--- a/AbstractGraphicsEngine.h
+++ b/AbstractGraphicsEngine.h
@@ -19,7 +19,7 @@
class AbstractGraphicsEngine
{
public:
- /// Default destructor
+ /// Destructor
virtual ~AbstractGraphicsEngine();
/**
diff --git a/EinsteinS5R3Adapter.h b/EinsteinS5R3Adapter.h
index f7e0d0b..0b83864 100644
--- a/EinsteinS5R3Adapter.h
+++ b/EinsteinS5R3Adapter.h
@@ -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
diff --git a/GraphicsEngineFactory.h b/GraphicsEngineFactory.h
index 14c5fcb..9e289a0 100644
--- a/GraphicsEngineFactory.h
+++ b/GraphicsEngineFactory.h
@@ -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();
};
--
GitLab