Skip to content

Commit e09e45d

Browse files
Copilotknopers8
andcommitted
Add package documentation for configuration, core, executor, and integration packages
Co-authored-by: knopers8 <[email protected]>
1 parent fa0f839 commit e09e45d

File tree

20 files changed

+40
-0
lines changed

20 files changed

+40
-0
lines changed

common/golangmetrics/metrics.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package golangmetrics provides Go runtime metrics collection and reporting
26+
// functionality for monitoring system resource usage and performance.
2527
package golangmetrics
2628

2729
import (

common/logger/infologger/protocols.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package infologger provides InfoLogger protocol implementation for
26+
// integration with the ALICE InfoLogger logging system.
2527
package infologger
2628

2729
type protoVersion string

common/monitoring/monitoring.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package monitoring provides monitoring and metrics collection functionality,
26+
// including HTTP endpoints for health checks and metrics publishing.
2527
package monitoring
2628

2729
import (

common/product/constants.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package product provides version information and build metadata for
26+
// O² Control products and components.
2527
package product
2628

2729
import (

common/utils/safeacks/safeacks.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package safeacks provides thread-safe acknowledgment handling for managing
26+
// communication between multiple senders and a single receiver.
2527
package safeacks
2628

2729
import (

common/utils/uid/uid.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package uid provides unique identifier generation functionality,
26+
// including machine-specific and time-based ID generation utilities.
2527
package uid
2628

2729
import (

configuration/componentcfg/componentcfg.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
* Intergovernmental Organization or submit itself to any jurisdiction.
2424
*/
2525

26+
// Package componentcfg provides component configuration management functionality,
27+
// including query handling and template processing for O² components.
2628
package componentcfg
2729

2830
import (

configuration/template/fields.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package template provides template processing functionality for configuration
26+
// files, including custom field handling and template execution.
2527
package template
2628

2729
import (

core/integration/bookkeeping/utils.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package bookkeeping provides integration with the ALICE Bookkeeping system
26+
// for tracking runs and retrieving LHC fill information.
2527
package bookkeeping
2628

2729
import (

core/integration/ccdb/plugin.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package ccdb provides integration with the Condition and Calibration Database (CCDB)
26+
// for creating and managing General Run Parameters (GRP) objects.
2527
package ccdb
2628

2729
import (

0 commit comments

Comments
 (0)