This is a derived ResolveReferenceLinksComponent2 class that loads cached MSDN URLs from a serialized binary file rather than letting the base component invoke the web service to look them up. This can significantly decrease the amount of time needed to perform a build.

Namespace: SandcastleBuilder.Components
Assembly: SandcastleBuilder.Components (in SandcastleBuilder.Components.dll) Version: 1.9.3.0

Syntax

C#
public class CachedResolveReferenceLinksComponent : ResolveReferenceLinksComponent2
Visual Basic
Public Class CachedResolveReferenceLinksComponent _
	Inherits ResolveReferenceLinksComponent2

Remarks

The cache is built cumulatively over time rather than having all 170,000+ resolved entries loaded, most of which would never be used. If new URLs are added to the cache during a build, the cache is saved during disposal so that the new entries are used on subsequent builds.

Examples

CopyExample configuration
<!-- Cached MSDN URL references component.  This should replace
     the standard ResolveReferenceLinksComponent2 build component. -->
<component type="SandcastleBuilder.Components.CachedResolveReferenceLinksComponent"
  assembly="C:\SandcastleBuilder\SandcastleBuilder.Components.dll"
  locale="en-us" linkTarget="_blank">
    <cache filename="C:\SandcastleBuilder\Cache\MsdnUrl.cache" />
    <targets base="C:\Program Files\Sandcastle\Data\Reflection"
        recurse="true" files="*.xml" type="MSDN" />
    <targets files="reflection.xml" type="Local" />
</component>

Inheritance Hierarchy

System..::..Object
  Microsoft.Ddue.Tools..::..BuildComponent
    Microsoft.Ddue.Tools..::..ResolveReferenceLinksComponent2
      SandcastleBuilder.Components..::..CachedResolveReferenceLinksComponent

See Also