]> git.ipfire.org Git - thirdparty/wireguard-apple.git/commitdiff
Remove more comments
authorRoopesh Chander <roop@roopc.net>
Sat, 22 Dec 2018 19:01:20 +0000 (00:31 +0530)
committerRoopesh Chander <roop@roopc.net>
Sat, 22 Dec 2018 19:01:44 +0000 (00:31 +0530)
Signed-off-by: Roopesh Chander <roop@roopc.net>
WireGuard/WireGuard/UI/TunnelViewModel.swift
WireGuard/WireGuard/UI/iOS/AppDelegate.swift
WireGuard/WireGuard/UI/iOS/ViewController/SettingsTableViewController.swift
WireGuard/WireGuard/UI/iOS/ViewController/TunnelDetailTableViewController.swift
WireGuard/WireGuard/UI/iOS/ViewController/TunnelEditTableViewController.swift
WireGuard/WireGuard/UI/iOS/ViewController/TunnelsListTableViewController.swift

index a981ef00d937f4efe81ff1a74fed468c709fc919..527ea7b36f698f3e0d6997375ef68cab064c3e32 100644 (file)
@@ -71,16 +71,12 @@ class TunnelViewModel {
         subscript(field: InterfaceField) -> String {
             get {
                 if scratchpad.isEmpty {
-                    // When starting to read a config, setup the scratchpad.
-                    // The scratchpad shall serve as a cache of what we want to show in the UI.
                     populateScratchpad()
                 }
                 return scratchpad[field] ?? ""
             }
             set(stringValue) {
                 if scratchpad.isEmpty {
-                    // When starting to edit a config, setup the scratchpad and remove the configuration.
-                    // The scratchpad shall be the sole source of the being-edited configuration.
                     populateScratchpad()
                 }
                 validatedConfiguration = nil
@@ -102,7 +98,6 @@ class TunnelViewModel {
         }
 
         func populateScratchpad() {
-            // Populate the scratchpad from the configuration object
             guard let config = validatedConfiguration else { return }
             guard let name = validatedName else { return }
             scratchpad[.name] = name
@@ -125,7 +120,6 @@ class TunnelViewModel {
         //swiftlint:disable:next cyclomatic_complexity function_body_length
         func save() -> SaveResult<(String, InterfaceConfiguration)> {
             if let config = validatedConfiguration, let name = validatedName {
-                // It's already validated and saved
                 return .saved((name, config))
             }
             fieldsWithError.removeAll()
@@ -198,7 +192,6 @@ class TunnelViewModel {
                 }
                 return !self[field].isEmpty
             }
-            // TODO: Cache this to avoid recomputing
         }
     }
 
@@ -208,7 +201,6 @@ class TunnelViewModel {
         var fieldsWithError = Set<PeerField>()
         var validatedConfiguration: PeerConfiguration?
 
-        // For exclude private IPs
         private(set) var shouldAllowExcludePrivateIPsControl = false
         private(set) var shouldStronglyRecommendDNS = false
         private(set) var excludePrivateIPsValue = false
@@ -221,16 +213,12 @@ class TunnelViewModel {
         subscript(field: PeerField) -> String {
             get {
                 if scratchpad.isEmpty {
-                    // When starting to read a config, setup the scratchpad.
-                    // The scratchpad shall serve as a cache of what we want to show in the UI.
                     populateScratchpad()
                 }
                 return scratchpad[field] ?? ""
             }
             set(stringValue) {
                 if scratchpad.isEmpty {
-                    // When starting to edit a config, setup the scratchpad and remove the configuration.
-                    // The scratchpad shall be the sole source of the being-edited configuration.
                     populateScratchpad()
                 }
                 validatedConfiguration = nil
@@ -246,7 +234,6 @@ class TunnelViewModel {
         }
 
         func populateScratchpad() {
-            // Populate the scratchpad from the configuration object
             guard let config = validatedConfiguration else { return }
             scratchpad[.publicKey] = config.publicKey.base64EncodedString()
             if let preSharedKey = config.preSharedKey {
@@ -267,7 +254,6 @@ class TunnelViewModel {
         //swiftlint:disable:next cyclomatic_complexity
         func save() -> SaveResult<PeerConfiguration> {
             if let validatedConfiguration = validatedConfiguration {
-                // It's already validated and saved
                 return .saved(validatedConfiguration)
             }
             fieldsWithError.removeAll()
@@ -331,7 +317,6 @@ class TunnelViewModel {
                 }
                 return (!self[field].isEmpty)
             }
-            // TODO: Cache this to avoid recomputing
         }
 
         static let ipv4DefaultRouteString = "0.0.0.0/0"
@@ -378,7 +363,7 @@ class TunnelViewModel {
                 modifiedAllowedIPStrings = ipv6Addresses + [TunnelViewModel.PeerData.ipv4DefaultRouteString]
             }
             scratchpad[.allowedIPs] = modifiedAllowedIPStrings.joined(separator: ", ")
-            validatedConfiguration = nil // The configuration has been modified, and needs to be saved
+            validatedConfiguration = nil
             excludePrivateIPsValue = isOn
         }
     }
@@ -435,10 +420,8 @@ class TunnelViewModel {
     }
 
     func save() -> SaveResult<TunnelConfiguration> {
-        // Attempt to save the interface and all peers, so that all erroring fields are collected
         let interfaceSaveResult = interfaceData.save()
-        let peerSaveResults = peersData.map { $0.save() }
-        // Collate the results
+        let peerSaveResults = peersData.map { $0.save() } // Save all, to help mark erroring fields in red
         switch interfaceSaveResult {
         case .error(let errorMessage):
             return .error(errorMessage)
@@ -466,8 +449,6 @@ class TunnelViewModel {
     }
 }
 
-// MARK: Activate on demand
-
 extension TunnelViewModel {
     static func activateOnDemandOptionText(for activateOnDemandOption: ActivateOnDemandOption) -> String {
         switch activateOnDemandOption {
index 9c3aa9fdc4618226d313ad77938dd709bf6f0363..512963ff50c0c13d7e93e6be037082614120d69f 100644 (file)
@@ -38,8 +38,6 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     }
 }
 
-// MARK: State restoration
-
 extension AppDelegate {
     func application(_ application: UIApplication, shouldSaveApplicationState coder: NSCoder) -> Bool {
         return true
index 58f861142693ef90318e73372200a789dd13d60e..c74b6e32181041b162880f09c30500637f753e3f 100644 (file)
@@ -148,8 +148,6 @@ class SettingsTableViewController: UITableViewController {
     }
 }
 
-// MARK: UITableViewDataSource
-
 extension SettingsTableViewController {
     override func numberOfSections(in tableView: UITableView) -> Int {
         return settingsFieldsBySection.count
index 2912e075c8edc8f95edc3f134a789ada72f7ebbf..805a06bb513a0fbd2372dea61522764564acbb84 100644 (file)
@@ -90,8 +90,6 @@ class TunnelDetailTableViewController: UITableViewController {
     }
 }
 
-// MARK: TunnelEditTableViewControllerDelegate
-
 extension TunnelDetailTableViewController: TunnelEditTableViewControllerDelegate {
     func tunnelSaved(tunnel: TunnelContainer) {
         tunnelViewModel = TunnelViewModel(tunnelConfiguration: tunnel.tunnelConfiguration)
@@ -105,8 +103,6 @@ extension TunnelDetailTableViewController: TunnelEditTableViewControllerDelegate
     }
 }
 
-// MARK: UITableViewDataSource
-
 extension TunnelDetailTableViewController {
     override func numberOfSections(in tableView: UITableView) -> Int {
         return sections.count
index a0f185559a5c479dba6c6265099a1441932cae2f..968f0f9a8a0edd8c51568032795ba54e6ba07618 100644 (file)
@@ -469,8 +469,6 @@ extension TunnelEditTableViewController {
     }
 }
 
-// MARK: UITableViewDelegate
-
 extension TunnelEditTableViewController {
     override func tableView(_ tableView: UITableView, willSelectRowAt indexPath: IndexPath) -> IndexPath? {
         if case .onDemand = sections[indexPath.section], indexPath.row > 0 {
index 25d02be12499cc8a27d985043f64d1f64338d3a4..38b53ecd2000a7049b759beeed35f722333f4e8f 100644 (file)
@@ -196,8 +196,6 @@ class TunnelsListTableViewController: UIViewController {
     }
 }
 
-// MARK: UIDocumentPickerDelegate
-
 extension TunnelsListTableViewController: UIDocumentPickerDelegate {
     func documentPicker(_ controller: UIDocumentPickerViewController, didPickDocumentsAt urls: [URL]) {
         urls.forEach {
@@ -206,8 +204,6 @@ extension TunnelsListTableViewController: UIDocumentPickerDelegate {
     }
 }
 
-// MARK: QRScanViewControllerDelegate
-
 extension TunnelsListTableViewController: QRScanViewControllerDelegate {
     func addScannedQRCode(tunnelConfiguration: TunnelConfiguration, qrScanViewController: QRScanViewController,
                           completionHandler: (() -> Void)?) {
@@ -221,8 +217,6 @@ extension TunnelsListTableViewController: QRScanViewControllerDelegate {
     }
 }
 
-// MARK: UITableViewDataSource
-
 extension TunnelsListTableViewController: UITableViewDataSource {
     func numberOfSections(in tableView: UITableView) -> Int {
         return 1
@@ -250,8 +244,6 @@ extension TunnelsListTableViewController: UITableViewDataSource {
     }
 }
 
-// MARK: UITableViewDelegate
-
 extension TunnelsListTableViewController: UITableViewDelegate {
     func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
         guard let tunnelsManager = tunnelsManager else { return }
@@ -281,8 +273,6 @@ extension TunnelsListTableViewController: UITableViewDelegate {
     }
 }
 
-// MARK: TunnelsManagerDelegate
-
 extension TunnelsListTableViewController: TunnelsManagerListDelegate {
     func tunnelAdded(at index: Int) {
         tableView.insertRows(at: [IndexPath(row: index, section: 0)], with: .automatic)