Package-level comments for static analyzers (#7332)

* package-level comments
* Merge refs/heads/master into analyzer-package-comments

tools/analyzers/comparesame/analyzer.go

@@ -1,3 +1,5 @@
+// Package comparesame implements a static analyzer to ensure that code does not contain
+// comparisons of identical expressions.
 package comparesame
 
 import (
@@ -13,7 +15,7 @@ import (
 )
 
 // Doc explaining the tool.
-const Doc = "Tool to detect comparison (==, !=, >=, <=, >, <) of identical boolean expressions."
+const Doc = "Tool to detect comparison (==, !=, >=, <=, >, <) of identical expressions."
 
 const messageTemplate = "Boolean expression has identical expressions on both sides. The result is always %v."
 

tools/analyzers/cryptorand/analyzer.go

@@ -1,3 +1,5 @@
+// Package cryptorand implements a static analyzer to ensure that the crypto/rand package is used
+// for randomness throughout the codebase.
 package cryptorand
 
 import (

tools/analyzers/featureconfig/analyzer.go

@@ -1,3 +1,4 @@
+// Package featureconfig implements a static analyzer to prevent leaking globals in tests.
 package featureconfig
 
 import (

tools/analyzers/maligned/analyzer.go

@@ -1,3 +1,4 @@
+// Package maligned implements a static analyzer to ensure that Go structs take up the least possible memory.
 package maligned
 
 import (

tools/analyzers/nop/analyzer.go

@@ -1,3 +1,4 @@
+// Package nop implements a static analyzer to ensure that code does not contain no-op instructions.
 package nop
 
 import (

tools/analyzers/shadowpredecl/analyzer.go

@@ -1,3 +1,5 @@
+// Package shadowpredecl implements a static analyzer which disallows declaring constructs
+// that shadow predeclared Go identifiers by having the same name.
 package shadowpredecl
 
 import (