Skip to content

Commit c902c13

Browse files
committed
doc: add scissor links to various objects
1 parent 0423ced commit c902c13

File tree

11 files changed

+12
-1
lines changed

11 files changed

+12
-1
lines changed

lib/scenic/primitive/arc.ex

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,9 @@ defmodule Scenic.Primitive.Arc do
3737
3838
This primitive recognizes the following styles
3939
* [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
40+
* [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
4041
* [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
41-
* [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
42+
* [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
4243
4344
## Usage
4445

lib/scenic/primitive/circle.ex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ defmodule Scenic.Primitive.Circle do
1818
1919
This primitive recognizes the following styles
2020
* [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
21+
* [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
2122
* [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
2223
* [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
2324

lib/scenic/primitive/ellipse.ex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ defmodule Scenic.Primitive.Ellipse do
1919
2020
This primitive recognizes the following styles
2121
* [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
22+
* [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
2223
* [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
2324
* [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
2425

lib/scenic/primitive/line.ex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ defmodule Scenic.Primitive.Line do
1919
2020
This primitive recognizes the following styles
2121
* [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
22+
* [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
2223
* [`cap`](Scenic.Primitive.Style.Cap.html) - says how to draw the ends of the line.
2324
* [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
2425

lib/scenic/primitive/path.ex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ defmodule Scenic.Primitive.Path do
1818
1919
This primitive recognizes the following styles
2020
* [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
21+
* [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
2122
* [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
2223
* [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
2324
* [`cap`](Scenic.Primitive.Style.Cap.html) - says how to draw the ends of the line.

lib/scenic/primitive/quad.ex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ defmodule Scenic.Primitive.Quad do
2121
2222
This primitive recognizes the following styles
2323
* [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
24+
* [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
2425
* [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
2526
* [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
2627
* [`join`](Scenic.Primitive.Style.Join.html) - control how segments are joined.

lib/scenic/primitive/rectangle.ex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ defmodule Scenic.Primitive.Rectangle do
1919
2020
This primitive recognizes the following styles
2121
* [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
22+
* [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
2223
* [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
2324
* [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
2425
* [`join`](Scenic.Primitive.Style.Join.html) - control how segments are joined.

lib/scenic/primitive/rounded_rectangle.ex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ defmodule Scenic.Primitive.RoundedRectangle do
2020
2121
This primitive recognizes the following styles
2222
* [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
23+
* [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
2324
* [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
2425
* [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
2526

lib/scenic/primitive/sector.ex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ defmodule Scenic.Primitive.Sector do
2929
3030
This primitive recognizes the following styles
3131
* [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
32+
* [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
3233
* [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the primitive
3334
* [`stroke`](Scenic.Primitive.Style.Stroke.html) - stroke the outline of the primitive. In this case, only the curvy part.
3435

lib/scenic/primitive/text.ex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ defmodule Scenic.Primitive.Text do
1818
1919
This primitive recognizes the following styles
2020
* [`hidden`](Scenic.Primitive.Style.Hidden.html) - show or hide the primitive
21+
* [`scissor`](Scenic.Primitive.Style.Scissor.html) - "scissor rectangle" that drawing will be clipped to.
2122
* [`fill`](Scenic.Primitive.Style.Fill.html) - fill in the area of the text. Only solid colors!
2223
* [`font`](Scenic.Primitive.Style.Font.html) - name (or key) of font to use
2324
* [`font_size`](Scenic.Primitive.Style.FontSize.html) - point size of the font

0 commit comments

Comments
 (0)