From 1332489391d618dc91c282cad6e63437db8ab858 Mon Sep 17 00:00:00 2001
From: Lipu Fei <lipu.fei815@gmail.com>
Date: Tue, 22 Aug 2017 10:42:31 +0200
Subject: [PATCH] Add comments for upgradeMachineStack()

CURA-4188
---
 .../VersionUpgrade25to26/VersionUpgrade25to26.py              | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/plugins/VersionUpgrade/VersionUpgrade25to26/VersionUpgrade25to26.py b/plugins/VersionUpgrade/VersionUpgrade25to26/VersionUpgrade25to26.py
index 9c02d0387e..d270d0f2b7 100644
--- a/plugins/VersionUpgrade/VersionUpgrade25to26/VersionUpgrade25to26.py
+++ b/plugins/VersionUpgrade/VersionUpgrade25to26/VersionUpgrade25to26.py
@@ -114,6 +114,10 @@ class VersionUpgrade25to26(VersionUpgrade):
         parser.write(output)
         return [filename], [output.getvalue()]
 
+    ##  Upgrades a machine stack from version 2.5 to 2.6
+    #
+    #   \param serialised The serialised form of a quality profile.
+    #   \param filename The name of the file to upgrade.
     def upgradeMachineStack(self, serialised, filename):
         parser = configparser.ConfigParser(interpolation=None)
         parser.read_string(serialised)