/Community

I have a method with the following signature:

public T Get<T>(ApiConnectInfo apiConnectInfo) 

I'm trying to format the parameter documentation as follows: 

/// <param name="apiConnectInfo"><see cref="ApiConnectInfo" /> containing the API connect information.</param>

I've tried the following and it's almost right. 

this.Write(Context.ExecMacro(parameter.Name, "$(TypeName.FullNameAsSee)") + " containing " + Context.ExecMacro(parameter.Name, "$(OfTheReordering)"));

This results in:

/// <param name="apiConnectInfo"><see cref="apiConnectInfo"/> The API connect information</param>

It appears to be using the parameter name for the <see> tag instead of the parameter type, and  the "The" should be lower cased.

Any thoughts?

Also, this would be a nice to have, but is there a way to put an A/An before the <see> tag and have it properly determine if it starts with a vowel and use the right article?

 Thanks much,

Morgan 

Hi Morgan,

Please use the following code:

bool isVowel = "aeiouAEIOU".IndexOf(parameter.ReturnType.FullName[0]) >= 0;
this.Write(((isVowel) ? "An " : "A ") + Context.ExecMacro(parameter.ReturnType.FullName, "$(TypeName.FullNameAsSee)") + " containing the " + Context.ExecMacro(parameter.Name, "$(All)") + ".");