From 6a9b6ed1a9718de079dde27ddbae3ac918b34ace Mon Sep 17 00:00:00 2001 From: John Beisley Date: Sun, 6 Oct 2013 22:06:22 +0100 Subject: [PATCH] Documentation update. --- goupnp.go | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/goupnp.go b/goupnp.go index cc7bb96..3118078 100644 --- a/goupnp.go +++ b/goupnp.go @@ -44,10 +44,11 @@ type MaybeRootDevice struct { Err error } -// DiscoverDevices attempts to find targets of the given type. searchTarget is -// typically a value from a DeviceType* or ServiceType* constant. An error is -// returned for errors while attempting to send the query. An error or -// RootDevice is returned for each discovered service. +// DiscoverDevices attempts to find targets of the given type. This is +// typically the entry-point for this package. searchTarget is typically a +// value from a DeviceType* or ServiceType* constant. An error is returned for +// errors while attempting to send the query. An error or RootDevice is +// returned for each discovered RootDevice. func DiscoverDevices(searchTarget string) ([]MaybeRootDevice, error) { httpu, err := httpu.NewHTTPUClient() if err != nil {