docs: adds missing copyright headers, fixes some package descriptions (#577)

rsdmike · web-flow · commit 46a9e34f5a49 · 2025-09-10T16:26:22.000-07:00
diff --git a/pkg/apf/processor.go b/pkg/apf/processor.go
@@ -2,6 +2,8 @@
  * Copyright (c) Intel Corporation 2022
  * SPDX-License-Identifier: Apache-2.0
  **********************************************************************/
+
+// Package apf implements the APF (AMT Port Forwarding) Protocol
 package apf
 
 import (
diff --git a/pkg/wsman/cim/messages.go b/pkg/wsman/cim/messages.go
@@ -2,6 +2,7 @@
  * Copyright (c) Intel Corporation 2023
  * SPDX-License-Identifier: Apache-2.0
  **********************************************************************/
+
 // Package cim implements CIM classes to support communicating with Intel® AMT Devices
 package cim
 
diff --git a/pkg/wsman/ips/ieee8021x/credentialcontext.go b/pkg/wsman/ips/ieee8021x/credentialcontext.go
@@ -2,7 +2,8 @@
  * Copyright (c) Intel Corporation 2023
  * SPDX-License-Identifier: Apache-2.0
  **********************************************************************/
-// Package 8021xCredentialContext facilitates communication with Intel® AMT devices to create an association between an instance of IPS_IEEE8021xSettings and an instance of AMT_PublicKeyCertificate that it uses.
+
+// Package ieee8021x facilitates communication with Intel® AMT devices to create an association between an instance of IPS_IEEE8021xSettings and an instance of AMT_PublicKeyCertificate that it uses.
 package ieee8021x
 
 import (
diff --git a/pkg/wsman/ips/kvmredirection/decoder.go b/pkg/wsman/ips/kvmredirection/decoder.go
@@ -1,3 +1,8 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
 package kvmredirection
 
 const (
diff --git a/pkg/wsman/ips/kvmredirection/settingdata.go b/pkg/wsman/ips/kvmredirection/settingdata.go
@@ -1,3 +1,9 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
+// Package kvmredirection represents configuration-related and operational parameters for the KVM redirection service in the Intel(R) AMT.
 package kvmredirection
 
 import (
diff --git a/pkg/wsman/ips/kvmredirection/settingdata_test.go b/pkg/wsman/ips/kvmredirection/settingdata_test.go
@@ -1,3 +1,8 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
 package kvmredirection
 
 import (
diff --git a/pkg/wsman/ips/kvmredirection/types.go b/pkg/wsman/ips/kvmredirection/types.go
@@ -1,3 +1,8 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
 package kvmredirection
 
 import (
diff --git a/pkg/wsman/ips/screensetting/data.go b/pkg/wsman/ips/screensetting/data.go
@@ -1,3 +1,9 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
+// Package screensetting provides the data structures and methods for managing screen settings in Intel® AMT devices.
 package screensetting
 
 import (
diff --git a/pkg/wsman/ips/screensetting/data_test.go b/pkg/wsman/ips/screensetting/data_test.go
@@ -1,3 +1,8 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
 package screensetting
 
 import (
diff --git a/pkg/wsman/ips/screensetting/decoder.go b/pkg/wsman/ips/screensetting/decoder.go
@@ -1,3 +1,8 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
 package screensetting
 
 const (
diff --git a/pkg/wsman/ips/screensetting/types.go b/pkg/wsman/ips/screensetting/types.go
@@ -1,3 +1,8 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
 package screensetting
 
 import (
diff --git a/pkg/wsman/ips/secio/decoder.go b/pkg/wsman/ips/secio/decoder.go
@@ -1,3 +1,8 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
 package secio
 
 const (
diff --git a/pkg/wsman/ips/secio/service.go b/pkg/wsman/ips/secio/service.go
@@ -1,3 +1,10 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
+// Package secio is a feature that allows the ME control over a Sprite screen on the local display, and/or secured input operations.
+// This class allows control over the Secured IO service's settings and operational status.
 package secio
 
 import (
diff --git a/pkg/wsman/ips/secio/service_test.go b/pkg/wsman/ips/secio/service_test.go
@@ -1,3 +1,8 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
 package secio
 
 import (
diff --git a/pkg/wsman/ips/secio/types.go b/pkg/wsman/ips/secio/types.go
@@ -1,3 +1,8 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2025
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+
 package secio
 
 import (
