[ROOT] / doc / toc / ARCDoc / Class / DocLink / __TOCDet

ClassAttribute

Describes to where a single HTML link points.

By link we mean a link according to LinkInsertionInDocumentation, that is words in an HTML-document like -MyCustomerClass-.

This class works with HTML, like LinkWordHTML being encoded in HTML, so for instance a link to a generic class like -MyCustomerClass<T>- actually looks like -MyCustomerClass&lt;T&gt;-.

Used as input to InsertLinks (telling it what to look for, and how to replace the text with a corresponding '<a href = ...' tag)

Note 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.

Note that out of performance needs this class has a duplicate storage of properties.
(Ordinary IP for debugging / querying needs, and traditional C# properties for higher performance).
This class should therefore not be changed after initialization (nor is it any need to), as it can easily lead to out-of-sync issues.

NOTE: / TODO: One might argue for leaving out LinkWordHTMLBeforeLt
NOTE: / TODO: and instead use TWO instances of DocLink when '&lt;' is encountered when creating instances of this class.
NOTE: / TODO: There are both pros and cons for this approach.

Edit

Generated 2025-01-03 20:18:59.068 UTC