Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do I reference members of other types in the XML docs for a method?

I have the following XML doc segment on one of my methods:

    /// <summary>
    /// Calculates the total charge for hours between the <see cref="StartDateTime"/> and <see cref="EndDateTime"/> of all all the <see cref="VehiclePresence"/> records 
    /// included in the date range defined by <paramref name="startDate"/> and <paramref name="endDate"/>.
    /// </summary>

The <see cref="StartDateTime"/> part renders as [!:StartDateTime]. I would prefer it rendered as a link to the VehiclePresence.StartDatetTime property's documentation, just as the <see cref="VehiclePresence"/> part renders as a link to the VehiclePresence class's documentation.

like image 330
ProfK Avatar asked Apr 27 '13 22:04

ProfK


1 Answers

You can use

<see cref="VehiclePresence.StartDateTime"/>

to reference the types in the other namespaces

like image 68
Darko Kenda Avatar answered Sep 20 '22 00:09

Darko Kenda