Update documents.

shogo4405 · Aug 21, 2024 · 4d40586 · 4d40586
1 parent eafff5f
commit 4d40586
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 1 deletion.
diff --git a/Sources/Mixer/AudioDeviceUnit.swift b/Sources/Mixer/AudioDeviceUnit.swift
@@ -9,6 +9,7 @@ public typealias AudioDeviceConfigurationBlock = @Sendable (AudioDeviceUnit) thr
 /// An object that provides the interface to control the AVCaptureDevice's transport behavior.
 @available(tvOS 17.0, *)
 public final class AudioDeviceUnit: DeviceUnit {
+    /// The output type that this capture audio data output..
     public typealias Output = AVCaptureAudioDataOutput
 
     /// The track number.

diff --git a/Sources/Mixer/VideoDeviceUnit.swift b/Sources/Mixer/VideoDeviceUnit.swift
@@ -8,6 +8,7 @@ public typealias VideoDeviceConfigurationBlock = @Sendable (VideoDeviceUnit) thr
 /// An object that provides the interface to control the AVCaptureDevice's transport behavior.
 @available(tvOS 17.0, *)
 public final class VideoDeviceUnit: DeviceUnit {
+    /// The output type that this capture video data output..
     public typealias Output = AVCaptureVideoDataOutput
 
     #if os(iOS) || os(macOS)

diff --git a/Sources/Screen/ScreenObject.swift b/Sources/Screen/ScreenObject.swift
@@ -390,11 +390,12 @@ public final class TextScreenObject: ScreenObject {
 public final class AssetScreenObject: ScreenObject, ChromaKeyProcessable {
     public var chromaKeyColor: CGColor?
 
+    /// The reading incidies whether assets reading or not.
     public var isReading: Bool {
         return reader?.status == .reading
     }
 
-    /// A value that specifies how the video is displayed within a player layer’s bounds.
+    /// The video is displayed within a player layer’s bounds.
     public var videoGravity: AVLayerVideoGravity = .resizeAspect {
         didSet {
             guard videoGravity != oldValue else {

diff --git a/Sources/Screen/VideoRotator.swift b/Sources/Screen/VideoRotator.swift
@@ -42,6 +42,7 @@ public final class VideoRotator {
     private var pixelBufferStatus: CVReturn = kCVReturnSuccess
     private let session: VTPixelRotationSession
 
+    /// Creates a new instance.
     public init?() {
         var session: VTPixelRotationSession?
         let status = VTPixelRotationSessionCreate(kCFAllocatorDefault, &session)
@@ -51,6 +52,7 @@ public final class VideoRotator {
         self.session = session
     }
 
+    /// Rotates a sample buffer.
     public func rotate(buffer sampleBuffer: CMSampleBuffer) -> Result<CMSampleBuffer, Error> {
         guard let buffer = sampleBuffer.imageBuffer else {
             return .failure(.noImageBuffer)

diff --git a/Sources/View/MTHKView.swift b/Sources/View/MTHKView.swift
@@ -42,6 +42,7 @@ public class MTHKView: MTKView {
         }
     }
 
+    /// Redraws the view’s contents.
     override public func draw(_ rect: CGRect) {
         guard
             let context,