Navaron Bracke

update some doc comments on iOS

@@ -95,7 +95,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin { @@ -95,7 +95,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin {
95 } 95 }
96 } 96 }
97 97
98 - /// Parses all parameters and starts the mobileScanner 98 + /// Start the mobileScanner.
99 private func start(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) { 99 private func start(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
100 let torch: Bool = (call.arguments as! Dictionary<String, Any?>)["torch"] as? Bool ?? false 100 let torch: Bool = (call.arguments as! Dictionary<String, Any?>)["torch"] as? Bool ?? false
101 let facing: Int = (call.arguments as! Dictionary<String, Any?>)["facing"] as? Int ?? 1 101 let facing: Int = (call.arguments as! Dictionary<String, Any?>)["facing"] as? Int ?? 1
@@ -151,7 +151,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin { @@ -151,7 +151,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin {
151 } 151 }
152 } 152 }
153 153
154 - /// Stops the mobileScanner and closes the texture 154 + /// Stops the mobileScanner and closes the texture.
155 private func stop(_ result: @escaping FlutterResult) { 155 private func stop(_ result: @escaping FlutterResult) {
156 do { 156 do {
157 try mobileScanner.stop() 157 try mobileScanner.stop()
@@ -159,7 +159,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin { @@ -159,7 +159,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin {
159 result(nil) 159 result(nil)
160 } 160 }
161 161
162 - /// Toggles the torch 162 + /// Toggles the torch.
163 private func toggleTorch(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) { 163 private func toggleTorch(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
164 do { 164 do {
165 try mobileScanner.toggleTorch(call.arguments as? Int == 1 ? .on : .off) 165 try mobileScanner.toggleTorch(call.arguments as? Int == 1 ? .on : .off)
@@ -171,7 +171,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin { @@ -171,7 +171,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin {
171 } 171 }
172 } 172 }
173 173
174 - /// Toggles the zoomScale 174 + /// Sets the zoomScale.
175 private func setScale(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) { 175 private func setScale(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
176 let scale = call.arguments as? CGFloat 176 let scale = call.arguments as? CGFloat
177 if (scale == nil) { 177 if (scale == nil) {
@@ -198,7 +198,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin { @@ -198,7 +198,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin {
198 } 198 }
199 } 199 }
200 200
201 - /// Reset the zoomScale 201 + /// Reset the zoomScale.
202 private func resetScale(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) { 202 private func resetScale(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
203 do { 203 do {
204 try mobileScanner.resetScale() 204 try mobileScanner.resetScale()
@@ -218,7 +218,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin { @@ -218,7 +218,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin {
218 } 218 }
219 } 219 }
220 220
221 - /// Toggles the torch 221 + /// Updates the scan window rectangle.
222 func updateScanWindow(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) { 222 func updateScanWindow(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
223 let scanWindowData: Array? = (call.arguments as? [String: Any])?["rect"] as? [CGFloat] 223 let scanWindowData: Array? = (call.arguments as? [String: Any])?["rect"] as? [CGFloat]
224 MobileScannerPlugin.scanWindow = scanWindowData 224 MobileScannerPlugin.scanWindow = scanWindowData
@@ -240,7 +240,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin { @@ -240,7 +240,7 @@ public class MobileScannerPlugin: NSObject, FlutterPlugin {
240 return CGRect(x: minX, y: minY, width: width, height: height) 240 return CGRect(x: minX, y: minY, width: width, height: height)
241 } 241 }
242 242
243 - /// Analyzes a single image 243 + /// Analyzes a single image.
244 private func analyzeImage(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) { 244 private func analyzeImage(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
245 let uiImage = UIImage(contentsOfFile: call.arguments as? String ?? "") 245 let uiImage = UIImage(contentsOfFile: call.arguments as? String ?? "")
246 246