Lint-fix: Package comments

collector/ad.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_DirectoryServices_DirectoryServices
-// Partial docs: https://msdn.microsoft.com/en-us/library/ms803980.aspx
-
 // +build windows
 
 package collector
@@ -465,6 +462,8 @@ func (c *ADCollector) Collect(ch chan<- prometheus.Metric) error {
 	return nil
 }
 
+// Win32_PerfRawData_DirectoryServices_DirectoryServices docs:
+// - https://msdn.microsoft.com/en-us/library/ms803980.aspx
 type Win32_PerfRawData_DirectoryServices_DirectoryServices struct {
 	Name string
 

collector/cpu.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_PerfOS_Processor
-// https://msdn.microsoft.com/en-us/library/aa394317(v=vs.90).aspx - Win32_PerfRawData_PerfOS_Processor class
-
 // +build windows
 
 package collector
@@ -66,6 +63,8 @@ func (c *CPUCollector) Collect(ch chan<- prometheus.Metric) error {
 	return nil
 }
 
+// Win32_PerfRawData_PerfOS_Processor docs:
+// - https://msdn.microsoft.com/en-us/library/aa394317(v=vs.90).aspx
 type Win32_PerfRawData_PerfOS_Processor struct {
 	Name                  string
 	C1TransitionsPersec   uint64

collector/cs.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_ComputerSystem
-// https://msdn.microsoft.com/en-us/library/aa394102 - Win32_ComputerSystem class
-
 // +build windows
 
 package collector
@@ -53,6 +50,8 @@ func (c *CSCollector) Collect(ch chan<- prometheus.Metric) error {
 	return nil
 }
 
+// Win32_ComputerSystem docs:
+// - https://msdn.microsoft.com/en-us/library/aa394102
 type Win32_ComputerSystem struct {
 	NumberOfLogicalProcessors uint32
 	TotalPhysicalMemory       uint64

collector/dns.go

@@ -1,7 +1,3 @@
-// returns data points from Win32_PerfRawData_DNS_DNS
-// https://msdn.microsoft.com/en-us/library/ms803992.aspx?f=255&MSPPError=-2147217396
-// https://technet.microsoft.com/en-us/library/cc977686.aspx
-
 // +build windows
 
 package collector
@@ -193,6 +189,9 @@ func (c *DNSCollector) Collect(ch chan<- prometheus.Metric) error {
 	return nil
 }
 
+// Win32_PerfRawData_DNS_DNS docs:
+// - https://msdn.microsoft.com/en-us/library/ms803992.aspx?f=255&MSPPError=-2147217396
+// - https://technet.microsoft.com/en-us/library/cc977686.aspx
 type Win32_PerfRawData_DNS_DNS struct {
 	AXFRRequestReceived            uint32
 	AXFRRequestSent                uint32

collector/iis.go

@@ -1,9 +1,3 @@
-// returns data points from the following classes:
-// - Win32_PerfRawData_W3SVC_WebService
-// - Win32_PerfRawData_APPPOOLCountersProvider_APPPOOLWAS
-// - Win32_PerfRawData_W3SVCW3WPCounterProvider_W3SVCW3WP
-// - Win32_PerfRawData_W3SVC_WebServiceCache
-
 // +build windows
 
 package collector

collector/logical_disk.go

@@ -1,7 +1,3 @@
-// returns data points from Win32_PerfRawData_PerfDisk_LogicalDisk
-// https://msdn.microsoft.com/en-us/windows/hardware/aa394307(v=vs.71) - Win32_PerfRawData_PerfDisk_LogicalDisk class
-// https://msdn.microsoft.com/en-us/library/ms803973.aspx - LogicalDisk object reference
-
 // +build windows
 
 package collector
@@ -146,6 +142,9 @@ func (c *LogicalDiskCollector) Collect(ch chan<- prometheus.Metric) error {
 	return nil
 }
 
+// Win32_PerfRawData_PerfDisk_LogicalDisk docs:
+// - https://msdn.microsoft.com/en-us/windows/hardware/aa394307(v=vs.71) - Win32_PerfRawData_PerfDisk_LogicalDisk class
+// - https://msdn.microsoft.com/en-us/library/ms803973.aspx - LogicalDisk object reference
 type Win32_PerfRawData_PerfDisk_LogicalDisk struct {
 	Name                   string
 	CurrentDiskQueueLength uint32

collector/msmq.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_MSMQ_MSMQQueue
-// <add link to documentation here> - Win32_PerfRawData_MSMQ_MSMQQueue class
-
 // +build windows
 
 package collector

collector/mssql.go

@@ -1,23 +1,3 @@
-// returns data points from the following classes:
-// - Win32_PerfRawData_MSSQLSERVER_SQLServerAccessMethods
-//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-access-methods-object
-// - Win32_PerfRawData_MSSQLSERVER_SQLServerAvailabilityReplica
-//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-availability-replica
-// - Win32_PerfRawData_MSSQLSERVER_SQLServerBufferManager
-//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-buffer-manager-object
-// - Win32_PerfRawData_MSSQLSERVER_SQLServerDatabaseReplica
-//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-database-replica
-// - Win32_PerfRawData_MSSQLSERVER_SQLServerDatabases
-//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-databases-object?view=sql-server-2017
-// - Win32_PerfRawData_MSSQLSERVER_SQLServerGeneralStatistics
-//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-general-statistics-object
-// - Win32_PerfRawData_MSSQLSERVER_SQLServerLocks
-//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-locks-object
-// - Win32_PerfRawData_MSSQLSERVER_SQLServerMemoryManager
-//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-memory-manager-object
-// - Win32_PerfRawData_MSSQLSERVER_SQLServerSQLStatistics
-//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-sql-statistics-object
-
 // +build windows
 
 package collector
@@ -1723,6 +1703,9 @@ func (c *MSSQLCollector) Collect(ch chan<- prometheus.Metric) error {
 	return nil
 }
 
+// win32PerfRawDataSQLServerAccessMethods docs:
+// - Win32_PerfRawData_MSSQLSERVER_SQLServerAccessMethods
+//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-access-methods-object
 type win32PerfRawDataSQLServerAccessMethods struct {
 	AUcleanupbatchesPersec        uint64
 	AUcleanupsPersec              uint64
@@ -2087,6 +2070,8 @@ func (c *MSSQLCollector) collectAccessMethods(ch chan<- prometheus.Metric, sqlIn
 	return nil, nil
 }
 
+// Win32_PerfRawData_MSSQLSERVER_SQLServerAvailabilityReplica docs:
+//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-availability-replica
 type win32PerfRawDataSQLServerAvailabilityReplica struct {
 	Name                           string
 	BytesReceivedfromReplicaPersec uint64
@@ -2179,6 +2164,8 @@ func (c *MSSQLCollector) collectAvailabilityReplica(ch chan<- prometheus.Metric,
 	return nil, nil
 }
 
+// Win32_PerfRawData_MSSQLSERVER_SQLServerBufferManager docs:
+//   https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-buffer-manager-object
 type win32PerfRawDataSQLServerBufferManager struct {
 	BackgroundwriterpagesPersec   uint64
 	Buffercachehitratio           uint64
@@ -2376,6 +2363,8 @@ func (c *MSSQLCollector) collectBufferManager(ch chan<- prometheus.Metric, sqlIn
 	return nil, nil
 }
 
+// Win32_PerfRawData_MSSQLSERVER_SQLServerDatabaseReplica docs:
+// - https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-database-replica
 type win32PerfRawDataSQLServerDatabaseReplica struct {
 	Name                            string
 	DatabaseFlowControlDelay        uint64
@@ -2588,6 +2577,8 @@ func (c *MSSQLCollector) collectDatabaseReplica(ch chan<- prometheus.Metric, sql
 	return nil, nil
 }
 
+// Win32_PerfRawData_MSSQLSERVER_SQLServerDatabases docs:
+// - https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-databases-object?view=sql-server-2017
 type win32PerfRawDataSQLServerDatabases struct {
 	Name                             string
 	ActiveTransactions               uint64
@@ -2976,6 +2967,8 @@ func (c *MSSQLCollector) collectDatabases(ch chan<- prometheus.Metric, sqlInstan
 	return nil, nil
 }
 
+// Win32_PerfRawData_MSSQLSERVER_SQLServerGeneralStatistics docs:
+// - https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-general-statistics-object
 type win32PerfRawDataSQLServerGeneralStatistics struct {
 	ActiveTempTables              uint64
 	ConnectionResetPersec         uint64
@@ -3188,6 +3181,8 @@ func (c *MSSQLCollector) collectGeneralStatistics(ch chan<- prometheus.Metric, s
 	return nil, nil
 }
 
+// Win32_PerfRawData_MSSQLSERVER_SQLServerLocks docs:
+// - https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-locks-object
 type win32PerfRawDataSQLServerLocks struct {
 	Name                       string
 	AverageWaitTimems          uint64
@@ -3264,6 +3259,8 @@ func (c *MSSQLCollector) collectLocks(ch chan<- prometheus.Metric, sqlInstance s
 	return nil, nil
 }
 
+// Win32_PerfRawData_MSSQLSERVER_SQLServerMemoryManager docs:
+// - https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-memory-manager-object
 type win32PerfRawDataSQLServerMemoryManager struct {
 	ConnectionMemoryKB       uint64
 	DatabaseCacheMemoryKB    uint64
@@ -3445,6 +3442,8 @@ func (c *MSSQLCollector) collectMemoryManager(ch chan<- prometheus.Metric, sqlIn
 	return nil, nil
 }
 
+// Win32_PerfRawData_MSSQLSERVER_SQLServerSQLStatistics docs:
+// - https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-sql-statistics-object
 type win32PerfRawDataSQLServerSQLStatistics struct {
 	AutoParamAttemptsPersec       uint64
 	BatchRequestsPersec           uint64

collector/net.go

@@ -1,9 +1,3 @@
-// returns data points from Win32_PerfRawData_Tcpip_NetworkInterface
-
-// https://technet.microsoft.com/en-us/security/aa394340(v=vs.80) (Win32_PerfRawData_Tcpip_NetworkInterface class)
-// https://msdn.microsoft.com/en-us/library/aa394216 (Win32_NetworkAdapter class)
-// https://msdn.microsoft.com/en-us/library/aa394353 (Win32_PnPEntity class)
-
 // +build windows
 
 package collector
@@ -152,6 +146,8 @@ func mangleNetworkName(name string) string {
 	return nicNameToUnderscore.ReplaceAllString(name, "_")
 }
 
+// Win32_PerfRawData_Tcpip_NetworkInterface docs:
+// - https://technet.microsoft.com/en-us/security/aa394340(v=vs.80)
 type Win32_PerfRawData_Tcpip_NetworkInterface struct {
 	BytesReceivedPerSec      uint64
 	BytesSentPerSec          uint64

collector/netframework_clrexceptions.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_NETFramework_NETCLRExceptions
-// <add link to documentation here> - Win32_PerfRawData_NETFramework_NETCLRExceptions class
-
 // +build windows
 
 package collector

collector/netframework_clrinterop.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_NETFramework_NETCLRInterop
-// <add link to documentation here> - Win32_PerfRawData_NETFramework_NETCLRInterop class
-
 // +build windows
 
 package collector

collector/netframework_clrjit.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_NETFramework_NETCLRJit
-// <add link to documentation here> - Win32_PerfRawData_NETFramework_NETCLRJit class
-
 // +build windows
 
 package collector

collector/netframework_clrloading.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_NETFramework_NETCLRLoading
-// <add link to documentation here> - Win32_PerfRawData_NETFramework_NETCLRLoading class
-
 // +build windows
 
 package collector

collector/netframework_clrlocksandthreads.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_NETFramework_NETCLRLocksAndThreads
-// <add link to documentation here> - Win32_PerfRawData_NETFramework_NETCLRLocksAndThreads class
-
 // +build windows
 
 package collector

collector/netframework_clrmemory.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_NETFramework_NETCLRMemory
-// <add link to documentation here> - Win32_PerfRawData_NETFramework_NETCLRMemory class
-
 // +build windows
 
 package collector

collector/netframework_clrremoting.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_NETFramework_NETCLRRemoting
-// <add link to documentation here> - Win32_PerfRawData_NETFramework_NETCLRRemoting class
-
 // +build windows
 
 package collector

collector/netframework_clrsecurity.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_NETFramework_NETCLRSecurity
-// <add link to documentation here> - Win32_PerfRawData_NETFramework_NETCLRSecurity class
-
 // +build windows
 
 package collector

collector/os.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_OperatingSystem
-// https://msdn.microsoft.com/en-us/library/aa394239 - Win32_OperatingSystem class
-
 // +build windows
 
 package collector
@@ -124,6 +121,8 @@ func (c *OSCollector) Collect(ch chan<- prometheus.Metric) error {
 	return nil
 }
 
+// Win32_OperatingSystem docs:
+// - https://msdn.microsoft.com/en-us/library/aa394239 - Win32_OperatingSystem class
 type Win32_OperatingSystem struct {
 	FreePhysicalMemory      uint64
 	FreeSpaceInPagingFiles  uint64

collector/process.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_PerfProc_Process
-// https://msdn.microsoft.com/en-us/library/aa394323(v=vs.85).aspx - Win32_PerfRawData_PerfProc_Process class
-
 // +build windows
 
 package collector
@@ -146,6 +143,8 @@ func (c *ProcessCollector) Collect(ch chan<- prometheus.Metric) error {
 	return nil
 }
 
+// Win32_PerfRawData_PerfProc_Process docs:
+// - https://msdn.microsoft.com/en-us/library/aa394323(v=vs.85).aspx
 type Win32_PerfRawData_PerfProc_Process struct {
 	Name                    string
 	CreatingProcessID       uint32

collector/service.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_Service
-// https://msdn.microsoft.com/en-us/library/aa394418(v=vs.85).aspx - Win32_Service class
-
 // +build windows
 
 package collector
@@ -75,6 +72,8 @@ func (c *serviceCollector) Collect(ch chan<- prometheus.Metric) error {
 	return nil
 }
 
+// Win32_Service docs:
+// - https://msdn.microsoft.com/en-us/library/aa394418(v=vs.85).aspx
 type Win32_Service struct {
 	Name      string
 	State     string

collector/system.go

@@ -1,6 +1,3 @@
-// returns data points from Win32_PerfRawData_PerfOS_System class
-// https://web.archive.org/web/20050830140516/http://msdn.microsoft.com/library/en-us/wmisdk/wmi/win32_perfrawdata_perfos_system.asp
-
 // +build windows
 
 package collector
@@ -80,6 +77,8 @@ func (c *SystemCollector) Collect(ch chan<- prometheus.Metric) error {
 	return nil
 }
 
+// Win32_PerfRawData_PerfOS_System docs:
+// - https://web.archive.org/web/20050830140516/http://msdn.microsoft.com/library/en-us/wmisdk/wmi/win32_perfrawdata_perfos_system.asp
 type Win32_PerfRawData_PerfOS_System struct {
 	ContextSwitchesPersec     uint32
 	ExceptionDispatchesPersec uint32

collector/tcp.go

@@ -1,7 +1,3 @@
-// returns data points from Win32_PerfRawData_Tcpip_TCPv4
-
-// https://msdn.microsoft.com/en-us/library/aa394341(v=vs.85).aspx (Win32_PerfRawData_Tcpip_TCPv4 class)
-
 // +build windows
 
 package collector
@@ -102,6 +98,8 @@ func (c *TCPCollector) Collect(ch chan<- prometheus.Metric) error {
 	return nil
 }
 
+// Win32_PerfRawData_Tcpip_TCPv4 docs
+// - https://msdn.microsoft.com/en-us/library/aa394341(v=vs.85).aspx
 type Win32_PerfRawData_Tcpip_TCPv4 struct {
 	ConnectionFailures          uint64
 	ConnectionsActive           uint64

collector/vmware.go

@@ -1,5 +1,3 @@
-// returns data points from Win32_PerfRawData_vmGuestLib_VMem and Win32_PerfRawData_vmGuestLib_VCPU
-
 // +build windows
 
 package collector

tools/collector-generator/collector.template

@@ -1,5 +1,3 @@
-// returns data points from {{ .Class }}
-// <add link to documentation here> - {{ .Class }} class
 package collector
 import (
     "github.com/StackExchange/wmi"
@@ -38,6 +36,8 @@ func (c *{{ .CollectorName }}Collector) Collect(ch chan<- prometheus.Metric) err
     }
     return nil
 }
+// {{ .Class }} docs:
+// - <add link to documentation here>
 type {{ .Class }} struct {
     Name string
 {{ range $m := .Members }}