Click or drag to resize
Sandcastle Help File BuilderAPI Token Resolution Component

This build component is used to resolve tokens in XML comments files. This allows you to insert MAML token elements in XML comments and have their content resolved to the token value when the help file is built.

The following is the default configuration for the API Token Resolution component. It should be inserted into the configuration file before the ShowMissingComponent.

Example Configuration
Copy
<component id="API Token Resolution">
  <!-- A list of one or more token files from which to resolve tokens -->
  <content file="TokenFile1.tokens" />
  <content file="TokenFile2.tokens" />

  <!-- The element to replace (in this case, token) -->
  <replace elements="/*//token" item="string(.)" />
</component>

The content elements are used to specify the files that contain the tokens to be resolved and their values. The help file builder uses the {@TokenFiles} replacement tag in place of the content elements to insert the token files found in the project at build time.

See Also