Feat/documentation

Sources/GameWidget/GameWidget.docc/Button_widget.md

@@ -0,0 +1,22 @@
+# Button
+
+## overview
+
+## Topics
+
+### Widget type
+
+- ``Button``
+
+### modifiers
+
+- ``ModifiableWidget/position(_:)``
+- ``ModifiableWidget/color(_:)``
+- ``ModifiableWidget/text(_:)``
+- ``ModifiableWidget/zPosition(_:)``
+- ``ModifiableWidget/actionType(_:)``
+
+### Handling button event
+
+- ``ButtonResopnder``
+- ``ButtonNotificationCenter``

Sources/GameWidget/GameWidget.docc/ControllerArea_widget.md

@@ -0,0 +1,18 @@
+# ControllerArea
+
+## overview
+
+## Topics
+
+### Widget type
+
+- ``ControllerArea``
+
+### modifiers
+
+- ``ModifiableWidget/position(_:)``
+- ``ModifiableWidget/size(_:)``
+
+### Handling controller event
+
+- ``ControllerData``

Sources/GameWidget/GameWidget.docc/GameWidget.md

@@ -8,11 +8,15 @@ User interface widgets for SpriteKit.
 
 ## Topics
 
+### How to use Widgets
+
+- <doc:WidgetUsage>
+
 ### Widgets
 
-- ``Button``
-- ``HorizontalSingleBarChart``
-- ``ControllerArea``
+- <doc:Button_widget>
+- <doc:HorizontalSingleBarChart_widget>
+- <doc:ControllerArea_widget>
 - <doc:Node_widget>
 
 ### Layout widgets

Sources/GameWidget/GameWidget.docc/HorizontalSingleBarChart_widget.md

@@ -0,0 +1,18 @@
+# HorizontalSingleBarChart
+
+## overview
+
+## Topics
+
+### Widget type
+
+- ``HorizontalSingleBarChart``
+
+### modifiers
+
+- ``ModifiableWidget/position(_:)``
+- ``ModifiableWidget/color(_:)``
+- ``ModifiableWidget/width(_:)``
+- ``ModifiableWidget/length(_:)``
+- ``ModifiableWidget/alignment(_:)``
+- ``ModifiableWidget/backgroundColor(_:)``

Sources/GameWidget/GameWidget.docc/Node_widget.md

@@ -15,8 +15,10 @@
 - ``ModifiableWidget/scale(_:)``
 - ``ModifiableWidget/xScale(_:)``
 - ``ModifiableWidget/yScale(_:)``
+- ``ModifiableWidget/zPosition(_:)``
 - ``Position``
 - ``ZRotation``
 - ``Scale``
 - ``XScale``
 - ``YScale``
+- ``ZPosition``

Sources/GameWidget/GameWidget.docc/WidgetUsage.md

@@ -0,0 +1,52 @@
+# Widget の基本的な使い方
+
+## DEMO
+
+```swift
+let button = Button(.init("test"))
+    .modifiable
+    .color(.green)
+    .position(CGPoint(x: 1, y: 1))
+    .text("test_2")
+    .zPosition(1)
+    .actionType(.alpha)
+    .node()
+```
+
+## Create node instance
+
+Widget から SKNode サブクラスインスタンスを作成するには, Widget ととして定義された構造体から実行できる `node()` を使用します.
+
+```swift
+let button = Button(.init("test"))
+    .node()
+```
+
+## Modify widget
+
+Widget はビルダーパターンでレイアウトを編集するインターフェースを提供します. まずは Widget の ``Widget/modifiable-swift.property`` を呼び出しましょう.
+
+```swift
+// 1
+let button = Button(.init("test"))
+    .modifiable
+```
+
+すると, その下の行からこの `Button` にメソッドチェーンをつなげることができるようになります.
+
+```swift
+let button = Button(.init("test"))
+    .modifiable
+    .color(.green)
+    .position(CGPoint(x: 1, y: 1))
+```
+
+最後に, `node()` でノードインスタンスを作成してみると, 座標や色が変化しているかと思います.
+
+```swift
+let button = Button(.init("test"))
+    .modifiable
+    .color(.green)
+    .position(CGPoint(x: 1, y: 1))
+    .node()
+```