working on docs for styles

Author: boydm

lib/scenic/primitive/arc.ex

@@ -28,9 +28,9 @@ defmodule Scenic.Primitive.Arc do
   ## Styles
 
   This primitive recognizes the following styles
-  * `hidden` - show or hide the primitive
-  * `fill` - fill in the area of the primitive
-  * `stroke` - stroke the outline of the primitive. In this case, only the curvy part.
+  * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
+  * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
   """
 
   use Scenic.Primitive

lib/scenic/primitive/circle.ex

@@ -17,9 +17,9 @@ defmodule Scenic.Primitive.Circle do
   ## Styles
 
   This primitive recognizes the following styles
-  * `hidden` - show or hide the primitive
-  * `fill` - fill in the area of the primitive
-  * `stroke` - stroke the outline of the primitive.
+  * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
+  * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
   """
 
   use Scenic.Primitive

lib/scenic/primitive/ellipse.ex

@@ -18,9 +18,9 @@ defmodule Scenic.Primitive.Ellipse do
   ## Styles
 
   This primitive recognizes the following styles
-  * `hidden` - show or hide the primitive
-  * `fill` - fill in the area of the primitive
-  * `stroke` - stroke the outline of the primitive.
+  * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
+  * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
 
   Note: you can achieve the same effect with a Circle primitive
   by applying a :size transform to it with unequal values on the axes

lib/scenic/primitive/line.ex

@@ -18,11 +18,11 @@ defmodule Scenic.Primitive.Line do
   ## Styles
 
   This primitive recognizes the following styles
-  * `hidden` - show or hide the primitive
-  * `cap` - says how to draw the ends of the line.
-  * `stroke` - stroke the outline of the primitive.
+  * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`cap`](Scenic.Primitive.Style.Cap.html) - says how to draw the ends of the line.
+  * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
   """
-
+  
   use Scenic.Primitive
 
   #  import IEx

lib/scenic/primitive/path.ex

@@ -17,9 +17,12 @@ defmodule Scenic.Primitive.Path do
   ## Styles
 
   This primitive recognizes the following styles
-  * `hidden` - show or hide the primitive
-  * `fill` - fill in the area of the primitive
-  * `stroke` - stroke the outline of the primitive.
+  * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
+  * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
+  * [`cap`](Scenic.Primitive.Style.Cap.html) - says how to draw the ends of the line.
+  * [`join`](Scenic.Primitive.Style.Join.html) - control how segments are joined.
+  * [`miter_limit`](Scenic.Primitive.Style.MiterLimit.html) - control how segments are joined.
 
   ## Commands
 
@@ -38,7 +41,7 @@ defmodule Scenic.Primitive.Path do
 
   #  import IEx
 
-  @styles [:hidden, :fill, :stroke]
+  @styles [:hidden, :fill, :stroke, :cap, :join, :miter_limit]
 
   # ============================================================================
   # data verification and serialization

lib/scenic/primitive/quad.ex

@@ -20,9 +20,11 @@ defmodule Scenic.Primitive.Quad do
   ## Styles
 
   This primitive recognizes the following styles
-  * `hidden` - show or hide the primitive
-  * `fill` - fill in the area of the primitive
-  * `stroke` - stroke the outline of the primitive.
+  * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
+  * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
+  * [`join`](Scenic.Primitive.Style.Join.html) - control how segments are joined.
+  * [`miter_limit`](Scenic.Primitive.Style.MiterLimit.html) - control how segments are joined.
   """
 
   use Scenic.Primitive
@@ -31,7 +33,7 @@ defmodule Scenic.Primitive.Quad do
 
   #  import IEx
 
-  @styles [:hidden, :fill, :stroke]
+  @styles [:hidden, :fill, :stroke, :join, :miter_limit]
 
   # ============================================================================
   # data verification and serialization

lib/scenic/primitive/rectangle.ex

@@ -18,14 +18,16 @@ defmodule Scenic.Primitive.Rectangle do
   ## Styles
 
   This primitive recognizes the following styles
-  * `hidden` - show or hide the primitive
-  * `fill` - fill in the area of the primitive
-  * `stroke` - stroke the outline of the primitive.
+  * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
+  * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
+  * [`join`](Scenic.Primitive.Style.Join.html) - control how segments are joined.
+  * [`miter_limit`](Scenic.Primitive.Style.MiterLimit.html) - control how segments are joined.
   """
 
   use Scenic.Primitive
 
-  @styles [:hidden, :fill, :stroke]
+  @styles [:hidden, :fill, :stroke, :join, :miter_limit]
 
   # ============================================================================
   # data verification and serialization

lib/scenic/primitive/rounded_rectangle.ex

@@ -19,9 +19,9 @@ defmodule Scenic.Primitive.RoundedRectangle do
   ## Styles
 
   This primitive recognizes the following styles
-  * `hidden` - show or hide the primitive
-  * `fill` - fill in the area of the primitive
-  * `stroke` - stroke the outline of the primitive.
+  * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
+  * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
   """
 
   use Scenic.Primitive

lib/scenic/primitive/sector.ex

@@ -21,9 +21,9 @@ defmodule Scenic.Primitive.Sector do
   ## Styles
 
   This primitive recognizes the following styles
-  * `hidden` - show or hide the primitive
-  * `fill` - fill in the area of the primitive
-  * `stroke` - stroke the outline of the primitive. In this case, only the curvy part.
+  * [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
+  * [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
+  * [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
   """
 
   use Scenic.Primitive

lib/scenic/primitive/style/cap.ex

@@ -4,14 +4,27 @@
 #
 
 defmodule Scenic.Primitive.Style.Cap do
-  @moduledoc false
+  @moduledoc """
+  Set how to draw the end of a line.
+
+  Example:
+
+      graph
+      |> line({{0,0}, {100,100}}, cap: :round)
+
+  ## Data
+  * `:butt` - End of the line is flat, passing through the end point.
+  * `:round` - End of the line is round, radiating from the end point.
+  * `:square` - End of the line is flat, but projecting a square around the end point.
+  """
 
   use Scenic.Primitive.Style
 
   # ============================================================================
   # data verification and serialization
 
   # --------------------------------------------------------
+  @doc false
   def info(data),
     do: """
       #{IO.ANSI.red()}#{__MODULE__} data must be one of :butt, :round, :square
@@ -21,7 +34,7 @@ defmodule Scenic.Primitive.Style.Cap do
 
   # --------------------------------------------------------
   # named color
-
+  @doc false
   def verify(stroke) do
     try do
       normalize(stroke)
@@ -32,7 +45,7 @@ defmodule Scenic.Primitive.Style.Cap do
   end
 
   # --------------------------------------------------------
-
+  @doc false
   def normalize(:butt), do: :butt
   def normalize(:round), do: :round
   def normalize(:square), do: :square