/ doc / DocFrag / ARCAPI.DataStorage.DocLinks

ARCAPI.DataStorage.DocLinks

Edit keys at this level only

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

Assembly = ARCAPI
Description = Note that may be null.0x000D0x000A0x000D0x000AA collection of relevant keys from -Storage-, usually limited to Storage0x005B"doc"0x005D.0x000D0x000A0x000D0x000AEnables -LinkInsertionInDocumentation-.0x000D0x000AOriginates (normally) from -DocLinkCollection-.-Create-.0x000D0x000A0x000D0x000AMost relevant when querying (static) documentation because when storage is static then this parameter can be pre-calculated at application startup.0x000D0x000AIf on the other hand documentation storage is dynamically updated throughout the application lifetime then this parameter must also be continously updated, something which could have an unacceptable performance impact.0x000D0x000A0x000D0x000AOften set at application startup with links to (static) documentation.0x000D0x000AThis will improve error message for instance, by enabling linking directy to the documentation in the error message.0x000D0x000A0x000D0x000ANOTE: From Dec 2021 it it ASSUMED in AgoRapide in general that content here is static and will not change,0x000D0x000ANOTE: In other words, that content may be accessed without any locking (see -Lock-).0x000D0x000ANOTE: This significantly reduces the performance impact of NOTE: -LinkInsertionInDocumentation-.
DocFragType = ClassMember
IsInherited = False
IsInheritedDoc = False
Lines = 16
Name = DocLinks
Namespace = ARCAPI
Type = DataStorage
Attribute/DeclaringType = DataStorage
Attribute/Description = Note that may be null.0x000D0x000A0x000D0x000AA collection of relevant keys from -Storage-, usually limited to Storage0x005B"doc"0x005D.0x000D0x000A0x000D0x000AEnables -LinkInsertionInDocumentation-.0x000D0x000AOriginates (normally) from -DocLinkCollection-.-Create-.0x000D0x000A0x000D0x000AMost relevant when querying (static) documentation because when storage is static then this parameter can be pre-calculated at application startup.0x000D0x000AIf on the other hand documentation storage is dynamically updated throughout the application lifetime then this parameter must also be continously updated, something which could have an unacceptable performance impact.0x000D0x000A0x000D0x000AOften set at application startup with links to (static) documentation.0x000D0x000AThis will improve error message for instance, by enabling linking directy to the documentation in the error message.0x000D0x000A0x000D0x000ANOTE: From Dec 2021 it it ASSUMED in AgoRapide in general that content here is static and will not change,0x000D0x000ANOTE: In other words, that content may be accessed without any locking (see -Lock-).0x000D0x000ANOTE: This significantly reduces the performance impact of NOTE: -LinkInsertionInDocumentation-.
Attribute/MethodName = DocLinks
Attribute/MethodSignature = ARCDoc.DocLinkCollection DocLinks

Edit single sub keys only: Assembly / Attribute / Description / DocFragType / IsInherited / IsInheritedDoc / Lines / Name / Namespace / Type

Generated 2025-06-30 08:15:18.285 UTC