add package doc strings

builder/builder.go

@@ -1,3 +1,4 @@
+// Package builder implements converter from CartoCSS to Mapnik/MapServer styles.
 package builder
 
 import (

builder/mapnik/serialize.go

@@ -1,3 +1,4 @@
+// Package mapserver builds Mapnik .xml files.
 package mapnik
 
 import (

builder/mapserver/mapfile.go

@@ -1,3 +1,4 @@
+// Package mapserver builds MapServer .map files.
 package mapserver
 
 import (

builder/sql/sql.go

@@ -1,3 +1,4 @@
+// Package sql modifies SQL queries.
 package sql
 
 import (

cmd/magnacarto/magnacarto.go

@@ -1,3 +1,4 @@
+// The magnacarto command converts CartoCSS to Mapnik/MapServer styles.
 package main
 
 import (

color/color.go

@@ -1,3 +1,4 @@
+// Package color implements color functions.
 package color
 
 import (

config/config.go

@@ -1,3 +1,4 @@
+// Package config implements configuration file parser for magnacarto.
 package config
 
 import (
@@ -6,8 +7,8 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/omniscale/magnacarto/mml"
 	"github.com/BurntSushi/toml"
+	"github.com/omniscale/magnacarto/mml"
 )
 
 type Magnacarto struct {

doc.go

@@ -0,0 +1,7 @@
+/*
+Magnacarto converts CartoCSS map styles to Mapnik and MapServer styles.
+
+    magnacarto -mml project.mml > mapnik.xml
+
+*/
+package magnacarto

mml/mml.go

@@ -1,3 +1,4 @@
+// Package mml parses mml-JSON files.
 package mml
 
 import (

mss/mss.go

@@ -1,3 +1,4 @@
+// Package mss implements a CartoCSS parser and rule generator.
 package mss
 
 import "math"

regression/regression.go

@@ -1,4 +1,4 @@
-// Package regression contains regression tests for magnacarto.
+// Package regression only contains regression tests for magnacarto.
+package regression
 
 //  There is no code except tests here.
-package regression

render/doc.go

@@ -0,0 +1,2 @@
+// Package render implements map renderers baseed on Mapnik and MapServer.
+package render