Documentation modifications

This commit is contained in:
julian
2026-06-27 15:23:26 -07:00
parent a633fe6c06
commit a19fb90902
218 changed files with 2882 additions and 0 deletions
@@ -70,6 +70,10 @@ public class UsersWhiteListConfig : List<string>
/// <remarks>
/// This type serves as a container or marker for grouping validation logic within a broader validation framework.
/// </remarks>
/// <summary>
/// Represents a group that has been validated as meeting the required criteria.
/// </summary>
/// <!-- aidoc:v1 sig=1cee181 -->
public class ValidGroupsConfig : List<ValidGroup>
{
/// <summary>
@@ -272,6 +272,13 @@ public class PermissionSettings
);
}
/// <summary>
/// Represents a set of permissions for a source, grouping the unit-level and display-level <see cref="DisplayPermissionTypes"/> together with the corresponding <see cref="PanelPermissionTypes"/>.
/// </summary>
/// <remarks>
/// The primary constructor captures <paramref name="unit"/> and <paramref name="display"/> permissions as <see cref="DisplayPermissionTypes"/>, and <paramref name="panel"/> permissions as <see cref="PanelPermissionTypes"/>.
/// </remarks>
/// <!-- aidoc:v1 sig=74dcf70 -->
public class SourcePermissions(
DisplayPermissionTypes unit,
DisplayPermissionTypes display,
@@ -282,6 +289,13 @@ public class SourcePermissions(
public PanelPermissionTypes Panel { get; set; } = panel;
}
/// <summary>
/// Encapsulates a collection of <see cref="UserActions"/> that govern the display permissions for clinical and administrative areas such as admissions, discharges, observations, demographic data, box blocking, notices, and cell management.
/// </summary>
/// <remarks>
/// The <paramref name="useDemoMode"/> flag indicates whether the permission configuration should be evaluated in demonstration mode.
/// </remarks>
/// <!-- aidoc:v1 sig=5c32eb7 -->
public class DisplayPermissionTypes(
UserActions admissions,
UserActions discharges,
@@ -302,6 +316,13 @@ public class DisplayPermissionTypes(
public bool UseDemoMode { get; set; } = useDemoMode;
}
/// <summary>
/// Encapsulates the <see cref="UserActions"/> permissions available for each application panel, such as <paramref name="units"/>, <paramref name="patients"/>, and <paramref name="observations"/>, along with the <paramref name="useDemoMode"/> flag.
/// </summary>
/// <remarks>
/// A dedicated <see cref="UserActions"/> value is supplied for every panel — units, displays, display configurations, master lists, treatments, patients, medicines, pumps, users, configuration observations, observations, and audits — so that the access rights for each section can be evaluated independently. The <paramref name="useDemoMode"/> parameter indicates whether the system is operating in demo mode.
/// </remarks>
/// <!-- aidoc:v1 sig=3d15620 -->
public class PanelPermissionTypes(
UserActions units,
UserActions displays,