From eb72aebdf15d530853930d23313f8f6b84c591c8 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Wed, 12 Mar 2025 00:45:22 +0100 Subject: [PATCH] Documented the ArchiveList model in the library target. --- Library/Sources/Internal/Models/ArchiveList.swift | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Library/Sources/Internal/Models/ArchiveList.swift b/Library/Sources/Internal/Models/ArchiveList.swift index 8520b84..0b7f33d 100644 --- a/Library/Sources/Internal/Models/ArchiveList.swift +++ b/Library/Sources/Internal/Models/ArchiveList.swift @@ -1,13 +1,17 @@ import Hummingbird +/// A model that provides the names of all the *DocC* archives that are contained at a certain folder in the file system. struct ArchiveList: ResponseCodable { // MARK: Properties + /// A list of *DocC* archive names extracted from a given folder in the file system. let archives: [String] // MARK: Initialisers + /// Initialises this model. + /// - Parameter archives: A list of archive names extracted from a given folder in the file system. init(_ archives: [String]) { self.archives = archives }