Add docs for LineView (#45)

This patch adds documentation (images) for line view.

Author: ybubnov

README.md

@@ -42,6 +42,19 @@ PlotView {
 .frame(width: 500, height: 300)
 ```
 
+You can use `LineView` to define a line chart:
+```swift
+PlotView{
+    LineView(
+        x: [0, 1, 2, 3, 4, 5],
+        y: [10, 20, 0, 45, 30, 50]
+    )
+}
+.tickInsets(bottom: 20, trailing: 20)
+.contentDisposition(minX: -5, maxX: 15, minY: 0)
+.frame(width: 600, height: 300)
+```
+
 ## License
 
 PlotUI is [MIT licensed](LICENSE).

Sources/PlotUI/Line.swift

@@ -11,9 +11,11 @@ import SwiftUI
 /// ```swift
 /// LineView(
 ///     x: [0, 1, 2, 3, 4, 5],
-///     y: [0, 3, 7, 12, 18, 30]
+///     y: [10, 20, 0, 45, 30, 50]
 /// )
 /// ```
+/// ![A line view with line view](lineview.png)
+///
 /// Usually `LineView` is used within ``PlotView`` container that automatically defines
 /// axes with appropriate ticks. You can use ``PlotView/contentDisposition(minX:maxX:minY:maxY:)``
 /// to adjust the limits of the axes to position the view's content as you want.
@@ -26,22 +28,24 @@ import SwiftUI
 /// PlotView {
 ///     LineView(
 ///         x: [1, 2, 3, 4, 5, 6]
-///         y: [10, 20, 5, 15, 18, 3]
+///         y: [10, 20, 0, 45, 30, 50]
 ///     )
 ///     .lineStroke(style: StrokeStyle(lineWidth: 1.0, dash: [2]))
 /// }
 /// ```
+/// ![A line view with dashed stroke 1 pixel width](lineview-linestroke.png)
 ///
 /// You can also change the default color of the line using ``LineView/lineColor(_:)``:
 /// ```swift
 /// PlotView {
 ///     LineView(
 ///         x: [1, 2, 3, 4, 5, 6]
-///         y: [10, 20, 5, 15, 18, 3]
+///         y: [10, 20, 0, 45, 30, 50]
 ///     )
-///     .lineColor(.black)
+///     .lineColor(.mint)
 /// }
 /// ```
+/// ![A linew view with mint color line](lineview-linecolor.png)
 ///
 /// Additionally, you can modify the background overlay of the line chart using
 /// ``LineView/lineFill(_:)``:
@@ -54,6 +58,7 @@ import SwiftUI
 ///     .lineFill(.green.opacity(0.3))
 /// }
 /// ```
+/// ![A line view with opaque green fill](lineview-linefill.png)
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
 public struct LineView: FuncView {
 

Sources/PlotUI/Plot.swift

@@ -240,7 +240,7 @@ public struct VAxis: View {
 ///
 /// For example, to make the horizontal and vertical ticks visible, adjust limits of the
 /// axes by setting content disposition:
-
+///
 /// ```swift
 /// PlotView {
 ///     BarView(

Sources/PlotUI/PlotUI.docc/PlotUI.md

@@ -7,6 +7,21 @@ Integrate beautiful minimalistic plots into your app.
 PlotUI provides views and view modifiers for creating plots.
 
 Define your plot using the ``PlotView`` structure, and populate it with concrete data
-representation, like ``BarView``, to render data in your app's user interface.
+representation, like ``BarView`` or ``LineView``, to render data in your app's user
+interface.
 
 ![Logo](logo.png)
+
+## Topics
+
+### Essentials
+
+- ``PlotView``
+- ``HAxis``
+- ``VAxis``
+- ``Tick``
+
+### Creating Plots
+
+- ``BarView``
+- ``LineView``