docs: Add godoc comments to more exported functions
Add missing godoc comments to: - BuildGuestKey in alerts/alerts.go - GenerateMockData in mock/generator.go - NewDockerUpdater, NewAURUpdater in updates/adapter_installsh.go - NewMockUpdater in updates/mock_updater.go
This commit is contained in:
parent
c019e4cd0e
commit
36740bffe3
4 changed files with 5 additions and 0 deletions
|
|
@ -4172,6 +4172,7 @@ func (m *Manager) CheckStorage(storage models.Storage) {
|
|||
}
|
||||
}
|
||||
|
||||
// BuildGuestKey constructs a unique key for a guest from instance, node, and VMID.
|
||||
func BuildGuestKey(instance, node string, vmid int) string {
|
||||
instance = strings.TrimSpace(instance)
|
||||
node = strings.TrimSpace(node)
|
||||
|
|
|
|||
|
|
@ -247,6 +247,7 @@ func generateVirtualDisks() ([]models.Disk, models.Disk) {
|
|||
return disks, aggregated
|
||||
}
|
||||
|
||||
// GenerateMockData creates a simulated state snapshot for demo/test environments.
|
||||
func GenerateMockData(config MockConfig) models.StateSnapshot {
|
||||
// rand is automatically seeded in Go 1.20+
|
||||
|
||||
|
|
|
|||
|
|
@ -649,6 +649,7 @@ func (a *InstallShAdapter) readLastLines(filepath string, n int) string {
|
|||
// DockerUpdater provides instructions for Docker deployments
|
||||
type DockerUpdater struct{}
|
||||
|
||||
// NewDockerUpdater creates an updater for Docker deployments.
|
||||
func NewDockerUpdater() *DockerUpdater {
|
||||
return &DockerUpdater{}
|
||||
}
|
||||
|
|
@ -686,6 +687,7 @@ func (u *DockerUpdater) Rollback(ctx context.Context, eventID string) error {
|
|||
// AURUpdater provides instructions for Arch Linux AUR deployments
|
||||
type AURUpdater struct{}
|
||||
|
||||
// NewAURUpdater creates an updater for Arch Linux AUR deployments.
|
||||
func NewAURUpdater() *AURUpdater {
|
||||
return &AURUpdater{}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@ import (
|
|||
// MockUpdater simulates update plans for mock/demo environments.
|
||||
type MockUpdater struct{}
|
||||
|
||||
// NewMockUpdater creates an updater that simulates update operations.
|
||||
func NewMockUpdater() *MockUpdater {
|
||||
return &MockUpdater{}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue