mono / api-doc-tools

.NET Reference API Toolchain
MIT License
68 stars 48 forks source link

Wrong parameter names for a few APIs #372

Closed mairaw closed 5 years ago

mairaw commented 5 years ago

As I'm reviewing the content being migrated from MSDN, I noticed that the parameters for the following APIs were not being imported: M:System.ServiceModel.Web.WebOperationContext.Attach(System.ServiceModel.OperationContext) M:System.ServiceModel.Web.WebOperationContext.Detach(System.ServiceModel.OperationContext)

When I went to dig a bit deeper, I've noticed that both MSDN and ildasm show the name of the param being owner but mdoc shows as context?

.method public hidebysig newslot virtual final 
        instance void  Attach(class [System.ServiceModel]System.ServiceModel.OperationContext owner) cil managed
{
  // Code size       0 (0x0)
} // end of method WebOperationContext::Attach
mairaw commented 5 years ago

Have you triaged this one already @joelmartinez?

joelmartinez commented 5 years ago

I'm not sure I understand … the docid never shows the parameter name, only the type (And also doesn't include the return type).

joelmartinez commented 5 years ago

oh, never mind, I see what you mean :
https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.ServiceModel.Web/WebOperationContext.xml#L84

I'll need to investigate to see what's up. Thanks for the heads up.

mairaw commented 5 years ago

Yep, that's it!

joelmartinez commented 5 years ago

Doing a bit of bug grooming, and it seems like this issue has now been resolved by some change, as there are signatures, and parameter nodes, that reflect both names (in different monikers):

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Attach(class System.ServiceModel.OperationContext owner) cil managed" FrameworkAlternate="netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Attach(class System.ServiceModel.OperationContext context) cil managed" FrameworkAlternate="xamarinandroid-7.1;xamarinios-10.8" />

Going to close this, but let me know if there's still an issue that needs to be addressed :)