Continue documenting public surface (#25)

Signed-off-by: Danny Canter <danny_canter@apple.com>

Sources/Containerization/Agent/Vminitd.swift

@@ -42,12 +42,15 @@ public struct Vminitd: Sendable {
         self.client = .init(connection: connection, group: group)
     }
 
+    /// Close the connection to the guest agent.
     public func close() async throws {
         try await client.close()
     }
 }
 
 extension Vminitd: VirtualMachineAgent {
+    /// Perform the standard guest setup necessary for vminitd to be able to
+    /// run containers.
     public func standardSetup() async throws {
         try await up(name: "lo")
 

Sources/Containerization/Container.swift

@@ -17,10 +17,12 @@
 
 /// The core protocol container implementations must implement.
 public protocol Container {
+    /// ID for the container.
     var id: String { get }
-
+    /// The amount of cpus assigned to the container.
     var cpus: Int { get }
+    /// The memory in bytes assigned to the container.
     var memoryInBytes: UInt64 { get }
-
+    /// The network interfaces assigned to the container.
     var interfaces: [any Interface] { get }
 }

Sources/Containerization/DNSConfiguration.swift

@@ -18,11 +18,17 @@
 /// DNS configuration for a container. The values will be used to
 /// construct /etc/resolv.conf for a given container.
 public struct DNS: Sendable {
+    /// The set of default nameservers to use if none are provided
+    /// in the constructor.
     public static let defaultNameservers = ["1.1.1.1"]
 
+    /// The nameservers a container should use.
     public var nameservers: [String]
+    /// The DNS domain to use.
     public var domain: String?
+    /// The DNS search domains to use.
     public var searchDomains: [String]
+    /// The DNS options to use.
     public var options: [String]
 
     public init(

Sources/Containerization/Image/Image.swift

@@ -29,15 +29,19 @@ import ContainerizationExtras
 
 /// Type representing an OCI container image.
 public struct Image: Sendable {
-
     private let contentStore: ContentStore
     /// The description for the image that comprises of its name and a reference to its root descriptor.
     public let description: Description
 
+    /// A description of the OCI image.
     public struct Description: Sendable {
+        /// The string reference of the image.
         public let reference: String
+        /// The descriptor identifying the image.
         public let descriptor: Descriptor
+        /// The digest for the image.
         public var digest: String { descriptor.digest }
+        /// The media type of the image.
         public var mediaType: String { descriptor.mediaType }
 
         public init(reference: String, descriptor: Descriptor) {
@@ -46,9 +50,13 @@ public struct Image: Sendable {
         }
     }
 
+    /// The descriptor for the image.
     public var descriptor: Descriptor { description.descriptor }
+    /// The digest of the image.
     public var digest: String { description.digest }
+    /// The media type of the image.
     public var mediaType: String { description.mediaType }
+    /// The string reference for the image.
     public var reference: String { description.reference }
 
     public init(description: Description, contentStore: ContentStore) {
@@ -79,6 +87,8 @@ public struct Image: Sendable {
         return try content.decode()
     }
 
+    /// Returns the descriptor for the given platform. If it does not exist
+    /// will throw a ContainerizationError with the code set to .invalidArgument.
     public func descriptor(for platform: Platform) async throws -> Descriptor {
         let index = try await self.index()
         let desc = index.manifests.first { $0.platform == platform }