v0.34.0 doc sweep and update

internal/source/null/null.go

@@ -14,34 +14,28 @@ import (
 	"github.com/lixenwraith/log"
 )
 
-// init registers the component in plugin factory
 func init() {
 	if err := plugin.RegisterSource("null", NewNullSourcePlugin); err != nil {
 		panic(fmt.Sprintf("failed to register null source: %v", err))
 	}
 }
 
-// NullSource generates no log entries, used for testing
+// NullSource generates nothing: it holds a source's place until one is chosen
 type NullSource struct {
-	// Plugin identity and session management
 	id      string
 	proxy   *session.Proxy
 	session *session.Session
 
-	// Application
 	subscribers []chan core.LogEntry
 	logger      *log.Logger
 
-	// Runtime
 	done chan struct{}
 
-	// Statistics
 	totalEntries  atomic.Uint64
 	startTime     time.Time
 	lastEntryTime atomic.Value // time.Time
 }
 
-// NewNullSourcePlugin creates a null source through plugin factory
 func NewNullSourcePlugin(
 	id string,
 	configMap map[string]any,
@@ -60,7 +54,6 @@ func NewNullSourcePlugin(
 	}
 	ns.lastEntryTime.Store(time.Time{})
 
-	// Create session for null source
 	ns.session = proxy.CreateSession(
 		"null://void",
 		map[string]any{
@@ -76,21 +69,18 @@ func NewNullSourcePlugin(
 	return ns, nil
 }
 
-// Capabilities returns supported capabilities
 func (ns *NullSource) Capabilities() []core.Capability {
 	return []core.Capability{
 		core.CapSessionAware,
 	}
 }
 
-// Subscribe returns a channel for receiving log entries
 func (ns *NullSource) Subscribe() <-chan core.LogEntry {
 	ch := make(chan core.LogEntry, 1000)
 	ns.subscribers = append(ns.subscribers, ch)
 	return ch
 }
 
-// Start begins the source operation (no-op for null source)
 func (ns *NullSource) Start() error {
 	ns.startTime = time.Now()
 	ns.proxy.UpdateActivity(ns.session.ID)
@@ -100,7 +90,6 @@ func (ns *NullSource) Start() error {
 	return nil
 }
 
-// Stop signals the source to stop
 func (ns *NullSource) Stop() {
 	close(ns.done)
 	if ns.session != nil {
@@ -114,7 +103,6 @@ func (ns *NullSource) Stop() {
 		"instance_id", ns.id)
 }
 
-// GetStats returns the source's statistics
 func (ns *NullSource) GetStats() source.SourceStats {
 	lastEntry, _ := ns.lastEntryTime.Load().(time.Time)