Permalink
Browse files

add package doc strings

  • Loading branch information...
olt committed May 22, 2015
1 parent 150e261 commit 519caee2668c9821c20b220904e825be04187a76
View
@@ -1,3 +1,4 @@
+// Package builder implements converter from CartoCSS to Mapnik/MapServer styles.
package builder
import (
@@ -1,3 +1,4 @@
+// Package mapserver builds Mapnik .xml files.
package mapnik
import (
@@ -1,3 +1,4 @@
+// Package mapserver builds MapServer .map files.
package mapserver
import (
View
@@ -1,3 +1,4 @@
+// Package sql modifies SQL queries.
package sql
import (
@@ -1,3 +1,4 @@
+// The magnacarto command converts CartoCSS to Mapnik/MapServer styles.
package main
import (
View
@@ -1,3 +1,4 @@
+// Package color implements color functions.
package color
import (
View
@@ -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 {
View
7 doc.go
@@ -0,0 +1,7 @@
+/*
+Magnacarto converts CartoCSS map styles to Mapnik and MapServer styles.
+
+ magnacarto -mml project.mml > mapnik.xml
+
+*/
+package magnacarto
View
@@ -1,3 +1,4 @@
+// Package mml parses mml-JSON files.
package mml
import (
View
@@ -1,3 +1,4 @@
+// Package mss implements a CartoCSS parser and rule generator.
package mss
import "math"
View
@@ -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
View
@@ -0,0 +1,2 @@
+// Package render implements map renderers baseed on Mapnik and MapServer.
+package render

0 comments on commit 519caee

Please sign in to comment.