add package descriptions

cache/binary/doc.go

@@ -0,0 +1,4 @@
+/*
+Package binary provides functions for (un)marshaling cache data.
+*/
+package binary

cache/doc.go

@@ -0,0 +1,4 @@
+/*
+Package cache implements caches for coords, nodes, ways and relations data.
+*/
+package cache

cache/query/doc.go

@@ -0,0 +1,4 @@
+/*
+Package query provides the query-cache sub command for debugging and testing.
+*/
+package query

config/doc.go

@@ -0,0 +1,4 @@
+/*
+Package config provides functions for parsing command line args and JSON config.
+*/
+package config

database/doc.go

@@ -0,0 +1,4 @@
+/*
+Package database defines interfaces to be implemented.
+*/
+package database

database/postgis/doc.go

@@ -0,0 +1,4 @@
+/*
+Package postgis implements the database interfaces for PostGIS.
+*/
+package postgis

diff/doc.go

@@ -0,0 +1,4 @@
+/*
+Package diff provides the diff sub command for updating with diff files.
+*/
+package diff

diff/parser/doc.go

@@ -0,0 +1,4 @@
+/*
+Package parser provides a parser for OSM diff files in XML format.
+*/
+package parser

diff/state/doc.go

@@ -0,0 +1,4 @@
+/*
+Package state provides functions for reading and writing diff status files.
+*/
+package state

element/doc.go

@@ -0,0 +1,4 @@
+/*
+Package element provides basic types for OSM elements (coords/nodes/ways/relations/etc).
+*/
+package element

geom/doc.go

@@ -0,0 +1,4 @@
+/*
+Package geom provides functions for building geometries.
+*/
+package geom

geom/geos/doc.go

@@ -0,0 +1,4 @@
+/*
+Package geos provides a wrapper to the GEOS library.
+*/
+package geos

geom/limit/doc.go

@@ -0,0 +1,4 @@
+/*
+Package limit provides functions to clip geometries at polygon boundaries.
+*/
+package limit

geom/ogr/doc.go

@@ -0,0 +1,4 @@
+/*
+Package ogr provides a wrapper to the GDAL/OGR library.
+*/
+package ogr

logging/doc.go

@@ -0,0 +1,4 @@
+/*
+Package logging provides a simple framework for reporting messages and the import progress.
+*/
+package logging

mapping/doc.go

@@ -0,0 +1,4 @@
+/*
+Package mapping provides functions for defining and executing the database schema.
+*/
+package mapping

parser/pbf/doc.go

@@ -0,0 +1,6 @@
+/*
+Package pbf provides functions for parsing OSM PBF files.
+
+The subpackage osmpbf contains the generated code for the OSM .proto files.
+*/
+package cache

proj/doc.go

@@ -0,0 +1,4 @@
+/*
+Package proj provides functions for coordinate transformations.
+*/
+package proj

reader/doc.go

@@ -0,0 +1,4 @@
+/*
+Package reader orchestrates the reading part of the import process.
+*/
+package reader

stats/doc.go

@@ -0,0 +1,4 @@
+/*
+Package stats provides functions to collect statistics about the import process.
+*/
+package stats

writer/doc.go

@@ -0,0 +1,4 @@
+/*
+Package writer orchestrates the writing part of the import process.
+*/
+package writer