go/analysis: document AllObjectFacts return value

Fixes golang/go#70351

Change-Id: I450941dbcee681f983c1076acbbac508df1d51f2
GitHub-Last-Rev: ea56c45
GitHub-Pull-Request: #553
Reviewed-on: https://go-review.googlesource.com/c/tools/+/638278
Auto-Submit: Alan Donovan <[email protected]>
Reviewed-by: Alan Donovan <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>

Author: willboland

go/analysis/analysis.go

@@ -156,10 +156,17 @@ type Pass struct {
 
 	// AllPackageFacts returns a new slice containing all package
 	// facts of the analysis's FactTypes in unspecified order.
+	// See comments for AllObjectFacts.
 	AllPackageFacts func() []PackageFact
 
 	// AllObjectFacts returns a new slice containing all object
 	// facts of the analysis's FactTypes in unspecified order.
+	//
+	// The result includes all facts exported by packages
+	// whose symbols are referenced by the current package
+	// (by qualified identifiers or field/method selections).
+	// And it includes all facts exported from the current
+	// package by the current analysis pass.
 	AllObjectFacts func() []ObjectFact
 
 	/* Further fields may be added in future. */