Creating cross-references between assemblies?

Topics: Developer Forum, User Forum
Jan 23, 2013 at 11:35 PM

Context: I have two DLL libraries A and B where B references A.

In library B it is possible to create a cross-reference for documentation that exists within library A:

/// <summary>
/// This class is really cool.
/// </summary>
/// <seealso cref="AnotherClassFromLibraryA"/>
public class CoolClassInLibraryB : BaseClassFromLibraryA {
}

However, if I do the same in library A the reference is shown as an error in the compiled help documentation with something along the lines of [!SomeClassFromLibraryB!] (sorry if the formatting of that is a little off, that's from memory).

/// <summary>
/// Another neat class.
/// </summary>
/// <remarks>
/// <para>When doing this use <see cref="SomeClassFromLibraryB"/>.</para>
/// </remarks>
public class AnotherNeatClassInLibraryA {
}

Is there a way to achieve this?

Jan 24, 2013 at 12:24 AM

Ahh, no problem, I found that I just need to prefix the reference with the appropriate abbreviation:

/// <summary>
/// Another neat class.
/// </summary>
/// <remarks>
/// <para>When doing this use <see cref="T:SomeClassFromLibraryB"/>.</para>
/// </para>
/// </remarks>
public class AnotherNeatClassInLibraryA {
}