Skip to content

Commit ea56c45

Browse files
committed
x/tools/go/analysis: document AllObjectFacts return values
Fixes #70351
1 parent a6adab9 commit ea56c45

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

go/analysis/analysis.go

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,10 +156,17 @@ type Pass struct {
156156

157157
// AllPackageFacts returns a new slice containing all package
158158
// facts of the analysis's FactTypes in unspecified order.
159+
// See comments for AllObjectFacts.
159160
AllPackageFacts func() []PackageFact
160161

161162
// AllObjectFacts returns a new slice containing all object
162163
// facts of the analysis's FactTypes in unspecified order.
164+
//
165+
// The result includes all facts exported by packages
166+
// whose symbols are referenced by the current package
167+
// (by qualified identifiers or field/method selections).
168+
// And it includes all facts exported from the current
169+
// package by the current analysis pass.
163170
AllObjectFacts func() []ObjectFact
164171

165172
/* Further fields may be added in future. */

0 commit comments

Comments
 (0)