From 52fb1dfd6ec59a29226394184616e31433dc4ad5 Mon Sep 17 00:00:00 2001 From: Oliver Tonnhofer Date: Mon, 2 Sep 2013 10:26:29 +0200 Subject: [PATCH] add package descriptions --- cache/binary/doc.go | 4 ++++ cache/doc.go | 4 ++++ cache/query/doc.go | 4 ++++ config/doc.go | 4 ++++ database/doc.go | 4 ++++ database/postgis/doc.go | 4 ++++ diff/doc.go | 4 ++++ diff/parser/doc.go | 4 ++++ diff/state/doc.go | 4 ++++ element/doc.go | 4 ++++ geom/doc.go | 4 ++++ geom/geos/doc.go | 4 ++++ geom/limit/doc.go | 4 ++++ geom/ogr/doc.go | 4 ++++ logging/doc.go | 4 ++++ mapping/doc.go | 4 ++++ parser/pbf/doc.go | 6 ++++++ proj/doc.go | 4 ++++ reader/doc.go | 4 ++++ stats/doc.go | 4 ++++ writer/doc.go | 4 ++++ 21 files changed, 86 insertions(+) create mode 100644 cache/binary/doc.go create mode 100644 cache/doc.go create mode 100644 cache/query/doc.go create mode 100644 config/doc.go create mode 100644 database/doc.go create mode 100644 database/postgis/doc.go create mode 100644 diff/doc.go create mode 100644 diff/parser/doc.go create mode 100644 diff/state/doc.go create mode 100644 element/doc.go create mode 100644 geom/doc.go create mode 100644 geom/geos/doc.go create mode 100644 geom/limit/doc.go create mode 100644 geom/ogr/doc.go create mode 100644 logging/doc.go create mode 100644 mapping/doc.go create mode 100644 parser/pbf/doc.go create mode 100644 proj/doc.go create mode 100644 reader/doc.go create mode 100644 stats/doc.go create mode 100644 writer/doc.go diff --git a/cache/binary/doc.go b/cache/binary/doc.go new file mode 100644 index 0000000..a1d9cad --- /dev/null +++ b/cache/binary/doc.go @@ -0,0 +1,4 @@ +/* +Package binary provides functions for (un)marshaling cache data. +*/ +package binary diff --git a/cache/doc.go b/cache/doc.go new file mode 100644 index 0000000..0db6dc8 --- /dev/null +++ b/cache/doc.go @@ -0,0 +1,4 @@ +/* +Package cache implements caches for coords, nodes, ways and relations data. +*/ +package cache diff --git a/cache/query/doc.go b/cache/query/doc.go new file mode 100644 index 0000000..9d30f0d --- /dev/null +++ b/cache/query/doc.go @@ -0,0 +1,4 @@ +/* +Package query provides the query-cache sub command for debugging and testing. +*/ +package query diff --git a/config/doc.go b/config/doc.go new file mode 100644 index 0000000..1b81846 --- /dev/null +++ b/config/doc.go @@ -0,0 +1,4 @@ +/* +Package config provides functions for parsing command line args and JSON config. +*/ +package config diff --git a/database/doc.go b/database/doc.go new file mode 100644 index 0000000..5a76b26 --- /dev/null +++ b/database/doc.go @@ -0,0 +1,4 @@ +/* +Package database defines interfaces to be implemented. +*/ +package database diff --git a/database/postgis/doc.go b/database/postgis/doc.go new file mode 100644 index 0000000..b150e19 --- /dev/null +++ b/database/postgis/doc.go @@ -0,0 +1,4 @@ +/* +Package postgis implements the database interfaces for PostGIS. +*/ +package postgis diff --git a/diff/doc.go b/diff/doc.go new file mode 100644 index 0000000..692fb5c --- /dev/null +++ b/diff/doc.go @@ -0,0 +1,4 @@ +/* +Package diff provides the diff sub command for updating with diff files. +*/ +package diff diff --git a/diff/parser/doc.go b/diff/parser/doc.go new file mode 100644 index 0000000..9b073b3 --- /dev/null +++ b/diff/parser/doc.go @@ -0,0 +1,4 @@ +/* +Package parser provides a parser for OSM diff files in XML format. +*/ +package parser diff --git a/diff/state/doc.go b/diff/state/doc.go new file mode 100644 index 0000000..2099c7c --- /dev/null +++ b/diff/state/doc.go @@ -0,0 +1,4 @@ +/* +Package state provides functions for reading and writing diff status files. +*/ +package state diff --git a/element/doc.go b/element/doc.go new file mode 100644 index 0000000..37e4570 --- /dev/null +++ b/element/doc.go @@ -0,0 +1,4 @@ +/* +Package element provides basic types for OSM elements (coords/nodes/ways/relations/etc). +*/ +package element diff --git a/geom/doc.go b/geom/doc.go new file mode 100644 index 0000000..7b38a47 --- /dev/null +++ b/geom/doc.go @@ -0,0 +1,4 @@ +/* +Package geom provides functions for building geometries. +*/ +package geom diff --git a/geom/geos/doc.go b/geom/geos/doc.go new file mode 100644 index 0000000..51aa0ca --- /dev/null +++ b/geom/geos/doc.go @@ -0,0 +1,4 @@ +/* +Package geos provides a wrapper to the GEOS library. +*/ +package geos diff --git a/geom/limit/doc.go b/geom/limit/doc.go new file mode 100644 index 0000000..c5ee112 --- /dev/null +++ b/geom/limit/doc.go @@ -0,0 +1,4 @@ +/* +Package limit provides functions to clip geometries at polygon boundaries. +*/ +package limit diff --git a/geom/ogr/doc.go b/geom/ogr/doc.go new file mode 100644 index 0000000..f68871b --- /dev/null +++ b/geom/ogr/doc.go @@ -0,0 +1,4 @@ +/* +Package ogr provides a wrapper to the GDAL/OGR library. +*/ +package ogr diff --git a/logging/doc.go b/logging/doc.go new file mode 100644 index 0000000..5bf85de --- /dev/null +++ b/logging/doc.go @@ -0,0 +1,4 @@ +/* +Package logging provides a simple framework for reporting messages and the import progress. +*/ +package logging diff --git a/mapping/doc.go b/mapping/doc.go new file mode 100644 index 0000000..0657cdc --- /dev/null +++ b/mapping/doc.go @@ -0,0 +1,4 @@ +/* +Package mapping provides functions for defining and executing the database schema. +*/ +package mapping diff --git a/parser/pbf/doc.go b/parser/pbf/doc.go new file mode 100644 index 0000000..b4467a8 --- /dev/null +++ b/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 diff --git a/proj/doc.go b/proj/doc.go new file mode 100644 index 0000000..af1dd08 --- /dev/null +++ b/proj/doc.go @@ -0,0 +1,4 @@ +/* +Package proj provides functions for coordinate transformations. +*/ +package proj diff --git a/reader/doc.go b/reader/doc.go new file mode 100644 index 0000000..a5d029a --- /dev/null +++ b/reader/doc.go @@ -0,0 +1,4 @@ +/* +Package reader orchestrates the reading part of the import process. +*/ +package reader diff --git a/stats/doc.go b/stats/doc.go new file mode 100644 index 0000000..fac2ed1 --- /dev/null +++ b/stats/doc.go @@ -0,0 +1,4 @@ +/* +Package stats provides functions to collect statistics about the import process. +*/ +package stats diff --git a/writer/doc.go b/writer/doc.go new file mode 100644 index 0000000..ba6dcff --- /dev/null +++ b/writer/doc.go @@ -0,0 +1,4 @@ +/* +Package writer orchestrates the writing part of the import process. +*/ +package writer