[docs] Small improvements to various BZip2 documentation

This commit is contained in:
Timofey Solomko
2019-01-04 14:59:13 +03:00
parent ce47019097
commit c4c4063923
2 changed files with 3 additions and 5 deletions
+1 -3
View File
@@ -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
+2 -2
View File
@@ -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)