Documentation modifications

2026-06-27 15:23:26 -07:00
parent a633fe6c06
commit a19fb90902
218 changed files with 2882 additions and 0 deletions
@@ -140,6 +140,13 @@ namespace adas_core.Domain.Utils
        public static string ConfigObservationsAll()
                    => "configObservations:all";

+        /// <summary>
+        /// Returns the cache key and its associated time-to-live (TTL) for caching the complete collection of configuration observations.
+        /// The TTL is resolved by <see cref="CacheKeyTtl.ResolveForEntity"/> using <paramref name="settings"/> and <see cref="CacheEnum.EntityType.ConfigObservations"/>.
+        /// </summary>
+        /// <param name="settings">Optional cache configuration used to resolve the TTL; may be <see langword="null"/>.</param>
+        /// <returns>A tuple containing the cache key and the resolved TTL as a <see cref="Nullable{TimeSpan}"/>.</returns>
+        /// <!-- aidoc:v1 sig=4708037 body=5108bf4 -->
        public static (string Key, TimeSpan? Ttl) ConfigObservationsAllKeyWithTtl(
            CacheSettings? settings)
        {