add doc comments

Signed-off-by: Alex Goodman <alex.goodman@anchore.com>
anchore · Nov 18, 2021 · 3333709 · 3333709
1 parent dfcb57a
commit 3333709
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/syft/source/location.go b/syft/source/location.go
@@ -29,6 +29,7 @@ func NewLocation(realPath string) Location {
 	}
 }
 
+// NewVirtualLocation creates a new location for a path accessed by a virtual path (a path with a symlink or hardlink somewhere in the path)
 func NewVirtualLocation(realPath, virtualPath string) Location {
 	return Location{
 		Coordinates: Coordinates{
@@ -38,6 +39,7 @@ func NewVirtualLocation(realPath, virtualPath string) Location {
 	}
 }
 
+// NewLocationFromCoordinates creates a new location for the given Coordinates.
 func NewLocationFromCoordinates(coordinates Coordinates) Location {
 	return Location{
 		Coordinates: coordinates,