all: use fixdocs tool to store package documentation in doc.go

Add copyright header to doc.go

Keep original comment style (e.g. line comments and block comments).

Fix doc comments containing multiple line comments.

Remove vanity imports from all files except doc.go.

Fixes #12.

The source code of fixdocs is located at:
https://play.golang.org/p/7RtYLzldsO

blas/blas.go

@@ -4,110 +4,7 @@
 
 //go:generate ./conversions.bash
 
-/*
+package blas
-Package blas provides interfaces for the BLAS linear algebra standard.
-
-All methods must perform appropriate parameter checking and panic if
-provided parameters that do not conform to the requirements specified
-by the BLAS standard.
-
-Quick Reference Guide to the BLAS from http://www.netlib.org/lapack/lug/node145.html
-
-This version is modified to remove the "order" option. All matrix operations are
-on row-order matrices.
-
-Level 1 BLAS
-
-	        dim scalar vector   vector   scalars              5-element prefixes
-	                                                          struct
-
-	_rotg (                                      a, b )                S, D
-	_rotmg(                              d1, d2, a, b )                S, D
-	_rot  ( n,         x, incX, y, incY,               c, s )          S, D
-	_rotm ( n,         x, incX, y, incY,                      param )  S, D
-	_swap ( n,         x, incX, y, incY )                              S, D, C, Z
-	_scal ( n,  alpha, x, incX )                                       S, D, C, Z, Cs, Zd
-	_copy ( n,         x, incX, y, incY )                              S, D, C, Z
-	_axpy ( n,  alpha, x, incX, y, incY )                              S, D, C, Z
-	_dot  ( n,         x, incX, y, incY )                              S, D, Ds
-	_dotu ( n,         x, incX, y, incY )                              C, Z
-	_dotc ( n,         x, incX, y, incY )                              C, Z
-	__dot ( n,  alpha, x, incX, y, incY )                              Sds
-	_nrm2 ( n,         x, incX )                                       S, D, Sc, Dz
-	_asum ( n,         x, incX )                                       S, D, Sc, Dz
-	I_amax( n,         x, incX )                                       s, d, c, z
-
-Level 2 BLAS
-
-	        options                   dim   b-width scalar matrix  vector   scalar vector   prefixes
-
-	_gemv (        trans,      m, n,         alpha, a, lda, x, incX, beta,  y, incY ) S, D, C, Z
-	_gbmv (        trans,      m, n, kL, kU, alpha, a, lda, x, incX, beta,  y, incY ) S, D, C, Z
-	_hemv ( uplo,                 n,         alpha, a, lda, x, incX, beta,  y, incY ) C, Z
-	_hbmv ( uplo,                 n, k,      alpha, a, lda, x, incX, beta,  y, incY ) C, Z
-	_hpmv ( uplo,                 n,         alpha, ap,     x, incX, beta,  y, incY ) C, Z
-	_symv ( uplo,                 n,         alpha, a, lda, x, incX, beta,  y, incY ) S, D
-	_sbmv ( uplo,                 n, k,      alpha, a, lda, x, incX, beta,  y, incY ) S, D
-	_spmv ( uplo,                 n,         alpha, ap,     x, incX, beta,  y, incY ) S, D
-	_trmv ( uplo, trans, diag,    n,                a, lda, x, incX )                 S, D, C, Z
-	_tbmv ( uplo, trans, diag,    n, k,             a, lda, x, incX )                 S, D, C, Z
-	_tpmv ( uplo, trans, diag,    n,                ap,     x, incX )                 S, D, C, Z
-	_trsv ( uplo, trans, diag,    n,                a, lda, x, incX )                 S, D, C, Z
-	_tbsv ( uplo, trans, diag,    n, k,             a, lda, x, incX )                 S, D, C, Z
-	_tpsv ( uplo, trans, diag,    n,                ap,     x, incX )                 S, D, C, Z
-
-	        options                   dim   scalar vector   vector   matrix  prefixes
-
-	_ger  (                    m, n, alpha, x, incX, y, incY, a, lda ) S, D
-	_geru (                    m, n, alpha, x, incX, y, incY, a, lda ) C, Z
-	_gerc (                    m, n, alpha, x, incX, y, incY, a, lda ) C, Z
-	_her  ( uplo,                 n, alpha, x, incX,          a, lda ) C, Z
-	_hpr  ( uplo,                 n, alpha, x, incX,          ap )     C, Z
-	_her2 ( uplo,                 n, alpha, x, incX, y, incY, a, lda ) C, Z
-	_hpr2 ( uplo,                 n, alpha, x, incX, y, incY, ap )     C, Z
-	_syr  ( uplo,                 n, alpha, x, incX,          a, lda ) S, D
-	_spr  ( uplo,                 n, alpha, x, incX,          ap )     S, D
-	_syr2 ( uplo,                 n, alpha, x, incX, y, incY, a, lda ) S, D
-	_spr2 ( uplo,                 n, alpha, x, incX, y, incY, ap )     S, D
-
-Level 3 BLAS
-
-	        options                                 dim      scalar matrix  matrix  scalar matrix  prefixes
-
-	_gemm (             transA, transB,      m, n, k, alpha, a, lda, b, ldb, beta,  c, ldc ) S, D, C, Z
-	_symm ( side, uplo,                      m, n,    alpha, a, lda, b, ldb, beta,  c, ldc ) S, D, C, Z
-	_hemm ( side, uplo,                      m, n,    alpha, a, lda, b, ldb, beta,  c, ldc ) C, Z
-	_syrk (       uplo, trans,                  n, k, alpha, a, lda,         beta,  c, ldc ) S, D, C, Z
-	_herk (       uplo, trans,                  n, k, alpha, a, lda,         beta,  c, ldc ) C, Z
-	_syr2k(       uplo, trans,                  n, k, alpha, a, lda, b, ldb, beta,  c, ldc ) S, D, C, Z
-	_her2k(       uplo, trans,                  n, k, alpha, a, lda, b, ldb, beta,  c, ldc ) C, Z
-	_trmm ( side, uplo, transA,        diag, m, n,    alpha, a, lda, b, ldb )                S, D, C, Z
-	_trsm ( side, uplo, transA,        diag, m, n,    alpha, a, lda, b, ldb )                S, D, C, Z
-
-Meaning of prefixes
-
-	S - float32	C - complex64
-	D - float64	Z - complex128
-
-Matrix types
-
-	GE - GEneral 		GB - General Band
-	SY - SYmmetric 		SB - Symmetric Band 	SP - Symmetric Packed
-	HE - HErmitian 		HB - Hermitian Band 	HP - Hermitian Packed
-	TR - TRiangular 	TB - Triangular Band 	TP - Triangular Packed
-
-Options
-
-	trans 	= NoTrans, Trans, ConjTrans
-	uplo 	= Upper, Lower
-	diag 	= Nonunit, Unit
-	side 	= Left, Right (A or op(A) on the left, or A or op(A) on the right)
-
-For real matrices, Trans and ConjTrans have the same meaning.
-For Hermitian matrices, trans = Trans is not allowed.
-For complex symmetric matrices, trans = ConjTrans is not allowed.
-*/
-package blas // import "gonum.org/v1/gonum/blas"
 
 // Flag constants indicate Givens transformation H matrix state.
 type Flag int

blas/blas32/blas32.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package blas32 provides a simple interface to the float32 BLAS API.
+package blas32
-package blas32 // import "gonum.org/v1/gonum/blas/blas32"
 
 import (
 	"gonum.org/v1/gonum/blas"

blas/blas32/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package blas32 provides a simple interface to the float32 BLAS API.
+package blas32 // import "gonum.org/v1/gonum/blas/blas32"

blas/blas64/blas64.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package blas64 provides a simple interface to the float64 BLAS API.
+package blas64
-package blas64 // import "gonum.org/v1/gonum/blas/blas64"
 
 import (
 	"gonum.org/v1/gonum/blas"

blas/blas64/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package blas64 provides a simple interface to the float64 BLAS API.
+package blas64 // import "gonum.org/v1/gonum/blas/blas64"

blas/cblas128/cblas128.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package cblas128 provides a simple interface to the complex128 BLAS API.
+package cblas128
-package cblas128 // import "gonum.org/v1/gonum/blas/cblas128"
 
 import (
 	"gonum.org/v1/gonum/blas"

blas/cblas128/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package cblas128 provides a simple interface to the complex128 BLAS API.
+package cblas128 // import "gonum.org/v1/gonum/blas/cblas128"

blas/cblas64/cblas64.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package cblas64 provides a simple interface to the complex64 BLAS API.
+package cblas64
-package cblas64 // import "gonum.org/v1/gonum/blas/cblas64"
 
 import (
 	"gonum.org/v1/gonum/blas"

blas/cblas64/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package cblas64 provides a simple interface to the complex64 BLAS API.
+package cblas64 // import "gonum.org/v1/gonum/blas/cblas64"

blas/doc.go

@@ -0,0 +1,108 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+/*
+Package blas provides interfaces for the BLAS linear algebra standard.
+
+All methods must perform appropriate parameter checking and panic if
+provided parameters that do not conform to the requirements specified
+by the BLAS standard.
+
+Quick Reference Guide to the BLAS from http://www.netlib.org/lapack/lug/node145.html
+
+This version is modified to remove the "order" option. All matrix operations are
+on row-order matrices.
+
+Level 1 BLAS
+
+	        dim scalar vector   vector   scalars              5-element prefixes
+	                                                          struct
+
+	_rotg (                                      a, b )                S, D
+	_rotmg(                              d1, d2, a, b )                S, D
+	_rot  ( n,         x, incX, y, incY,               c, s )          S, D
+	_rotm ( n,         x, incX, y, incY,                      param )  S, D
+	_swap ( n,         x, incX, y, incY )                              S, D, C, Z
+	_scal ( n,  alpha, x, incX )                                       S, D, C, Z, Cs, Zd
+	_copy ( n,         x, incX, y, incY )                              S, D, C, Z
+	_axpy ( n,  alpha, x, incX, y, incY )                              S, D, C, Z
+	_dot  ( n,         x, incX, y, incY )                              S, D, Ds
+	_dotu ( n,         x, incX, y, incY )                              C, Z
+	_dotc ( n,         x, incX, y, incY )                              C, Z
+	__dot ( n,  alpha, x, incX, y, incY )                              Sds
+	_nrm2 ( n,         x, incX )                                       S, D, Sc, Dz
+	_asum ( n,         x, incX )                                       S, D, Sc, Dz
+	I_amax( n,         x, incX )                                       s, d, c, z
+
+Level 2 BLAS
+
+	        options                   dim   b-width scalar matrix  vector   scalar vector   prefixes
+
+	_gemv (        trans,      m, n,         alpha, a, lda, x, incX, beta,  y, incY ) S, D, C, Z
+	_gbmv (        trans,      m, n, kL, kU, alpha, a, lda, x, incX, beta,  y, incY ) S, D, C, Z
+	_hemv ( uplo,                 n,         alpha, a, lda, x, incX, beta,  y, incY ) C, Z
+	_hbmv ( uplo,                 n, k,      alpha, a, lda, x, incX, beta,  y, incY ) C, Z
+	_hpmv ( uplo,                 n,         alpha, ap,     x, incX, beta,  y, incY ) C, Z
+	_symv ( uplo,                 n,         alpha, a, lda, x, incX, beta,  y, incY ) S, D
+	_sbmv ( uplo,                 n, k,      alpha, a, lda, x, incX, beta,  y, incY ) S, D
+	_spmv ( uplo,                 n,         alpha, ap,     x, incX, beta,  y, incY ) S, D
+	_trmv ( uplo, trans, diag,    n,                a, lda, x, incX )                 S, D, C, Z
+	_tbmv ( uplo, trans, diag,    n, k,             a, lda, x, incX )                 S, D, C, Z
+	_tpmv ( uplo, trans, diag,    n,                ap,     x, incX )                 S, D, C, Z
+	_trsv ( uplo, trans, diag,    n,                a, lda, x, incX )                 S, D, C, Z
+	_tbsv ( uplo, trans, diag,    n, k,             a, lda, x, incX )                 S, D, C, Z
+	_tpsv ( uplo, trans, diag,    n,                ap,     x, incX )                 S, D, C, Z
+
+	        options                   dim   scalar vector   vector   matrix  prefixes
+
+	_ger  (                    m, n, alpha, x, incX, y, incY, a, lda ) S, D
+	_geru (                    m, n, alpha, x, incX, y, incY, a, lda ) C, Z
+	_gerc (                    m, n, alpha, x, incX, y, incY, a, lda ) C, Z
+	_her  ( uplo,                 n, alpha, x, incX,          a, lda ) C, Z
+	_hpr  ( uplo,                 n, alpha, x, incX,          ap )     C, Z
+	_her2 ( uplo,                 n, alpha, x, incX, y, incY, a, lda ) C, Z
+	_hpr2 ( uplo,                 n, alpha, x, incX, y, incY, ap )     C, Z
+	_syr  ( uplo,                 n, alpha, x, incX,          a, lda ) S, D
+	_spr  ( uplo,                 n, alpha, x, incX,          ap )     S, D
+	_syr2 ( uplo,                 n, alpha, x, incX, y, incY, a, lda ) S, D
+	_spr2 ( uplo,                 n, alpha, x, incX, y, incY, ap )     S, D
+
+Level 3 BLAS
+
+	        options                                 dim      scalar matrix  matrix  scalar matrix  prefixes
+
+	_gemm (             transA, transB,      m, n, k, alpha, a, lda, b, ldb, beta,  c, ldc ) S, D, C, Z
+	_symm ( side, uplo,                      m, n,    alpha, a, lda, b, ldb, beta,  c, ldc ) S, D, C, Z
+	_hemm ( side, uplo,                      m, n,    alpha, a, lda, b, ldb, beta,  c, ldc ) C, Z
+	_syrk (       uplo, trans,                  n, k, alpha, a, lda,         beta,  c, ldc ) S, D, C, Z
+	_herk (       uplo, trans,                  n, k, alpha, a, lda,         beta,  c, ldc ) C, Z
+	_syr2k(       uplo, trans,                  n, k, alpha, a, lda, b, ldb, beta,  c, ldc ) S, D, C, Z
+	_her2k(       uplo, trans,                  n, k, alpha, a, lda, b, ldb, beta,  c, ldc ) C, Z
+	_trmm ( side, uplo, transA,        diag, m, n,    alpha, a, lda, b, ldb )                S, D, C, Z
+	_trsm ( side, uplo, transA,        diag, m, n,    alpha, a, lda, b, ldb )                S, D, C, Z
+
+Meaning of prefixes
+
+	S - float32	C - complex64
+	D - float64	Z - complex128
+
+Matrix types
+
+	GE - GEneral 		GB - General Band
+	SY - SYmmetric 		SB - Symmetric Band 	SP - Symmetric Packed
+	HE - HErmitian 		HB - Hermitian Band 	HP - Hermitian Packed
+	TR - TRiangular 	TB - Triangular Band 	TP - Triangular Packed
+
+Options
+
+	trans 	= NoTrans, Trans, ConjTrans
+	uplo 	= Upper, Lower
+	diag 	= Nonunit, Unit
+	side 	= Left, Right (A or op(A) on the left, or A or op(A) on the right)
+
+For real matrices, Trans and ConjTrans have the same meaning.
+For Hermitian matrices, trans = Trans is not allowed.
+For complex symmetric matrices, trans = ConjTrans is not allowed.
+*/
+package blas // import "gonum.org/v1/gonum/blas"

blas/testblas/benchautogen/autogen_bench_level1double.go

@@ -2,7 +2,6 @@
 // Use of this code is governed by a BSD-style
 // license that can be found in the LICENSE file
 
-// Script for automatic code generation of the benchmark routines
 package main
 
 import (

blas/testblas/benchautogen/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Script for automatic code generation of the benchmark routines
+package main // import "gonum.org/v1/gonum/blas/testblas/benchautogen"

blas/testblas/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package testblas provides tests for blas implementations.
+package testblas // import "gonum.org/v1/gonum/blas/testblas"

blas/testblas/level1double.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package testblas provides tests for blas implementations.
+package testblas
-package testblas // import "gonum.org/v1/gonum/blas/testblas"
 
 import (
 	"fmt"

diff/fd/diff.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package fd provides functions to approximate derivatives using finite differences.
+package fd
-package fd // import "gonum.org/v1/gonum/diff/fd"
 
 import (
 	"math"

diff/fd/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package fd provides functions to approximate derivatives using finite differences.
+package fd // import "gonum.org/v1/gonum/diff/fd"

floats/doc.go

@@ -0,0 +1,11 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package floats provides a set of helper routines for dealing with slices
+// of float64. The functions avoid allocations to allow for use within tight
+// loops without garbage collection overhead.
+//
+// The convention used is that when a slice is being modified in place, it has
+// the name dst.
+package floats // import "gonum.org/v1/gonum/floats"

floats/floats.go

@@ -2,13 +2,7 @@
 // Use of this code is governed by a BSD-style
 // license that can be found in the LICENSE file
 
-// Package floats provides a set of helper routines for dealing with slices
+package floats
-// of float64. The functions avoid allocations to allow for use within tight
-// loops without garbage collection overhead.
-//
-// The convention used is that when a slice is being modified in place, it has
-// the name dst.
-package floats // import "gonum.org/v1/gonum/floats"
 
 import (
 	"errors"

graph/community/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package community provides graph community detection functions.
+package community // import "gonum.org/v1/gonum/graph/community"

graph/community/louvain_common.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package community provides graph community detection functions.
+package community
-package community // import "gonum.org/v1/gonum/graph/community"
 
 import (
 	"fmt"

graph/encoding/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package encoding provides a common graph encoding API.
+package encoding // import "gonum.org/v1/gonum/graph/encoding"

graph/encoding/dot/doc.go

@@ -0,0 +1,14 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package dot implements GraphViz DOT marshaling and unmarshaling of graphs.
+//
+// See the GraphViz DOT Guide and the DOT grammar for more information
+// on using specific aspects of the DOT language:
+//
+// DOT Guide: http://www.graphviz.org/Documentation/dotguide.pdf
+//
+// DOT grammar: http://www.graphviz.org/doc/info/lang.html
+//
+package dot // import "gonum.org/v1/gonum/graph/encoding/dot"

graph/encoding/dot/dot.go

@@ -2,13 +2,4 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package dot implements GraphViz DOT marshaling and unmarshaling of graphs.
+package dot
-//
-// See the GraphViz DOT Guide and the DOT grammar for more information
-// on using specific aspects of the DOT language:
-//
-// DOT Guide: http://www.graphviz.org/Documentation/dotguide.pdf
-//
-// DOT grammar: http://www.graphviz.org/doc/info/lang.html
-//
-package dot // import "gonum.org/v1/gonum/graph/encoding/dot"

graph/encoding/encoding.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package encoding provides a common graph encoding API.
+package encoding
-package encoding // import "gonum.org/v1/gonum/graph/encoding"
 
 import "gonum.org/v1/gonum/graph"
 

graph/encoding/graphql/doc.go

@@ -0,0 +1,7 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package graphql implements JSON marshaling and unmarshaling of graph as
+// used by GraphQL
+package graphql // import "gonum.org/v1/gonum/graph/encoding/graphql"

graph/encoding/graphql/graphql.go

@@ -2,6 +2,4 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package graphql implements JSON marshaling and unmarshaling of graph as
+package graphql
-// used by GraphQL
-package graphql // import "gonum.org/v1/gonum/graph/encoding/graphql"

graph/formats/dot/ast/ast.go

@@ -8,9 +8,7 @@
 // This file is made available under a Creative Commons CC0 1.0
 // Universal Public Domain Dedication.
 
-// Package ast declares the types used to represent abstract syntax trees of
+package ast
-// Graphviz DOT graphs.
-package ast // import "gonum.org/v1/gonum/graph/formats/dot/ast"
 
 import (
 	"bytes"

graph/formats/dot/ast/doc.go

@@ -0,0 +1,7 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package ast declares the types used to represent abstract syntax trees of
+// Graphviz DOT graphs.
+package ast // import "gonum.org/v1/gonum/graph/formats/dot/ast"

graph/formats/dot/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package dot implements a parser for Graphviz DOT files.
+package dot // import "gonum.org/v1/gonum/graph/formats/dot"

graph/formats/dot/dot.go

@@ -10,8 +10,7 @@
 
 //go:generate ./makeinternal.bash
 
-// Package dot implements a parser for Graphviz DOT files.
+package dot
-package dot // import "gonum.org/v1/gonum/graph/formats/dot"
 
 import (
 	"fmt"

graph/formats/dot/internal/astx/astx.go

@@ -8,9 +8,7 @@
 // This file is made available under a Creative Commons CC0 1.0
 // Universal Public Domain Dedication.
 
-// Package astx implements utility functions for generating abstract syntax
+package astx
-// trees of Graphviz DOT graphs.
-package astx // import "gonum.org/v1/gonum/graph/formats/dot/internal/astx"
 
 import (
 	"fmt"

graph/formats/dot/internal/astx/doc.go

@@ -0,0 +1,7 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package astx implements utility functions for generating abstract syntax
+// trees of Graphviz DOT graphs.
+package astx // import "gonum.org/v1/gonum/graph/formats/dot/internal/astx"

graph/graphs/gen/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package gen provides random graph generation functions.
+package gen // import "gonum.org/v1/gonum/graph/graphs/gen"

graph/graphs/gen/gen.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package gen provides random graph generation functions.
+package gen
-package gen // import "gonum.org/v1/gonum/graph/graphs/gen"
 
 import "gonum.org/v1/gonum/graph"
 

graph/internal/linear/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package linear provides common linear data structures.
+package linear // import "gonum.org/v1/gonum/graph/internal/linear"

graph/internal/linear/linear.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package linear provides common linear data structures.
+package linear
-package linear // import "gonum.org/v1/gonum/graph/internal/linear"
 
 import (
 	"gonum.org/v1/gonum/graph"

graph/internal/ordered/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package ordered provides common sort ordering types.
+package ordered // import "gonum.org/v1/gonum/graph/internal/ordered"

graph/internal/ordered/sort.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package ordered provides common sort ordering types.
+package ordered
-package ordered // import "gonum.org/v1/gonum/graph/internal/ordered"
 
 import "gonum.org/v1/gonum/graph"
 

graph/internal/set/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package set provides integer and graph.Node sets.
+package set // import "gonum.org/v1/gonum/graph/internal/set"

graph/internal/set/set.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package set provides integer and graph.Node sets.
+package set
-package set // import "gonum.org/v1/gonum/graph/internal/set"
 
 import "gonum.org/v1/gonum/graph"
 

graph/network/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package network provides network analysis functions.
+package network // import "gonum.org/v1/gonum/graph/network"

graph/network/network.go

@@ -10,5 +10,4 @@
 //    http://www.vldb.org/pvldb/vol7/p1023-maehara.pdf
 // * other centrality measures
 
-// Package network provides network analysis functions.
+package network
-package network // import "gonum.org/v1/gonum/graph/network"

graph/simple/doc.go

@@ -0,0 +1,7 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package simple provides a suite of simple graph implementations satisfying
+// the gonum/graph interfaces.
+package simple // import "gonum.org/v1/gonum/graph/simple"

graph/simple/simple.go

@@ -2,9 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package simple provides a suite of simple graph implementations satisfying
+package simple
-// the gonum/graph interfaces.
-package simple // import "gonum.org/v1/gonum/graph/simple"
 
 import (
 	"math"

graph/topo/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package topo provides graph topology analysis functions.
+package topo // import "gonum.org/v1/gonum/graph/topo"

graph/topo/topo.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package topo provides graph topology analysis functions.
+package topo
-package topo // import "gonum.org/v1/gonum/graph/topo"
 
 import (
 	"gonum.org/v1/gonum/graph"

graph/traverse/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package traverse provides basic graph traversal primitives.
+package traverse // import "gonum.org/v1/gonum/graph/traverse"

graph/traverse/traverse.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package traverse provides basic graph traversal primitives.
+package traverse
-package traverse // import "gonum.org/v1/gonum/graph/traverse"
 
 import (
 	"gonum.org/v1/gonum/graph"

integrate/quad/doc.go

@@ -0,0 +1,7 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package quad provides numerical evaluation of definite integrals of single-variable functions.
+//
+package quad // import "gonum.org/v1/gonum/integrate/quad"

integrate/quad/quad.go

@@ -2,9 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package quad provides numerical evaluation of definite integrals of single-variable functions.
+package quad
-//
-package quad // import "gonum.org/v1/gonum/integrate/quad"
 
 import (
 	"math"

internal/cmplx64/abs.go

@@ -6,8 +6,6 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package cmplx64 provides complex64 versions of standard library math/cmplx
-// package routines used by gonum/blas.
 package cmplx64
 
 import math "gonum.org/v1/gonum/internal/math32"

internal/cmplx64/doc.go

@@ -0,0 +1,7 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package cmplx64 provides complex64 versions of standard library math/cmplx
+// package routines used by gonum/blas.
+package cmplx64 // import "gonum.org/v1/gonum/internal/cmplx64"

internal/math32/doc.go

@@ -0,0 +1,7 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package math32 provides float32 versions of standard library math package
+// routines used by gonum/blas/native.
+package math32 // import "gonum.org/v1/gonum/internal/math32"

internal/math32/math.go

@@ -6,9 +6,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package math32 provides float32 versions of standard library math package
+package math32
-// routines used by gonum/blas/native.
-package math32 // import "gonum.org/v1/gonum/internal/math32"
 
 import (
 	"math"

lapack/lapack64/doc.go

@@ -0,0 +1,20 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package lapack64 provides a set of convenient wrapper functions for LAPACK
+// calls, as specified in the netlib standard (www.netlib.org).
+//
+// The native Go routines are used by default, and the Use function can be used
+// to set an alternative implementation.
+//
+// If the type of matrix (General, Symmetric, etc.) is known and fixed, it is
+// used in the wrapper signature. In many cases, however, the type of the matrix
+// changes during the call to the routine, for example the matrix is symmetric on
+// entry and is triangular on exit. In these cases the correct types should be checked
+// in the documentation.
+//
+// The full set of Lapack functions is very large, and it is not clear that a
+// full implementation is desirable, let alone feasible. Please open up an issue
+// if there is a specific function you need and/or are willing to implement.
+package lapack64 // import "gonum.org/v1/gonum/lapack/lapack64"

lapack/lapack64/lapack64.go

@@ -2,22 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package lapack64 provides a set of convenient wrapper functions for LAPACK
+package lapack64
-// calls, as specified in the netlib standard (www.netlib.org).
-//
-// The native Go routines are used by default, and the Use function can be used
-// to set an alternative implementation.
-//
-// If the type of matrix (General, Symmetric, etc.) is known and fixed, it is
-// used in the wrapper signature. In many cases, however, the type of the matrix
-// changes during the call to the routine, for example the matrix is symmetric on
-// entry and is triangular on exit. In these cases the correct types should be checked
-// in the documentation.
-//
-// The full set of Lapack functions is very large, and it is not clear that a
-// full implementation is desirable, let alone feasible. Please open up an issue
-// if there is a specific function you need and/or are willing to implement.
-package lapack64 // import "gonum.org/v1/gonum/lapack/lapack64"
 
 import (
 	"gonum.org/v1/gonum/blas"

mathext/internal/amos/amos.go

@@ -2,7 +2,6 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// package amos implements functions originally in the Netlab code by Donald Amos.
 package amos
 
 import (

mathext/internal/amos/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// package amos implements functions originally in the Netlab code by Donald Amos.
+package amos // import "gonum.org/v1/gonum/mathext/internal/amos"

mathext/internal/cephes/cephes.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package cephes implements functions originally in the Netlib code by Stephen Mosher.
+package cephes
-package cephes // import "gonum.org/v1/gonum/mathext/internal/cephes"
 
 import "math"
 

mathext/internal/cephes/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package cephes implements functions originally in the Netlib code by Stephen Mosher.
+package cephes // import "gonum.org/v1/gonum/mathext/internal/cephes"

mathext/internal/gonum/doc.go

@@ -0,0 +1,7 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// package gonum contains functions implemented by the gonum team. It is here to
+// avoid circular imports and/or double coding of functions.
+package gonum // import "gonum.org/v1/gonum/mathext/internal/gonum"

mathext/internal/gonum/gonum.go

@@ -2,6 +2,4 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// package gonum contains functions implemented by the gonum team. It is here to
-// avoid circular imports and/or double coding of functions.
 package gonum

stat/combin/combin.go

@@ -2,9 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package combin implements routines involving combinatorics (permutations,
+package combin
-// combinations, etc.).
-package combin // import "gonum.org/v1/gonum/stat/combin"
 
 import "math"
 

stat/combin/doc.go

@@ -0,0 +1,7 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package combin implements routines involving combinatorics (permutations,
+// combinations, etc.).
+package combin // import "gonum.org/v1/gonum/stat/combin"

stat/distmat/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package distmat provides probability distributions over matrices.
+package distmat // import "gonum.org/v1/gonum/stat/distmat"

stat/distmat/general.go

@@ -2,7 +2,6 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package distmat provides probability distributions over matrices.
+package distmat
-package distmat // import "gonum.org/v1/gonum/stat/distmat"
 
 var badDim = "distmat: dimension mismatch"

stat/distmv/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package distmv provides multivariate random distribution types.
+package distmv // import "gonum.org/v1/gonum/stat/distmv"

stat/distmv/general.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package distmv provides multivariate random distribution types.
+package distmv
-package distmv // import "gonum.org/v1/gonum/stat/distmv"
 
 var (
 	badQuantile      = "distmv: quantile not between 0 and 1"

stat/distuv/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package distuv provides univariate random distribution types.
+package distuv // import "gonum.org/v1/gonum/stat/distuv"

stat/distuv/general.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package distuv provides univariate random distribution types.
+package distuv
-package distuv // import "gonum.org/v1/gonum/stat/distuv"
 
 import "math"
 

stat/doc.go

@@ -0,0 +1,6 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package stat provides generalized statistical functions.
+package stat // import "gonum.org/v1/gonum/stat"

stat/samplemv/doc.go

@@ -0,0 +1,11 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package samplemv implements advanced sampling routines from explicit and implicit
+// probability distributions.
+//
+// Each sampling routine is implemented as a stateless function with a
+// complementary wrapper type. The wrapper types allow the sampling routines
+// to implement interfaces.
+package samplemv // import "gonum.org/v1/gonum/stat/samplemv"

stat/samplemv/samplemv.go

@@ -2,13 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package samplemv implements advanced sampling routines from explicit and implicit
+package samplemv
-// probability distributions.
-//
-// Each sampling routine is implemented as a stateless function with a
-// complementary wrapper type. The wrapper types allow the sampling routines
-// to implement interfaces.
-package samplemv // import "gonum.org/v1/gonum/stat/samplemv"
 
 import (
 	"errors"

stat/sampleuv/doc.go

@@ -0,0 +1,11 @@
+// Copyright ©2017 The gonum Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package sampleuv implements advanced sampling routines from explicit and implicit
+// probability distributions.
+//
+// Each sampling routine is implemented as a stateless function with a
+// complementary wrapper type. The wrapper types allow the sampling routines
+// to implement interfaces.
+package sampleuv // import "gonum.org/v1/gonum/stat/sampleuv"

stat/sampleuv/sample.go

@@ -2,13 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package sampleuv implements advanced sampling routines from explicit and implicit
+package sampleuv
-// probability distributions.
-//
-// Each sampling routine is implemented as a stateless function with a
-// complementary wrapper type. The wrapper types allow the sampling routines
-// to implement interfaces.
-package sampleuv // import "gonum.org/v1/gonum/stat/sampleuv"
 
 import (
 	"errors"

stat/stat.go

@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Package stat provides generalized statistical functions.
+package stat
-package stat // import "gonum.org/v1/gonum/stat"
 
 import (
 	"math"