Formatting, Doxygen, Renaming

src/blackcore/context_settings.cpp

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

src/blackcore/context_settings.h

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

src/blackcore/context_settings_interface.h

@@ -35,7 +35,6 @@ namespace BlackCore
 
         /*!
          * \brief Service name
-         * \return
          */
         static const QString &InterfaceName()
         {
@@ -45,7 +44,6 @@ namespace BlackCore
 
         /*!
          * \brief Service path
-         * \return
          */
         static const QString &ServicePath()
         {
@@ -54,8 +52,8 @@ namespace BlackCore
         }
 
         /*!
-         * \brief Path
-         * \return
+         * \brief Path for network settings
+         * \remark no to be confused with DBus paths
          */
         static const QString &PathNetworkSettings()
         {
@@ -65,11 +63,8 @@ namespace BlackCore
 
         /*!
          * \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
@@ -104,30 +99,24 @@ namespace BlackCore
 
         /*!
          * \brief Network settings
-         * \return
          */
         virtual BlackMisc::Settings::CSettingsNetwork getNetworkSettings() const;
 
         /*!
          * \brief Handle value
-         * \param path
-         * \param command
+         * \param path      where value belongs to
+         * \param command   what to do with value
          * \param value
-         * \return
+         * \return          messages generated during handling
          */
         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).
          * 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);
     };