Add doc to new functions.

analysis/dataflow/report.go

@@ -110,9 +110,13 @@ func (s *AnalyzerState) ReportSummaryNotConstructed(callSite *CallNode) {
 	}
 }
 
-type unsoundFeaturesMap struct {
-	Recovers      map[token.Position]bool
-	UnsafeUsages  map[token.Position]string
+// UnsoundFeaturesMap maps positions (in a function) to explanations of the unsound features used.
+type UnsoundFeaturesMap struct {
+	// Recovers records the locations where a recover is used.
+	Recovers map[token.Position]bool
+	// UnsafeUsages records the locations where `unsafe` is used, with a short explanation.
+	UnsafeUsages map[token.Position]string
+	// ReflectUsages records the locations where 'reflect' is used, with a short explanation.
 	ReflectUsages map[token.Position]string
 }
 
@@ -159,7 +163,9 @@ func reportUnsoundFeatures(state *AnalyzerState, f *ssa.Function) {
 		state.Logger.Warnf(msg)
 	}
 }
-func FindUnsoundFeatures(f *ssa.Function) unsoundFeaturesMap {
+
+// FindUnsoundFeatures returns a record of the unsound features used by a function, if any.
+func FindUnsoundFeatures(f *ssa.Function) UnsoundFeaturesMap {
 	unsafeUsages := map[token.Position]string{}
 	recovers := map[token.Position]bool{}
 	reflectUsages := map[token.Position]string{}
@@ -206,5 +212,5 @@ func FindUnsoundFeatures(f *ssa.Function) unsoundFeaturesMap {
 			}
 		}
 	})
-	return unsoundFeaturesMap{recovers, unsafeUsages, reflectUsages}
+	return UnsoundFeaturesMap{recovers, unsafeUsages, reflectUsages}
 }

analysis/dataflow/testdata/unsound-features/main.go

@@ -1,19 +1,16 @@
-/*
- * Copyright (c)
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- *   Licensed under the Apache License, Version 2.0 (the "License").
- *   You may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *       http://www.apache.org/licenses/LICENSE-2.0
- *
- *   Unless required by applicable law or agreed to in writing, software
- *   distributed under the License is distributed on an "AS IS" BASIS,
- *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *   See the License for the specific language governing permissions and
- *   limitations under the License.
- */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 package main