[ROOT] / doc / DocFrag / ARCAPI.DataStorage.DocLinks
| Key | Value |
|---|---|
| Assembly | ARCAPI |
| DocFragType | ClassMember |
| IsInherited | -False- |
| IsInheritedDoc | -False- |
| Lines | -13- |
| Name | DocLinks |
| Namespace | ARCAPI |
| Type | DataStorage |
ClassMemberAttribute
| Key | Value |
|---|---|
| DeclaringType | DataStorage |
| MethodName | DocLinks |
| MethodSignature | ARCDoc.DocLinkCollection DocLinks |
Note that may be null.
A collection of relevant keys from Storage, usually limited to Storage["doc"].
Enables LinkInsertionInDocumentation.
Originates (normally) from DocLinkCollection.Create.
Most relevant when querying (static) documentation because when storage is static then this parameter can be pre-calculated at application startup.
If on the other hand storage is dynamically updated throughout the application lifetime then this parameter must also be continously updated, something which could have an unacceptable performance impact.
Often set at application startup with links to (static) documentation.
This will improve error message for instance, by enabling linking directy to the documentation in the error message.
Generated 2025-10-29 15:11:06.844 UTC