Merge pull request #14 from mtj0928/add-api-doc-essentials

add api doc essentials

Author: mtj0928

Sources/SlideKit/Slide.swift

@@ -7,15 +7,57 @@
 
 import SwiftUI
 
+/// A type that represents your presentation slide.
+/// This represents one page of your presentation.
+///
+/// You can make your slide like this.
+/// ```swift
+/// struct SampleSlide: Slide {
+///
+///     enum Substep: Int, PhasedState {
+///         case initial, second, third
+///     }
+///
+///     @Phase var phasedStateStore: PhasedStateStore<Substep>
+///
+///     var body: some View {
+///         HeaderSlide("Phased Slide") {
+///             Item("1st step", accessory: 1)
+///
+///             if phasedStateStore.after(.second) {
+///                 Item("2nd step", accessory: 2)
+///             }
+///             if phasedStateStore.after(.third) {
+///                 Item("3rd step", accessory: 3)
+///             }
+///         }
+///     }
+/// }
+/// ```
 public protocol Slide: View {
 
+    /// A type which shows sub-steps in your slide.
+    /// The default type is ``SimplePhasedState``.
     associatedtype SlidePhasedState: PhasedState
+
     typealias Phase = PhaseWrapper<SlidePhasedState>
 
+    /// A store which controls current ``SlidePhasedState``.
+    ///
+    /// You can get current ``SlidePhasedState`` and forward / back it.
+    /// > Note: The property must be defined with ``Phase`` like the bellow.
+    ///
+    /// ```swift
+    /// @Phase var phasedStateStore: PhasedStateStore<SlidePhasedState>
+    /// ```
     var phasedStateStore: PhasedStateStore<SlidePhasedState> { get }
 
+    /// A script for the current slide. The script will be shown on presenter view (macOS only).
+    /// The default value is an empty String.
     var script: String { get }
 
+    /// A boolean value indicating whether the slide index at the right bottom is hidden or not.
+    /// The default value is `false`
     var shouldHideIndex: Bool { get }
 }
 

Sources/SlideKit/SlideComponents/Templates/HeaderSlide.swift

@@ -7,13 +7,37 @@
 
 import SwiftUI
 
-public struct HeaderSlide: View {
+/// A template slide which has a title and a content.
+///
+/// ``HeaderSlide``  is one of template slides.
+/// The design can be customized by using ``HeaderSlideStyle``.
+///
+/// ```swift
+/// var body: some View {
+///     HeaderSlide("SampleSlide") {
+///         Item("1st item")
+///         Item("2nd item")
+///         Item("3rd item")
+///     }
+///     .headerSlideStyle(CustomizedHeaderSlideStyle())
+/// }
+/// ```
+///
+/// ## Topics
+/// ### Customize Style
+/// - ``HeaderSlideStyle``
+public struct HeaderSlide: Slide {
 
     @Environment(\.headerSlideStyle)
     private var style
 
     private var configuration: HeaderSlideStyleConfiguration
 
+    /// Creates a header slide.
+    /// - Parameters:
+    ///   - header: A text which is shown on the slide
+    ///   - fontWeight: A  fontWeight of the header text.
+    ///   - content: A content of the slide.
     public init(_ header: String, fontWeight: Font.Weight = .semibold, @ViewBuilder content: @escaping () -> some View) {
         self.configuration = HeaderSlideStyleConfiguration(
             header: .init {