/ doc / tocInheritance / PRich / DocLink

DocLink

Edit keys at this level only

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

__TOCDet/Assembly = ARCDoc
__TOCDet/Description = Describes to where a single HTML link points.0x000D0x000A0x000D0x000ABy link we mean a link according to -LinkInsertionInDocumentation-, that is words in an HTML-document like -MyCustomerClass-.0x000D0x000A0x000D0x000AThis class works with HTML, like -LinkWordHTML- being encoded in HTML,  so for instance a link to a generic class like -MyCustomerClass0x003CT0x003E- actually looks like -MyCustomerClass&lt0x003BT&gt0x003B-.0x000D0x000A0x000D0x000AUsed as input to -InsertLinks- (telling it what to look for, and how to replace the text with a corresponding '0x003Ca href = ...' tag)0x000D0x000A0x000D0x000ANote how there is almost a one-to-one match between -HLocation- and -DocLink- with the latter pointing to a corresponding instance of the former. It is only when we have duplicate filenames that -DocLink- will instead point to a dedicated -DocLinkResolution- page for that filename.0x000D0x000A0x000D0x000ANote that out of performance needs this class has a duplicate storage of properties.0x000D0x000A(Ordinary -IP- for debugging / querying needs, and traditional C# properties for higher performance).0x000D0x000AThis class should therefore not be changed after initialization (nor is it any need to), as it can easily lead to out-of-sync issues.0x000D0x000A0x000D0x000ANOTE: / TODO: One might argue for leaving out -LinkWordHTMLBeforeLt-0x000D0x000ANOTE: / TODO: and instead use TWO instances of -DocLink- when '&lt0x003B' is encountered when creating instances of this class.0x000D0x000ANOTE: / TODO: There are both pros and cons for this approach.0x000D0x000A
__TOCDet/DocFragType = Class
__TOCDet/Name = DocLink
__TOCDet/Namespace = ARCDoc
__TOCDet/Type = DocLink
__TOCDet/Attribute/AssemblyName = ARCDoc
__TOCDet/Attribute/BaseTypes = PRich
__TOCDet/Attribute/ClassNamespace = ARCDoc
__TOCDet/Attribute/ClassType = DocLink
__TOCDet/Attribute/CorrespondingEnumType = DocLinkP
__TOCDet/Attribute/Description = Describes to where a single HTML link points.0x000D0x000A0x000D0x000ABy link we mean a link according to -LinkInsertionInDocumentation-, that is words in an HTML-document like -MyCustomerClass-.0x000D0x000A0x000D0x000AThis class works with HTML, like -LinkWordHTML- being encoded in HTML,  so for instance a link to a generic class like -MyCustomerClass0x003CT0x003E- actually looks like -MyCustomerClass&lt0x003BT&gt0x003B-.0x000D0x000A0x000D0x000AUsed as input to -InsertLinks- (telling it what to look for, and how to replace the text with a corresponding '0x003Ca href = ...' tag)0x000D0x000A0x000D0x000ANote how there is almost a one-to-one match between -HLocation- and -DocLink- with the latter pointing to a corresponding instance of the former. It is only when we have duplicate filenames that -DocLink- will instead point to a dedicated -DocLinkResolution- page for that filename.0x000D0x000A0x000D0x000ANote that out of performance needs this class has a duplicate storage of properties.0x000D0x000A(Ordinary -IP- for debugging / querying needs, and traditional C# properties for higher performance).0x000D0x000AThis class should therefore not be changed after initialization (nor is it any need to), as it can easily lead to out-of-sync issues.0x000D0x000A0x000D0x000ANOTE: / TODO: One might argue for leaving out -LinkWordHTMLBeforeLt-0x000D0x000ANOTE: / TODO: and instead use TWO instances of -DocLink- when '&lt0x003B' is encountered when creating instances of this class.0x000D0x000ANOTE: / TODO: There are both pros and cons for this approach.0x000D0x000A
__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable

Edit single sub keys only: __TOCDet

Generated 2025-06-19 14:48:24.243 UTC