CODEWITHSUNDEEP
delphixml-documentation
Antonis Christofides
Antonis Christofides

Reputation: 6949

Cross-referencing in XML documentation comments

When using XML Documentation Comments, I can't figure out how I can refer to another class member. Take this code:

TGreeter = class

  ///  <summary>Says hello</summary>
  procedure Hello;

  ///  <summary>Says hello to all</summary>
  ///  <remarks>
  ///   This is the same as <see cref="Hello"/>, but it says hello to all
  ///   instead.
  ///  </remarks>
  procedure HelloAll;

end;

Help Insight displays the help for HelloAll fine, but if I click on the link to Hello it does nothing (almost nothing; the mouse pointer indicates that, for a second or so, it does some thinking, but then it stops). What is the correct way to make such a cross-reference?

Upvotes: 2

Views: 394

Answers (1)

Name
Name

Reputation: 3550

I was wondering myself for quite a long time before I found a syntax that works (tested with Delphi XE4): You need to put the unit name, a pipe, the class name, a point and then method name.

In your example, let's say that the unit is called "MyUnit", then you should use:

<see cref="MyUnit|TGreeter.Hello"/>

Upvotes: 1

Related Questions