Add documentation

2020-08-07 10:59:38 +02:00 · 2020-08-07 10:59:38 +02:00 · 52e084af29
parent b2ae49b231
commit 52e084af29
1 changed files with 3 additions and 0 deletions
--- a/Sources/FirebladeECS/Family.swift
+++ b/Sources/FirebladeECS/Family.swift
@ -39,6 +39,9 @@ public struct Family<R> where R: FamilyRequirementsManaging {
        nexus.isMember(entity, in: traits)
    }

+    /// Create a member entity with the given components assigned.
+    /// - Parameter builder: The family member builder.
+    /// - Returns: The newly created member entity.
    @discardableResult
    public func createMember(@FamilyMemberBuilder<R> using builder: () -> R.Components) -> Entity {
        self.createMember(with: builder())