From e0a8d931fc12604ec72d7dc0169c1040eebc6546 Mon Sep 17 00:00:00 2001
From: Dentomologist <dentomologist@gmail.com>
Date: Fri, 12 Mar 2021 17:10:53 -0800
Subject: Updater: Add code documentation Markdown file

Add docs/autoupdate_overview.md which gives an overview of the update
process, and comments pointing to it in autoupdate related files.
---
 Source/Core/DolphinQt/Updater.cpp           | 2 ++
 Source/Core/DolphinQt/Updater.h             | 2 ++
 Source/Core/MacUpdater/AppDelegate.mm       | 8 ++++++--
 Source/Core/MacUpdater/main.m               | 2 ++
 Source/Core/UICommon/AutoUpdate.cpp         | 2 ++
 Source/Core/UICommon/AutoUpdate.h           | 2 ++
 Source/Core/UpdaterCommon/UpdaterCommon.cpp | 2 ++
 Source/Core/UpdaterCommon/UpdaterCommon.h   | 2 ++
 Source/Core/WinUpdater/Main.cpp             | 2 ++
 9 files changed, 22 insertions(+), 2 deletions(-)

(limited to 'Source/Core')

diff --git a/Source/Core/DolphinQt/Updater.cpp b/Source/Core/DolphinQt/Updater.cpp
index fa13d9a961..88294c12ff 100644
--- a/Source/Core/DolphinQt/Updater.cpp
+++ b/Source/Core/DolphinQt/Updater.cpp
@@ -17,6 +17,8 @@
 #include "DolphinQt/QtUtils/RunOnObject.h"
 #include "DolphinQt/Settings.h"
 
+// Refer to docs/autoupdate_overview.md for a detailed overview of the autoupdate process
+
 Updater::Updater(QWidget* parent) : m_parent(parent)
 {
   connect(this, &QThread::finished, this, &QObject::deleteLater);
diff --git a/Source/Core/DolphinQt/Updater.h b/Source/Core/DolphinQt/Updater.h
index 462424ea89..13125e2ce4 100644
--- a/Source/Core/DolphinQt/Updater.h
+++ b/Source/Core/DolphinQt/Updater.h
@@ -8,6 +8,8 @@
 
 #include "UICommon/AutoUpdate.h"
 
+// Refer to docs/autoupdate_overview.md for a detailed overview of the autoupdate process
+
 class QWidget;
 
 class Updater : public QThread, public AutoUpdateChecker
diff --git a/Source/Core/MacUpdater/AppDelegate.mm b/Source/Core/MacUpdater/AppDelegate.mm
index 95b03322a0..a61ebdc7d0 100644
--- a/Source/Core/MacUpdater/AppDelegate.mm
+++ b/Source/Core/MacUpdater/AppDelegate.mm
@@ -10,13 +10,16 @@
 #include <string>
 #include <vector>
 
+// Refer to docs/autoupdate_overview.md for a detailed overview of the autoupdate process
+
 @interface AppDelegate ()
 
 @end
 
 @implementation AppDelegate
 
-- (void)applicationDidFinishLaunching:(NSNotification*)aNotification {
+- (void)applicationDidFinishLaunching:(NSNotification*)aNotification
+{
   NSArray* arguments = [[NSProcessInfo processInfo] arguments];
 
   __block std::vector<std::string> args;
@@ -32,7 +35,8 @@
   });
 }
 
-- (void)applicationWillTerminate:(NSNotification*)aNotification {
+- (void)applicationWillTerminate:(NSNotification*)aNotification
+{
 }
 
 @end
diff --git a/Source/Core/MacUpdater/main.m b/Source/Core/MacUpdater/main.m
index b2e372139f..f027f1b00d 100644
--- a/Source/Core/MacUpdater/main.m
+++ b/Source/Core/MacUpdater/main.m
@@ -4,6 +4,8 @@
 
 #include <Cocoa/Cocoa.h>
 
+// Refer to docs/autoupdate_overview.md for a detailed overview of the autoupdate process
+
 int main(int argc, const char** argv)
 {
   if (argc == 1)
diff --git a/Source/Core/UICommon/AutoUpdate.cpp b/Source/Core/UICommon/AutoUpdate.cpp
index 5ad5e38495..846c9deb0f 100644
--- a/Source/Core/UICommon/AutoUpdate.cpp
+++ b/Source/Core/UICommon/AutoUpdate.cpp
@@ -29,6 +29,8 @@
 #define OS_SUPPORTS_UPDATER
 #endif
 
+// Refer to docs/autoupdate_overview.md for a detailed overview of the autoupdate process
+
 namespace
 {
 bool s_update_triggered = false;
diff --git a/Source/Core/UICommon/AutoUpdate.h b/Source/Core/UICommon/AutoUpdate.h
index 7c75100433..a712584db8 100644
--- a/Source/Core/UICommon/AutoUpdate.h
+++ b/Source/Core/UICommon/AutoUpdate.h
@@ -6,6 +6,8 @@
 
 #include <string>
 
+// Refer to docs/autoupdate_overview.md for a detailed overview of the autoupdate process
+
 // This class defines all the logic for Dolphin auto-update checking. UI-specific elements have to
 // be defined in a backend specific subclass.
 class AutoUpdateChecker
diff --git a/Source/Core/UpdaterCommon/UpdaterCommon.cpp b/Source/Core/UpdaterCommon/UpdaterCommon.cpp
index 7eadf14a19..f52755aeb5 100644
--- a/Source/Core/UpdaterCommon/UpdaterCommon.cpp
+++ b/Source/Core/UpdaterCommon/UpdaterCommon.cpp
@@ -25,6 +25,8 @@
 #include <sys/types.h>
 #endif
 
+// Refer to docs/autoupdate_overview.md for a detailed overview of the autoupdate process
+
 namespace
 {
 // Where to log updater output.
diff --git a/Source/Core/UpdaterCommon/UpdaterCommon.h b/Source/Core/UpdaterCommon/UpdaterCommon.h
index 53f37c2424..53fe9a145e 100644
--- a/Source/Core/UpdaterCommon/UpdaterCommon.h
+++ b/Source/Core/UpdaterCommon/UpdaterCommon.h
@@ -13,4 +13,6 @@
 
 #include "Common/CommonTypes.h"
 
+// Refer to docs/autoupdate_overview.md for a detailed overview of the autoupdate process
+
 bool RunUpdater(std::vector<std::string> args);
diff --git a/Source/Core/WinUpdater/Main.cpp b/Source/Core/WinUpdater/Main.cpp
index 567486f00a..910a4cfd10 100644
--- a/Source/Core/WinUpdater/Main.cpp
+++ b/Source/Core/WinUpdater/Main.cpp
@@ -16,6 +16,8 @@
 #include "UpdaterCommon/UI.h"
 #include "UpdaterCommon/UpdaterCommon.h"
 
+// Refer to docs/autoupdate_overview.md for a detailed overview of the autoupdate process
+
 int WINAPI wWinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, PWSTR pCmdLine, int nCmdShow)
 {
   if (lstrlenW(pCmdLine) == 0)
-- 
cgit v1.2.3