CODEWITHSUNDEEP
c#xmlcomments
user1590561
user1590561

Reputation: 613

XML comment with reference to file

I want to add reference to file to xml comment for class. I can do it so:

/// <summary>
/// Condition with the content of the text <a href="file:///d:/a.jpg">file</a>
/// </summary>

How I can to use relative path to file?

Upvotes: 4

Views: 1346

Answers (1)

Daniel A.A. Pelsmaeker
Daniel A.A. Pelsmaeker

Reputation: 50366

In Sandcastle paths are relative to the working folder (the .\Working folder under the output path set in the settings). To specify a path relative to your project, prefix it with {@ProjectFolder}. For example:

<a href="{@ProjectFolder}/a.jpg">File</a>

You can find a complete list of such replacement tags here:

Customizing the Build Process - Replacement Tags

Did you know you can replace cref with href in the documentation tags:

<see href="http://www.example.com/">Example</see>

<seealso href="http://www.example.com/">Example</seealso>

Upvotes: 1

Related Questions