Documentation updates and fixes.

Change-Id: Ie9fc9e1c2a0b84082cb48732e270913bc90d9a79
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>

1 files changed, 8 insertions, 2 deletions

diff --git a/src/libs/installer/binaryformatengine.cpp b/src/libs/installer/binaryformatengine.cpp
index c413ffdb6..2d70bbe77 100644
--- a/src/libs/installer/binaryformatengine.cpp
+++ b/src/libs/installer/binaryformatengine.cpp
@@ -80,6 +80,9 @@ namespace QInstaller {
         collections and resource files.
 */
 
+/*!
+    Constructs a new binary format engine with \a collections and \a fileName.
+*/
 BinaryFormatEngine::BinaryFormatEngine(const QHash<QByteArray, ResourceCollection> &collections,
         const QString &fileName)
     : m_resource(0)
@@ -90,6 +93,9 @@ BinaryFormatEngine::BinaryFormatEngine(const QHash<QByteArray, ResourceCollectio
 
 /*!
     \internal
+
+    Sets the file engine's file name to \a file. This is the file that the rest of the virtual
+    functions will operate on.
 */
 void BinaryFormatEngine::setFileName(const QString &file)
 {
@@ -97,10 +103,10 @@ void BinaryFormatEngine::setFileName(const QString &file)
 
     static const QChar sep = QLatin1Char('/');
     static const QString prefix = QLatin1String("installer://");
-    Q_ASSERT(file.toLower().startsWith(prefix));
+    Q_ASSERT(m_fileNamePath.toLower().startsWith(prefix));
 
     // cut the prefix
-    QString path = file.mid(prefix.length());
+    QString path = m_fileNamePath.mid(prefix.length());
     while (path.endsWith(sep))
         path.chop(1);