Docs

Author: Joannis

Sources/Meow/Model.swift

@@ -81,7 +81,8 @@ public protocol BaseModel : SerializableToDocument, Convertible, Identifyable {
 
     /// A list of all dot-notated keys that are a reference to a model and their referenced type
     ///
-    /// The previous models chain is used to prevent infinite recursion
+    /// - parameter previousModels: The previous models chain is used to prevent infinite recursion. Whenever `recursiveKeysWithReferences` is queried, all types found will also be queried for their `recursiveKeysWithReferences` recursively.
+    /// - throws: When the recursion triggers a higher-level model that has been accessed earlier in the chain
     static func recursiveKeysWithReferences(chainedFrom previousModels: [BaseModel.Type]) throws -> [(String, BaseModel.Type)]
 
     /// Will be called when the Model will be deleted. Throwing from here will prevent the model from being deleted.
@@ -127,7 +128,10 @@ extension Model {
         return try closure(VirtualInstance(keyPrefix: "", isReference: false))
     }
 
-    /// A list of all dot-notated keys that are a reference to a model
+    /// A list of all dot-notated keys that are a reference to a model and their referenced type
+    ///
+    /// - parameter previousModels: The previous models chain is used to prevent infinite recursion. Whenever `recursiveKeysWithReferences` is queried, all types found will also be queried for their `recursiveKeysWithReferences` recursively.
+    /// - throws: When the recursion triggers a higher-level model that has been accessed earlier in the chain
     public static func recursiveKeysWithReferences(chainedFrom previousModels: [BaseModel.Type]) throws -> [(String, BaseModel.Type)] {
         let directKeys: [(String, BaseModel.Type)] = try Self.Key.all.flatMap { key in
             guard let type = key.type as? BaseModel.Type else {

Sources/Meow/VirtualVariable.swift

@@ -11,13 +11,21 @@ public protocol VirtualModelInstance {
     ///
     /// - parameter keyPrefix: The keyPrefix is prefixed to all query keys as returned from the VirtualInstance, for the
     /// purpose of being able to embed structs.
+    /// - parameter isReference: The isReference is true when the VirtualInstance is a referenced VirtualInstance rather than a directly queried VirtualInstance.
+    /// This is used to determine the kind and method to to create a query for data accessed from this VirtualInstance
     init(keyPrefix: String, isReference: Bool)
 
+    /// The prefix of all the queries generated from the VirtualInstance
     var keyPrefix: String { get }
+    
+    /// If this VirtualInstance is referenced from a higher-level query
     var isReference: Bool { get }
 }
 
 extension VirtualModelInstance {
+    /// Appends a dot (`"."`) to the keyPrefix if the VirtualInstance is a reference.
+    ///
+    /// This allows keys to be queried in a $match stage after a $lookup stage has been added.
     public var referencedKeyPrefix: String {
         if isReference {
             return keyPrefix + "."