Merge pull request #138 from ahmetalpbalkan/pkgcomments

Godoc fixes for packages

management/client.go

@@ -1,3 +1,5 @@
+// Package management provides the main API client to construct other clients
+// and make requests to the Microsoft Azure Service Management REST API.
 package management
 
 import (

management/hostedservice/client.go

@@ -1,3 +1,4 @@
+// Package hostedservice provides a client for Hosted Services.
 package hostedservice
 
 import (

management/hostedservice/entities.go

@@ -6,7 +6,7 @@ import (
 	"github.com/Azure/azure-sdk-for-go/management"
 )
 
-//HostedServiceClient is used to manage operations on Azure Hosted Services
+//HostedServiceClient is used to perform operations on Azure Hosted Services
 type HostedServiceClient struct {
 	client management.Client
 }

management/location/client.go

@@ -1,3 +1,4 @@
+// Package location provides a client for Locations.
 package location
 
 import (

management/location/entities.go

@@ -9,7 +9,7 @@ import (
 	"github.com/Azure/azure-sdk-for-go/management"
 )
 
-//LocationClient is used to manage operations on Azure Locations
+//LocationClient is used to perform operations on Azure Locations
 type LocationClient struct {
 	client management.Client
 }

management/networksecuritygroup/client.go

@@ -1,7 +1,4 @@
-// Package networksecuritygroup implements operations for managing network security groups
-// using the Service Management REST API
-//
-// https://msdn.microsoft.com/en-us/library/azure/dn913824.aspx
+// Package networksecuritygroup provides a client for Network Security Groups.
 package networksecuritygroup
 
 import (

management/networksecuritygroup/entities.go

@@ -10,7 +10,7 @@ import (
 	"github.com/Azure/azure-sdk-for-go/management"
 )
 
-// SecurityGroupClient is used to manage operations on network security groups
+// SecurityGroupClient is used to perform operations on network security groups
 type SecurityGroupClient struct {
 	client management.Client
 }

management/osimage/client.go

@@ -1,3 +1,4 @@
+// Package osimage provides a client for Operating System Images.
 package osimage
 
 import (

management/osimage/entities.go

@@ -6,7 +6,7 @@ import (
 	"github.com/Azure/azure-sdk-for-go/management"
 )
 
-// OsImageClient is used to manage operations on Azure Locations
+// OsImageClient is used to perform operations on Azure Locations
 type OsImageClient struct {
 	client management.Client
 }

management/storageservice/client.go

@@ -1,3 +1,4 @@
+// Package storageservice provides a client for Storage Services.
 package storageservice
 
 import (

management/storageservice/entities.go

@@ -6,7 +6,7 @@ import (
 	"github.com/Azure/azure-sdk-for-go/management"
 )
 
-// StorageServiceClient is used to manage operations on Azure Storage
+// StorageServiceClient is used to perform operations on Azure Storage
 type StorageServiceClient struct {
 	client management.Client
 }

management/virtualmachine/client.go

@@ -1,7 +1,4 @@
-// Package virtualmachine implements operations for managing virtual machines
-// using the Service Management REST API
-//
-// https://msdn.microsoft.com/en-us/library/azure/jj157206.aspx
+// Package virtualmachine provides a client for Virtual Machines.
 package virtualmachine
 
 import (

management/virtualmachine/entities.go

@@ -7,7 +7,7 @@ import (
 	vmdisk "github.com/Azure/azure-sdk-for-go/management/virtualmachinedisk"
 )
 
-// VirtualMachineClient is used to manage operations on Azure Virtual Machines
+// VirtualMachineClient is used to perform operations on Azure Virtual Machines
 type VirtualMachineClient struct {
 	client management.Client
 }

management/virtualmachinedisk/client.go

@@ -1,3 +1,4 @@
+// Package virtualmachinedisk provides a client for Virtual Machine Disks.
 package virtualmachinedisk
 
 import (

management/virtualmachinedisk/entities.go

@@ -2,7 +2,7 @@ package virtualmachinedisk
 
 import "github.com/Azure/azure-sdk-for-go/management"
 
-// DiskClient is used to manage operations on Azure Disks
+// DiskClient is used to perform operations on Azure Disks
 type DiskClient struct {
 	client management.Client
 }

management/virtualmachineimage/client.go

@@ -1,3 +1,4 @@
+// Package virtualmachineimage provides a client for Virtual Machine Images.
 package virtualmachineimage
 
 import (

management/virtualmachineimage/entities.go

@@ -7,7 +7,7 @@ import (
 	vmdisk "github.com/Azure/azure-sdk-for-go/management/virtualmachinedisk"
 )
 
-// Client is used to manage operations on Azure VM Images.
+// Client is used to perform operations on Azure VM Images.
 type Client struct {
 	management.Client
 }

management/virtualnetwork/client.go

@@ -1,3 +1,4 @@
+// Package virtualnetwork provides a client for Virtual Networks.
 package virtualnetwork
 
 import (

management/virtualnetwork/entities.go

@@ -10,20 +10,22 @@ const xmlNamespace = "http://schemas.microsoft.com/ServiceHosting/2011/07/Networ
 const xmlNamespaceXsd = "http://www.w3.org/2001/XMLSchema"
 const xmlNamespaceXsi = "http://www.w3.org/2001/XMLSchema-instance"
 
-// VirtualNetworkClient is used to manage operations on Azure Virtual Networks
+// VirtualNetworkClient is used to perform operations on Virtual Networks.
 type VirtualNetworkClient struct {
 	client management.Client
 }
 
 // NetworkConfiguration represents the network configuration for an entire Azure
-// subscription. TODO: Nicer builder methods for these that abstract away the
-// underlying structure
+// subscription.
 type NetworkConfiguration struct {
 	XMLName         xml.Name                    `xml:"NetworkConfiguration"`
 	XMLNamespaceXsd string                      `xml:"xmlns:xsd,attr"`
 	XMLNamespaceXsi string                      `xml:"xmlns:xsi,attr"`
 	XMLNs           string                      `xml:"xmlns,attr"`
 	Configuration   VirtualNetworkConfiguration `xml:"VirtualNetworkConfiguration"`
+
+	// TODO: Nicer builder methods for these that abstract away the
+	// underlying structure.
 }
 
 // NewNetworkConfiguration creates a new empty NetworkConfiguration structure

management/vmutils/vmutils.go

@@ -1,4 +1,5 @@
-// Package vmutils provides convenience methods for building vm role configurations
+// Package vmutils provides convenience methods for creating Virtual
+// Machine Role configurations.
 package vmutils
 
 import (

storage/client.go

@@ -1,3 +1,4 @@
+// Package storage provides clients for Microsoft Azure Storage Services.
 package storage
 
 import (