Update documentation.

LebJe · Mar 17, 2021 · f41c052 · f41c052
1 parent 4042f4a
commit f41c052
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/Sources/ArArchiveKit/ArArchiveWriter.swift b/Sources/ArArchiveKit/ArArchiveWriter.swift
@@ -1,3 +1,5 @@
+
+/// `ArArchiveWriter` creates `ar` files.
 public struct ArArchiveWriter {
 	/// The raw bytes of the archive.
 	public var bytes: [UInt8] = []

diff --git a/Sources/ArArchiveKit/Header.swift b/Sources/ArArchiveKit/Header.swift
@@ -1,4 +1,7 @@
-/// The `ar` header, which is placed atop the contents of a file in the archive to provide information such as the size of the file, the file's name, it's permissions, etc.
+/// The `ar` header.
+///
+/// This header is placed atop the contents of a file in the archive to
+/// provide information such as the size of the file, the file's name, it's permissions, etc.
 public struct Header {
 	/// The file's name. The name will be truncated to 16 characters.
 	public let name: String