From 6a46c6c4cd6ec9bfd674379b6fd06a312a47a994 Mon Sep 17 00:00:00 2001 From: Roy Marmelstein Date: Mon, 18 Jan 2016 22:22:58 +0100 Subject: [PATCH] Improved documentation --- Zip/Zip.swift | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/Zip/Zip.swift b/Zip/Zip.swift index 178d22b..3065cc4 100644 --- a/Zip/Zip.swift +++ b/Zip/Zip.swift @@ -11,21 +11,24 @@ import minizip /// Zip error type public enum ZipError: ErrorType { - case FileNotFound // File not found - case UnzipFail // Unzip error - case ZipFail // Zip error + /// File not found + case FileNotFound + /// Unzip fail + case UnzipFail + /// Zip fail + case ZipFail - /// Description variable + /// User readable description public var description: String { switch self { case .FileNotFound: return NSLocalizedString("File not found.", comment: "") - case .UnzipFail: return NSLocalizedString("Failed to unzip zip file.", comment: "") + case .UnzipFail: return NSLocalizedString("Failed to unzip file.", comment: "") case .ZipFail: return NSLocalizedString("Failed to zip file.", comment: "") } } } - +/// Zip class public class Zip { // File manager -- 2.26.2