Update documentation and rename code to improve readability.

Change-Id: I5b467aca314f81304f7a4854cb6ea5b4f57361f3
Reviewed-by: Kai Koehne <kai.koehne@digia.com>

1 files changed, 10 insertions, 8 deletions

diff --git a/tools/binarycreator/binarycreator.cpp b/tools/binarycreator/binarycreator.cpp
index a50ff7a45..9263d13d0 100644
--- a/tools/binarycreator/binarycreator.cpp
+++ b/tools/binarycreator/binarycreator.cpp
@@ -66,7 +66,7 @@ using namespace QInstallerCreator;
 struct Input {
     QString outputPath;
     QString installerExePath;
-    ComponentIndex components;
+    ComponentIndex componentIndex;
     QString binaryResourcePath;
     QStringList binaryResources;
 
@@ -308,17 +308,19 @@ static int assemble(Input input, const QInstaller::Settings &settings)
                 .moved(-dataBlockStart));
         }
 
-        // zero operations cause we are not the uninstaller
+        // zero operations cause we are not the maintenance tool
         const qint64 operationsStart = out.pos();
-        QInstaller::appendInt64(&out, 0);
-        QInstaller::appendInt64(&out, 0);
+        QInstaller::appendInt64(&out, 0);   // operation count
+        QInstaller::appendInt64(&out, 0);   // operation count
         input.operationsPos = Range<qint64>::fromStartAndEnd(operationsStart, out.pos())
             .moved(-dataBlockStart);
 
-        // component index:
-        input.components.writeComponentData(&out, -dataBlockStart);
+        // write out every components data
+        input.componentIndex.writeComponentData(&out, -dataBlockStart);
         const qint64 compIndexStart = out.pos() - dataBlockStart;
-        input.components.writeIndex(&out, -dataBlockStart);
+
+        // write out the component index
+        input.componentIndex.writeIndex(&out, -dataBlockStart);
         input.componentIndexSegment = Range<qint64>::fromStartAndEnd(compIndexStart, out.pos()
             - dataBlockStart);
 
@@ -773,7 +775,7 @@ int main(int argc, char **argv)
                         humanReadableSize(arch->size()));
                     comp.appendArchive(arch);
                 }
-                input.components.insertComponent(comp);
+                input.componentIndex.insertComponent(comp);
             }
 
             qDebug() << "Creating the binary";