add fix all package level docs

This commit is contained in:
Matt Jaffee 2017-04-18 14:11:42 -05:00
parent 89219643a7
commit 0a324d14a5
6 changed files with 19 additions and 3 deletions

4
cmd/doc.go Normal file
View file

@ -0,0 +1,4 @@
/*
Package cmd contains all the pilosa subcommand definitions (1 per file).
*/
package cmd

View file

@ -1,3 +1,6 @@
/*
This is the entrypoint for the Pilosa binary.
*/
package main
import (

3
ctl/doc.go Normal file
View file

@ -0,0 +1,3 @@
// package ctl contains all pilosa subcommands other than 'server'. These are
// generally administration, testing, and debugging tools.
package ctl

4
doc.go
View file

@ -1,9 +1,7 @@
/*
Package pilosa implements the core of the Pilosa distributed bitmap index. It
contains all the core domain objects, interfaces, and high level logic that make
pilosa work.
contains all the domain objects, interfaces, and logic that defines pilosa.
*/
package pilosa

4
pql/doc.go Normal file
View file

@ -0,0 +1,4 @@
/*
Package pql defines the Pilosa Query Language.
*/
package pql

View file

@ -1,3 +1,7 @@
// package server contains the `pilosa server` subcommand which runs Pilosa
// itself. The purpose of this package is to define an easily tested Command
// object which handles interpreting configuration and setting up all the
// objects that Pilosa needs.
package server
import (