From c4c406392342ebaa4e643121b93e1acc3ac6fd9f Mon Sep 17 00:00:00 2001 From: Timofey Solomko Date: Fri, 4 Jan 2019 14:54:40 +0300 Subject: [PATCH] [docs] Small improvements to various BZip2 documentation --- Sources/BZip2/BZip2+BlockSize.swift | 4 +--- Sources/BZip2/BZip2+Compress.swift | 4 ++-- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/Sources/BZip2/BZip2+BlockSize.swift b/Sources/BZip2/BZip2+BlockSize.swift index 9bb87d27..80337af1 100644 --- a/Sources/BZip2/BZip2+BlockSize.swift +++ b/Sources/BZip2/BZip2+BlockSize.swift @@ -7,9 +7,7 @@ import Foundation public extension BZip2 { - /** - Represents size of blocks in which data is split during BZip2 compression. - */ + /// Represents size of blocks in which data is split during BZip2 compression. public enum BlockSize: Int { /// 100 KB. case one = 1 diff --git a/Sources/BZip2/BZip2+Compress.swift b/Sources/BZip2/BZip2+Compress.swift index 8e76bce5..c3b30c33 100644 --- a/Sources/BZip2/BZip2+Compress.swift +++ b/Sources/BZip2/BZip2+Compress.swift @@ -13,8 +13,8 @@ extension BZip2: CompressionAlgorithm { - Parameter data: Data to compress. - - Note: Input data will be split into blocks of size 100 KB. - Use `BZip2.compress(data:blockSize:)` function to specify size of a block. + - Note: Input data will be split into blocks of size 100 KB. Use `BZip2.compress(data:blockSize:)` function to + specify the size of a block. */ public static func compress(data: Data) -> Data { return compress(data: data, blockSize: .one)