Skip to content

Fails to look up documentation for methods with out or ref parameters. #4

Description

@ShaneTaylorGH

When trying to look up documentation for a method that has out or ref parameters DocsService.GetXmlFromMember fails. I originally tried using the code here http://jimblackler.net/blog/?p=49 and ran into this issue. I then tried using this nuget package which also has the same issue. I reverted back to the code on jim blacklers blog and changed a small piece of code in DocsByReflection.XMLFromMember(MethodInfo methodInfo)

Where the following line was

parametersString += parameterInfo.ParameterType.FullName;

I changed it too

if (parameterInfo.ParameterType.IsByRef)
{
    parametersString += parameterInfo.ParameterType.FullName.Replace('&', '@');
}
else
{
    parametersString += parameterInfo.ParameterType.FullName;
}

I have not identified where the appropriate fix would be in this projects code base. The problem was that the types name for ref and out parameters contains a trailing &, but the XML documentation contains a @ instead.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions