Some more documentation fixes (removes more warnings).

Change-Id: I1efb7f98ac4cccdc4dbd1784806cce286654af9f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>

7 files changed, 50 insertions, 46 deletions

diff --git a/doc/installerfw-cpp-classes.qdoc b/doc/installerfw-cpp-classes.qdoc
index 726ced3e3..29f1bfc44 100644
--- a/doc/installerfw-cpp-classes.qdoc
+++ b/doc/installerfw-cpp-classes.qdoc
@@ -27,7 +27,7 @@
 
 /*!
     \contentspage {index.html}{Qt Installer Framework}
-    \previouspage scripting-qmlmodule.html
+    \previouspage Scripting
     \page ifw-cpp-classes.html
     \nextpage ifw-knownissues.html
 
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 502631acb..fb4fa606b 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -570,7 +570,7 @@
     \contentspage index.html
     \previouspage operations.html
     \page ifw-tools.html
-    \nextpage ifw-cpp-classes.html
+    \nextpage Scripting
 
     \title Tools
 
@@ -1052,6 +1052,7 @@
     \contentspage index.html
     \previouspage ifw-cpp-classes.html
     \page ifw-knownissues.html
+    \nextpage index.html
 
     \title Known Issues
 
diff --git a/src/libs/installer/fileutils.cpp b/src/libs/installer/fileutils.cpp
index 4708e5602..cd546fa6f 100644
--- a/src/libs/installer/fileutils.cpp
+++ b/src/libs/installer/fileutils.cpp
@@ -238,9 +238,6 @@ void QInstaller::removeDirectory(const QString &path, bool ignoreErrors)
     }
 }
 
-/*!
- \internal
- */
 class RemoveDirectoryThread : public QThread
 {
 public:
diff --git a/src/libs/installer/packagemanagercore.cpp b/src/libs/installer/packagemanagercore.cpp
index 9fb911161..f0f3430c5 100644
--- a/src/libs/installer/packagemanagercore.cpp
+++ b/src/libs/installer/packagemanagercore.cpp
@@ -1105,20 +1105,20 @@ void PackageManagerCore::appendRootComponent(Component *component)
 }
 
 /*!
-    \enum PackageManagerCore::ComponentType
-
-    This enum is used with components() to describe what type of \C Component list this function
-    should return.
+    \class PackageManagerCore::ComponentType
+    \inmodule QtInstallerFramework
+    \brief The ComponentType class is used with components() to describe what type of \c Component
+        list this function should return.
 
     \value Root
         Return a list of root components.
 
     \value Descendants
-        Return a list of all descendant components. \note In updater mode the list is empty,
+        Return a list of all descendant components. \b Note: In updater mode the list is empty,
         because component updates cannot have children.
 
     \value Dependencies
-        Return a list of all available dependencies when run as updater. \note In Installer,
+        Return a list of all available dependencies when run as updater. \b Note: In Installer,
         package manager and uninstaller mode, this will always result in an empty list.
 
     \value Replacements
diff --git a/src/libs/installer/remotefileengine.cpp b/src/libs/installer/remotefileengine.cpp
index 02469be34..7feff87c0 100644
--- a/src/libs/installer/remotefileengine.cpp
+++ b/src/libs/installer/remotefileengine.cpp
@@ -79,43 +79,49 @@ public:
     RemoteFileEngineIterator(QDir::Filters filters, const QStringList &nameFilters,
             const QStringList &files)
         : QAbstractFileEngineIterator(filters, nameFilters)
-        , entries(files)
         , index(-1)
+        , entries(files)
     {
     }
 
-    /*!
-        \reimp
-    */
-    bool hasNext() const
-    {
-        return index < entries.size() - 1;
-    }
-
-    /*!
-        \reimp
-    */
-    QString next()
-    {
-       if (!hasNext())
-           return QString();
-       ++index;
-       return currentFilePath();
-    }
-
-    /*!
-        \reimp
-    */
-    QString currentFileName() const
-    {
-        return entries.at(index);
-    }
+    QString next();
+    bool hasNext() const;
+    QString currentFileName() const;
 
 private:
-    const QStringList entries;
     int index;
+    QStringList entries;
 };
 
+/*!
+    Advances the iterator to the next entry, and returns the current file path of this new
+    entry. If hasNext() returns \c false, the function does nothing and returns an empty QString.
+*/
+bool RemoteFileEngineIterator::hasNext() const
+{
+    return index < entries.size() - 1;
+}
+
+/*!
+    Returns \c true if there is at least one more entry in the directory, otherwise returns
+    \c false.
+*/
+QString RemoteFileEngineIterator::next()
+{
+    if (!hasNext())
+        return QString();
+    ++index;
+    return currentFilePath();
+}
+
+/*!
+    Returns the name of the current directory entry, excluding the path.
+*/
+QString RemoteFileEngineIterator::currentFileName() const
+{
+    return entries.at(index);
+}
+
 
 // -- RemoteFileEngine
 
diff --git a/src/libs/installer/scriptengine.cpp b/src/libs/installer/scriptengine.cpp
index e51bbb3c2..27c58b13b 100644
--- a/src/libs/installer/scriptengine.cpp
+++ b/src/libs/installer/scriptengine.cpp
@@ -52,6 +52,12 @@
 namespace QInstaller {
 
 /*!
+    \class QInstaller::ScriptEngine
+    \inmodule QtInstallerFramework
+    \brief The ScriptEngine class is used to prepare and run the component scripts.
+*/
+
+/*!
     \qmltype console
     \inqmlmodule scripting
     \brief The console type provides methods for logging and debugging.
@@ -245,12 +251,6 @@ namespace QInstaller {
 */
 
 /*!
-    \class QInstaller::ScriptEngine
-    \inmodule QtInstallerFramework
-    \brief The ScriptEngine class is used to prepare and run the component scripts.
-*/
-
-/*!
     Constructs a script engine with \a core as parent.
 */
 ScriptEngine::ScriptEngine(PackageManagerCore *core)
diff --git a/src/libs/installer/scriptengine.h b/src/libs/installer/scriptengine.h
index 0c5a70bfa..ac9101c17 100644
--- a/src/libs/installer/scriptengine.h
+++ b/src/libs/installer/scriptengine.h
@@ -42,7 +42,7 @@
 #ifndef SCRIPTENGINE_H
 #define SCRIPTENGINE_H
 
-#include "qinstallerglobal.h"
+#include "installer_global.h"
 
 #include <QJSValue>
 #include <QJSEngine>