From b38232ee245ca678e04ecdc1d02b52e6f0e076e8 Mon Sep 17 00:00:00 2001 From: Sasha Koshka Date: Thu, 9 Feb 2023 15:05:13 -0500 Subject: [PATCH] More documentation! --- artist/doc.go | 5 +++++ canvas/doc.go | 4 ++++ elements/core/doc.go | 4 ++-- elements/fun/music/doc.go | 4 ++++ elements/fun/music/music.go | 1 + textmanip/doc.go | 3 +++ 6 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 artist/doc.go create mode 100644 canvas/doc.go create mode 100644 elements/fun/music/doc.go create mode 100644 textmanip/doc.go diff --git a/artist/doc.go b/artist/doc.go new file mode 100644 index 0000000..388f29e --- /dev/null +++ b/artist/doc.go @@ -0,0 +1,5 @@ +// Package artist provides a simple 2D drawing library for canvas.Canvas. +// Artist's drawing functions take in things called patterns, which are sampled +// as a source in order to color and texture drawn shapes. Patterns can be +// mixed together and composited to create new, more complex patterns. +package artist diff --git a/canvas/doc.go b/canvas/doc.go new file mode 100644 index 0000000..084d0cb --- /dev/null +++ b/canvas/doc.go @@ -0,0 +1,4 @@ +// Package canvas provides a canvas interface that is able to return a pixel +// buffer for drawing. This makes it considerably more efficient than the +// standard draw.Image. +package canvas diff --git a/elements/core/doc.go b/elements/core/doc.go index 09bdd65..5870f79 100644 --- a/elements/core/doc.go +++ b/elements/core/doc.go @@ -2,6 +2,6 @@ // interfaces without having to duplicate a ton of code. Each "core" is a type // that can be embedded into an element directly, working to fulfill a // particular interface. Each one comes with a corresponding core control, which -// provides an interface for elements to exert control over the core. They -// should be kept private. +// provides an interface for elements to exert control over the core. Core +// controls should be kept private. package core diff --git a/elements/fun/music/doc.go b/elements/fun/music/doc.go new file mode 100644 index 0000000..33f9110 --- /dev/null +++ b/elements/fun/music/doc.go @@ -0,0 +1,4 @@ +// Package music provides types relating to music theory and the math behind it. +// It is used in the fun.Piano element, and in the piano example to generate +// pitches from notes. +package music diff --git a/elements/fun/music/music.go b/elements/fun/music/music.go index badb2a3..90dd61d 100644 --- a/elements/fun/music/music.go +++ b/elements/fun/music/music.go @@ -43,6 +43,7 @@ const ( NoteBb0 NoteB0 + // nice NoteA4 Note = 69 ) diff --git a/textmanip/doc.go b/textmanip/doc.go new file mode 100644 index 0000000..da1e031 --- /dev/null +++ b/textmanip/doc.go @@ -0,0 +1,3 @@ +// Package textmanip provides text manipulation functions that are useful for +// creating editable text fields. +package textmanip