diff --git a/AbstractGraphicsEngine.h b/AbstractGraphicsEngine.h index 7bf88f708e9b2afe64d5193b679907657c15b72c..eee066beac83e5c2748b2d89b3621a5d9366bf96 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 f7e0d0bacf9db83e5a72a0c28b0149009880b20a..0b838649afad88cf8b4fa272dd51740f9128049f 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 14c5fcb72fefb0b9a948c6bb288e49ae71d57aa9..9e289a0da4c1c5b873b0394b53f8df1a16e99c6a 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(); };