Add comments

TestApp/Sources/Bookshelf/Views/Bookshelf.swift

@@ -37,7 +37,6 @@ struct Bookshelf: View {
         .sheet(isPresented: $showingSheet) {
             AddBookSheet { url in
                 // TODO: validate the URL and import the book
-                print(url)
             }
         }
     }

TestApp/Sources/Catalogs/Views/AddFeedSheet.swift

@@ -6,6 +6,7 @@
 
 import SwiftUI
 
+/// Sheet to add a new OPDS catalog via a URL
 struct AddFeedSheet: View {
     typealias ActionCallback = ((title: String, url: String)) -> Void
 

TestApp/Sources/Catalogs/Views/CatalogFeed.swift

@@ -8,6 +8,7 @@ import ReadiumOPDS
 import ReadiumShared
 import SwiftUI
 
+/// Screen of an actual catalog feed, second to x number in the stack since it can keep going to another catalog
 struct CatalogFeed: View {
     var catalog: Catalog
     @State private var parseData: ParseData?
@@ -19,6 +20,7 @@ struct CatalogFeed: View {
                     if !feed.navigation.isEmpty {
                         ForEach(feed.navigation, id: \.self) { link in
                             let navigationLink = Catalog(title: link.title ?? "Catalog", url: link.href)
+                            /// We don't need to define the navigationDestination for this again because it will use the one in CatalogList
                             NavigationLink(value: navigationLink) {
                                 ListRowItem(title: link.title!)
                             }

TestApp/Sources/Catalogs/Views/CatalogList.swift

@@ -7,6 +7,7 @@
 import ReadiumOPDS
 import SwiftUI
 
+/// Screen of list of catalog feeds, first in the stack
 struct CatalogList: View {
     let catalogRepository: CatalogRepository
     let catalogFeed: (Catalog) -> CatalogFeed
@@ -21,6 +22,8 @@ struct CatalogList: View {
             VStack {
                 List {
                     ForEach(catalogs, id: \.id) { catalog in
+                        /// Use the `value` argument for navigationDestination to use.
+                        /// In this case, it is a catalog of type `Catalog`. See below navigationDestination comment.
                         NavigationLink(value: catalog) {
                             ListRowItem(title: catalog.title)
                         }
@@ -44,6 +47,9 @@ struct CatalogList: View {
                 .listStyle(DefaultListStyle())
             }
             .navigationTitle("Catalogs")
+            /// We define the different destinations here, which are applicable to everywhere in the stack.
+            /// Use the `for` argument to pass the type of data. This should match what is being passed in NavigationLink.
+            /// In the first case below, it is of type `Catalog`, the same as NavigationLink above.
             .navigationDestination(for: Catalog.self) { catalog in
                 catalogFeed(catalog)
             }

TestApp/Sources/Catalogs/Views/PublicationDetail.swift

@@ -7,6 +7,7 @@
 import ReadiumShared
 import SwiftUI
 
+/// Screen of the publication detail, last in the stack
 struct PublicationDetail: View {
     @State var opdsPublication: OPDSPublication
 

TestApp/Sources/Data/Catalog.swift

@@ -38,18 +38,21 @@ final class CatalogRepository {
         self.db = db
     }
 
+    /// Get all saved OPDS catalogs
     func all() -> AnyPublisher<[Catalog]?, Error> {
         db.observe {
             try Catalog.order(Catalog.Columns.title).fetchAll($0)
         }
     }
 
+    /// Save an OPDS catalog
     func save(_ catalog: inout Catalog) async throws {
         catalog = try await db.write { [catalog] db in
             try catalog.saved(db)
         }
     }
 
+    /// Delete an OPDS catalog
     func delete(ids: [Catalog.Id]) async throws {
         try await db.write { db in
             try Catalog.deleteAll(db, ids: ids)

TestApp/Sources/TestApp.swift

@@ -8,6 +8,7 @@ import GRDB
 import SwiftUI
 
 // @main
+/// The main function and serves as the app's entry
 struct TestApp: App {
     let container = try! Container()