Formatting, Doxygen, Renaming

This commit is contained in:
Klaus Basan
2014-01-25 01:56:37 +01:00
parent dd3803f9a9
commit ee5336e308
3 changed files with 13 additions and 28 deletions

View File

@@ -17,7 +17,7 @@ namespace BlackCore
/* /*
* Init this context * Init this context
*/ */
CContextSettings::CContextSettings(CCoreRuntime *parent) : IContextSettings(parent), m_settingsNetwork() CContextSettings::CContextSettings(CCoreRuntime *runtime) : IContextSettings(runtime), m_settingsNetwork()
{ {
// create some dummy settings // create some dummy settings
// this would actually be reading the settings from disk .. // this would actually be reading the settings from disk ..

View File

@@ -31,9 +31,9 @@ namespace BlackCore
/*! /*!
* Context * Context
* \param parent * \param runtime
*/ */
CContextSettings(CCoreRuntime *parent); CContextSettings(CCoreRuntime *runtime);
/*! /*!
* Destructor * Destructor
@@ -60,16 +60,12 @@ namespace BlackCore
public slots: public slots:
/*! /*!
* \brief Network settings * \copydoc IContextSettings::getNetworkSettings()
* \return
*/ */
virtual BlackMisc::Settings::CSettingsNetwork getNetworkSettings() const; virtual BlackMisc::Settings::CSettingsNetwork getNetworkSettings() const;
/*! /*!
* \brief Validate * \copydoc IContextSettings::value()
* \param path
* \param value
* \return
*/ */
virtual BlackMisc::CStatusMessageList value(const QString &path, const QString &command, const QVariant &value); virtual BlackMisc::CStatusMessageList value(const QString &path, const QString &command, const QVariant &value);

View File

@@ -35,7 +35,6 @@ namespace BlackCore
/*! /*!
* \brief Service name * \brief Service name
* \return
*/ */
static const QString &InterfaceName() static const QString &InterfaceName()
{ {
@@ -45,7 +44,6 @@ namespace BlackCore
/*! /*!
* \brief Service path * \brief Service path
* \return
*/ */
static const QString &ServicePath() static const QString &ServicePath()
{ {
@@ -54,8 +52,8 @@ namespace BlackCore
} }
/*! /*!
* \brief Path * \brief Path for network settings
* \return * \remark no to be confused with DBus paths
*/ */
static const QString &PathNetworkSettings() static const QString &PathNetworkSettings()
{ {
@@ -65,11 +63,8 @@ namespace BlackCore
/*! /*!
* \brief DBus version constructor * \brief DBus version constructor
* \param serviceName
* \param connection
* \param parent
*/ */
IContextSettings(const QString &serviceName, QDBusConnection &connection, QObject *parent = 0); IContextSettings(const QString &serviceName, QDBusConnection &connection, QObject *parent = nullptr);
/*! /*!
* Destructor * Destructor
@@ -104,30 +99,24 @@ namespace BlackCore
/*! /*!
* \brief Network settings * \brief Network settings
* \return
*/ */
virtual BlackMisc::Settings::CSettingsNetwork getNetworkSettings() const; virtual BlackMisc::Settings::CSettingsNetwork getNetworkSettings() const;
/*! /*!
* \brief Handle value * \brief Handle value
* \param path * \param path where value belongs to
* \param command * \param command what to do with value
* \param value * \param value
* \return * \return messages generated during handling
*/ */
virtual BlackMisc::CStatusMessageList value(const QString &path, const QString &command, const QVariant &value); virtual BlackMisc::CStatusMessageList value(const QString &path, const QString &command, const QVariant &value);
/*! /*!
* Basically an unwanted signature as this is different from the "local" signature and * \brief DBus version of value method.
* \remarks Basically an unwanted signature as this is different from the "local" signature and
* contains explicit DBus types (a: QDbusArgument, b: type for conversion). * contains explicit DBus types (a: QDbusArgument, b: type for conversion).
* If this can be removed, fine. * If this can be removed, fine.
* *
* \brief value
* \param path
* \param command
* \param value
* \param unifiedBlackMetaType
* \return
*/ */
virtual BlackMisc::CStatusMessageList value(const QString &path, const QString &command, QDBusVariant value, int unifiedBlackMetaType); virtual BlackMisc::CStatusMessageList value(const QString &path, const QString &command, QDBusVariant value, int unifiedBlackMetaType);
}; };