Documentation update.

This commit is contained in:
John Beisley 2013-10-06 22:06:22 +01:00
parent 7047429ef8
commit 6a9b6ed1a9

View File

@ -44,10 +44,11 @@ type MaybeRootDevice struct {
Err error Err error
} }
// DiscoverDevices attempts to find targets of the given type. searchTarget is // DiscoverDevices attempts to find targets of the given type. This is
// typically a value from a DeviceType* or ServiceType* constant. An error is // typically the entry-point for this package. searchTarget is typically a
// returned for errors while attempting to send the query. An error or // value from a DeviceType* or ServiceType* constant. An error is returned for
// RootDevice is returned for each discovered service. // errors while attempting to send the query. An error or RootDevice is
// returned for each discovered RootDevice.
func DiscoverDevices(searchTarget string) ([]MaybeRootDevice, error) { func DiscoverDevices(searchTarget string) ([]MaybeRootDevice, error) {
httpu, err := httpu.NewHTTPUClient() httpu, err := httpu.NewHTTPUClient()
if err != nil { if err != nil {