Refs #1579. Adding documentation for function.

mantidproject · May 17, 2013 · d9eaf8f · d9eaf8f
1 parent b987e72
commit d9eaf8f
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/Code/Mantid/MantidPlot/src/ApplicationWindow.cpp b/Code/Mantid/MantidPlot/src/ApplicationWindow.cpp
@@ -248,6 +248,13 @@ m_exitCode(0), g_log(Mantid::Kernel::Logger::get("ApplicationWindow")),
   init(factorySettings, args);
 }
 
+/**
+ * This function is responsible for copying the old configuration
+ * information from the ISIS\MantidPlot area to the new Mantid\MantidPlot
+ * area. The old area is deleted once the trnasfer is complete. On subsequent
+ * runs, if the old configuration area is missing or empty, the copying
+ * is ignored.
+ */
 void ApplicationWindow::handleConfigDir()
 {
 #ifdef Q_OS_WIN