Skip to content

Commit c5fbf28

Browse files
Added missing comment docs
1 parent 6e2d949 commit c5fbf28

14 files changed

+41
-9
lines changed

Sources/ManagedAction.swift

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,27 +46,33 @@ internal class ManagedAction: ManagedNode {
4646
subjectSet = []
4747
objectSet = []
4848
}
49-
49+
50+
/// Generic creation of the managed tag type.
5051
internal override class func createTag(name: String, node: ManagedNode, managedObjectContext: NSManagedObjectContext) {
5152
_ = ManagedActionTag(name: name, node: node, managedObjectContext: managedObjectContext)
5253
}
5354

55+
/// Generic creation of the managed group type.
5456
internal override class func createGroup(name: String, node: ManagedNode, managedObjectContext: NSManagedObjectContext) {
5557
_ = ManagedActionGroup(name: name, node: node, managedObjectContext: managedObjectContext)
5658
}
5759

60+
/// Generic creation of the managed property type.
5861
internal override class func createProperty(name: String, object: Any, node: ManagedNode, managedObjectContext: NSManagedObjectContext) {
5962
_ = ManagedActionProperty(name: name, object: object, node: node, managedObjectContext: managedObjectContext)
6063
}
6164

65+
/// Generic cast to the managed tag type.
6266
internal override class func asTag(_ tag: ManagedTag) -> ManagedTag? {
6367
return tag as? ManagedActionTag
6468
}
6569

70+
/// Generic cast to the managed group type.
6671
internal override class func asGroup(_ group: ManagedGroup) -> ManagedGroup? {
6772
return group as? ManagedActionGroup
6873
}
6974

75+
/// Generic cast to the managed property type.
7076
internal override class func asProperty(_ property: ManagedProperty) -> ManagedProperty? {
7177
return property as? ManagedActionProperty
7278
}

Sources/ManagedActionGroup.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import CoreData
3232

3333
@objc(ManagedActionGroup)
3434
internal class ManagedActionGroup: ManagedGroup {
35+
/// A model identifier.
3536
internal override class var identifier: String {
3637
return ModelIdentifier.actionGroupName
3738
}

Sources/ManagedActionProperty.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import CoreData
3232

3333
@objc(ManagedActionProperty)
3434
internal class ManagedActionProperty: ManagedProperty {
35+
/// A model identifier.
3536
internal override class var identifier: String {
3637
return ModelIdentifier.actionPropertyName
3738
}

Sources/ManagedActionTag.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import CoreData
3232

3333
@objc(ManagedActionTag)
3434
internal class ManagedActionTag: ManagedTag {
35+
/// A model identifier.
3536
internal override class var identifier: String {
3637
return ModelIdentifier.actionTagName
3738
}

Sources/ManagedEntity.swift

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,26 +51,32 @@ internal class ManagedEntity: ManagedNode {
5151
relationshipObjectSet = []
5252
}
5353

54+
/// Generic creation of the managed tag type.
5455
internal override class func createTag(name: String, node: ManagedNode, managedObjectContext: NSManagedObjectContext) {
5556
_ = ManagedEntityTag(name: name, node: node, managedObjectContext: managedObjectContext)
5657
}
5758

59+
/// Generic creation of the managed group type.
5860
internal override class func createGroup(name: String, node: ManagedNode, managedObjectContext: NSManagedObjectContext) {
5961
_ = ManagedEntityGroup(name: name, node: node, managedObjectContext: managedObjectContext)
6062
}
6163

64+
/// Generic creation of the managed property type.
6265
internal override class func createProperty(name: String, object: Any, node: ManagedNode, managedObjectContext: NSManagedObjectContext) {
6366
_ = ManagedEntityProperty(name: name, object: object, node: node, managedObjectContext: managedObjectContext)
6467
}
6568

69+
/// Generic cast to the managed tag type.
6670
internal override class func asTag(_ tag: ManagedTag) -> ManagedTag? {
6771
return tag as? ManagedEntityTag
6872
}
6973

74+
/// Generic cast to the managed group type.
7075
internal override class func asGroup(_ group: ManagedGroup) -> ManagedGroup? {
7176
return group as? ManagedEntityGroup
7277
}
7378

79+
/// Generic cast to the managed property type.
7480
internal override class func asProperty(_ property: ManagedProperty) -> ManagedProperty? {
7581
return property as? ManagedEntityProperty
7682
}

Sources/ManagedEntityGroup.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import CoreData
3232

3333
@objc(ManagedEntityGroup)
3434
internal class ManagedEntityGroup: ManagedGroup {
35+
/// A model identifier.
3536
internal override class var identifier: String {
3637
return ModelIdentifier.entityGroupName
3738
}

Sources/ManagedEntityProperty.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import CoreData
3232

3333
@objc(ManagedEntityProperty)
3434
internal class ManagedEntityProperty: ManagedProperty {
35+
/// A model identifier.
3536
internal override class var identifier: String {
3637
return ModelIdentifier.entityPropertyName
3738
}

Sources/ManagedEntityTag.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import CoreData
3232

3333
@objc(ManagedEntityTag)
3434
internal class ManagedEntityTag: ManagedTag {
35+
/// A model identifier.
3536
internal override class var identifier: String {
3637
return ModelIdentifier.entityTagName
3738
}

Sources/ManagedNode.swift

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ internal class ManagedNode: ManagedObject {
8383
/**
8484
Initializer that accepts an identifier, a type, and a NSManagedObjectContext.
8585
- Parameter identifier: A model identifier.
86-
- Parameter type: A reference to the Entity type.
86+
- Parameter type: A reference to the Node type.
8787
- Parameter managedObjectContext: A reference to the NSManagedObejctContext.
8888
*/
8989
internal convenience init(identifier: String, type: String, managedObjectContext: NSManagedObjectContext) {
@@ -152,13 +152,13 @@ internal class ManagedNode: ManagedObject {
152152
}
153153

154154
/**
155-
Removes the ManagedEntity from a given group.
155+
Removes the ManagedNode from a given group.
156156
- Parameter from groups: An Array of Strings.
157157
*/
158158
internal func remove(from groups: [String]) {
159-
performAndWait { entity in
159+
performAndWait { node in
160160
groups.forEach { name in
161-
entity.groupSet.forEach {
161+
node.groupSet.forEach {
162162
if let g = Swift.type(of: self).asGroup($0), name == g.name {
163163
g.delete()
164164
}
@@ -167,27 +167,32 @@ internal class ManagedNode: ManagedObject {
167167
}
168168
}
169169

170-
170+
/// Generic creation of the managed tag type.
171171
internal class func createTag(name: String, node: ManagedNode, managedObjectContext: NSManagedObjectContext) {
172172
fatalError("Must be implemented by subclasses")
173173
}
174174

175+
/// Generic cast to the managed tag type.
175176
internal class func asTag(_ tag: ManagedTag) -> ManagedTag? {
176177
fatalError("Must be implemented by subclasses")
177178
}
178179

180+
/// Generic creation of the managed group type.
179181
internal class func createGroup(name: String, node: ManagedNode, managedObjectContext: NSManagedObjectContext) {
180182
fatalError("Must be implemented by subclasses")
181183
}
182184

185+
/// Generic cast to the managed group type.
183186
internal class func asGroup(_ group: ManagedGroup) -> ManagedGroup? {
184187
fatalError("Must be implemented by subclasses")
185188
}
186-
189+
190+
/// Generic creation of the managed property type.
187191
internal class func createProperty(name: String, object: Any, node: ManagedNode, managedObjectContext: NSManagedObjectContext) {
188192
fatalError("Must be implemented by subclasses")
189193
}
190194

195+
/// Generic cast to the managed property type.
191196
internal class func asProperty(_ property: ManagedProperty) -> ManagedProperty? {
192197
fatalError("Must be implemented by subclasses")
193198
}
@@ -291,7 +296,7 @@ internal class ManagedNode: ManagedObject {
291296
}
292297
}
293298

294-
extension ManagedNode : Comparable {
299+
extension ManagedNode: Comparable {
295300
static public func ==(lhs: ManagedNode, rhs: ManagedNode) -> Bool {
296301
return lhs.id == rhs.id
297302
}

Sources/ManagedObject.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import CoreData
3333
@objc(ManagedObject)
3434
internal class ManagedObject: NSManagedObject {
3535

36-
/// A model identifier
36+
/// A model identifier.
3737
internal class var identifier: String {
3838
return ""
3939
}

0 commit comments

Comments
 (0)