Updater: Add code documentation #9615
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Dentomologist
commented
Mar 30, 2021
Source/Core/UICommon/AutoUpdate.h
Outdated
| // a) On MacOS (starts main() in MacUpdater/main.m): | ||
| // * Checks that the process received command line arguments. If not it tells the user the | ||
| // updater can't be launched directly and quits | ||
| // * Calls NSApplicationMain(), which passes control to the AppDelegate defined in | ||
| // MacUpdater/AppDelegate.mm. The command line arguments are converted to a std::vector | ||
| // and passed to RunUpdater() in UpdaterCommon.h |
There was a problem hiding this comment.
I'm not familiar with Objective-c so I'm not certain about this part, but it should be something close.
|
It would be better to add this as a separate readme file, and citing that file inside the cpp and h files |
Dentomologist
force-pushed
the
updater_documentation
branch
from
293a7dd
to
480f1ed
Compare
|
Documentation moved to docs/autoupdate_overview.txt, with comments thereto in autoupdate related classes. |
Good, is it necessary to cite the document in the mac updater files too? |
leoetlino
reviewed
Apr 6, 2021
Dentomologist
force-pushed
the
updater_documentation
branch
from
480f1ed
to
6f1773c
Compare
Add docs/autoupdate_overview.md which gives an overview of the update process, and comments pointing to it in autoupdate related files.
Dentomologist
force-pushed
the
updater_documentation
branch
from
6f1773c
to
e0a8d93
Compare
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Add a comment at the beginning of AutoUpdate.h giving an overview of
the update process and how the flow of control proceeds during an
update.