basic package docs

buchanae · Jan 8, 2020 · 63364e2 · 63364e2
1 parent b601807
commit 63364e2
Show file tree

Hide file tree

Showing 21 changed files with 32 additions and 4 deletions.
diff --git a/app/build.go b/app/build.go
@@ -7,7 +7,7 @@ import (
 	"github.com/buchanae/ink/color"
 	"github.com/buchanae/ink/dd"
 	"github.com/buchanae/ink/gfx"
-	"github.com/buchanae/ink/glsl"
+	"github.com/buchanae/ink/internal/glsl"
 	"github.com/buchanae/ink/render"
 )
 

diff --git a/app/doc.go b/app/doc.go
@@ -0,0 +1,2 @@
+// Package app contains the high-level Ink application.
+package app
diff --git a/cmd/ink/main.go b/cmd/ink/main.go
@@ -15,7 +15,7 @@ import (
 
 	"github.com/buchanae/ink/app"
 	"github.com/buchanae/ink/gfx"
-	"github.com/buchanae/ink/trace"
+	"github.com/buchanae/ink/internal/trace"
 )
 
 func init() {

diff --git a/color/doc.go b/color/doc.go
@@ -0,0 +1,3 @@
+// Package color contains types and utilities for working with color,
+// and a list of predefined colors and palettes.
+package color
diff --git a/dd/doc.go b/dd/doc.go
@@ -0,0 +1,2 @@
+// Package dd contains 2D types, utilities, and algorithms.
+package dd
diff --git a/gfx/gfx.go b/gfx/gfx.go
@@ -1,3 +1,4 @@
+// Package gfx contains types for drawing graphics to an Ink application.
 package gfx
 
 import (

diff --git a/internal/glsl/doc.go b/internal/glsl/doc.go
@@ -0,0 +1,2 @@
+// Package glsl contains code for inspecting GLSL shader code.
+package glsl
diff --git a/glsl/glsl.go → internal/glsl/glsl.go b/glsl/glsl.go → internal/glsl/glsl.go
diff --git a/glsl/inspect_test.go → internal/glsl/inspect_test.go b/glsl/inspect_test.go → internal/glsl/inspect_test.go
diff --git a/internal/trace/doc.go b/internal/trace/doc.go
@@ -0,0 +1,2 @@
+// Package trace contains internal logging and timing utilities.
+package trace
diff --git a/trace/trace.go → internal/trace/trace.go b/trace/trace.go → internal/trace/trace.go
diff --git a/math/doc.go b/math/doc.go
@@ -0,0 +1,2 @@
+// Package math contains float32 math functions
+package math
diff --git a/rand/doc.go b/rand/doc.go
@@ -0,0 +1,2 @@
+// Package rand contains random data generators.
+package rand
diff --git a/raster/doc.go b/raster/doc.go
@@ -0,0 +1,2 @@
+// Package raster contains a simple scanline triangle rasterizer.
+package raster
diff --git a/render/doc.go b/render/doc.go
@@ -0,0 +1,2 @@
+// Package render implements a low-level OpenGL renderer.
+package render
diff --git a/render/plan.go b/render/plan.go
@@ -4,7 +4,7 @@ import (
 	"image"
 	"log"
 
-	"github.com/buchanae/ink/trace"
+	"github.com/buchanae/ink/internal/trace"
 	"github.com/go-gl/gl/v3.3-core/gl"
 )
 

diff --git a/render/renderer.go b/render/renderer.go
@@ -4,7 +4,7 @@ import (
 	"image"
 	"log"
 
-	"github.com/buchanae/ink/trace"
+	"github.com/buchanae/ink/internal/trace"
 	"github.com/go-gl/gl/v3.3-core/gl"
 )
 

diff --git a/svg/doc.go b/svg/doc.go
@@ -0,0 +1,2 @@
+// Package svg contains utilities for parsing and triangulating SVG shapes
+package svg
diff --git a/tess/doc.go b/tess/doc.go
@@ -0,0 +1,2 @@
+// Package tess implements mesh triangulation.
+package tess
diff --git a/voronoi/doc.go b/voronoi/doc.go
@@ -0,0 +1,2 @@
+// Package voronoi contains utilities for creating a voronoi tesselation.
+package voronoi
diff --git a/win/doc.go b/win/doc.go
@@ -0,0 +1,2 @@
+// Package win contains low-level types for opening a window.
+package win
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package app contains the high-level Ink application.
		package app
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package dd contains 2D types, utilities, and algorithms.
		package dd
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package glsl contains code for inspecting GLSL shader code.
		package glsl
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package trace contains internal logging and timing utilities.
		package trace
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package math contains float32 math functions
		package math
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package rand contains random data generators.
		package rand
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package raster contains a simple scanline triangle rasterizer.
		package raster
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package render implements a low-level OpenGL renderer.
		package render
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,7 @@ import ( @@
     	"image"
     	"log"
-    	"github.com/buchanae/ink/trace"
+    	"github.com/buchanae/ink/internal/trace"
     	"github.com/go-gl/gl/v3.3-core/gl"
     )
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package svg contains utilities for parsing and triangulating SVG shapes
		package svg