init
This commit is contained in:
40
docs/ai/Common/DTS.CommonCore/Enums/Groups/GroupList.md
Normal file
40
docs/ai/Common/DTS.CommonCore/Enums/Groups/GroupList.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Enums/Groups/GroupList/GroupFields.cs
|
||||
generated_at: "2026-04-17T16:08:31.227396+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "7fad27458f4f959c"
|
||||
---
|
||||
|
||||
# GroupList
|
||||
|
||||
### Purpose
|
||||
This module defines the `GroupFields` enumeration, which specifies the standard field names for Group entities within the DTS system. It provides a type-safe way to reference group properties, likely used for data binding, sorting, filtering, or display column configuration in group listing views. The enum supports localized display names via `Description` attributes.
|
||||
|
||||
### Public Interface
|
||||
|
||||
**`enum GroupFields`**
|
||||
- A public enum decorated with `[TypeConverter(typeof(EnumDescriptionTypeConverter))]` to enable conversion between enum values and their string descriptions.
|
||||
- **Values:**
|
||||
- `Name` — Description key: "GroupField_Name"
|
||||
- `DisplayName` — Description key: "GroupField_DisplayName"
|
||||
- `Description` — Description key: "GroupField_Description"
|
||||
- `ChannelCount` — Description key: "GroupField_ChannelCount"
|
||||
- `LastModified` — Description key: "GroupField_LastModified"
|
||||
- `LastModifiedBy` — Description key: "GroupField_LastModifiedBy"
|
||||
- `AssociatedTestSetups` — Description key: "GroupField_AssociatedTestSetups"
|
||||
|
||||
### Invariants
|
||||
- Each enum value has an associated `[Description]` attribute containing a localization resource key (not a display string directly).
|
||||
- The underlying integer values follow default C# enum behavior (starting at 0, incrementing by 1).
|
||||
|
||||
### Dependencies
|
||||
- **Depends on:** `DTS.Common.Converters.EnumDescriptionTypeConverter` (for type conversion), `System.ComponentModel` (for `TypeConverter` and `Description` attributes).
|
||||
- **Depended on by:** Not determinable from source alone; likely consumed by Group listing/view components.
|
||||
|
||||
### Gotchas
|
||||
- The `Description` attribute values (e.g., "GroupField_Name") appear to be localization keys, not human-readable strings. Consumers must resolve these via a localization mechanism.
|
||||
- Unlike `TestSetupFields`, this enum uses `Description` attributes and a custom `TypeConverter`, suggesting different display handling patterns across the codebase.
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user