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.
This commit is contained in:
Dentomologist
2021-03-12 17:10:53 -08:00
parent e8ac63d159
commit e0a8d931fc
10 changed files with 115 additions and 2 deletions

View File

@ -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);

View File

@ -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

View File

@ -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

View File

@ -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)

View File

@ -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;

View File

@ -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

View File

@ -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.

View File

@ -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);

View File

@ -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)