api-doc-tools icon indicating copy to clipboard operation
api-doc-tools copied to clipboard

mdoc update has non-destructive error processing some _Extensions XML files

Open lobrien opened this issue 7 years ago • 2 comments

While running mdoc update, I see many errors of the form:

“mdoc: Did not find /Type/AssemblyInfo/AssemblyName on /Users/lobrien 1/Downloads/bundle/en/AVFoundation/AVPlayerItemMetadataCollectorPushDelegate_Extensions.xml”

And, in fact, that XML file does not contain an AssemblyName element:

<Type Name="AVPlayerItemMetadataCollectorPushDelegate_Extensions" FullName="AVFoundation.AVPlayerItemMetadataCollectorPushDelegate_Extensions">
<TypeSignature Language="C#" Value="public static class AVPlayerItemMetadataCollectorPushDelegate_Extensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit AVPlayerItemMetadataCollectorPushDelegate_Extensions extends System.Object" />
 <Base>
  <BaseTypeName>System.Object</BaseTypeName>
</Base>
  <Interfaces />
<Docs>
// ... etc ... 

This type does not exist in the assembly nor does the type appear in index.xml.

(Is the root cause of this defect that an _Extensions.xml file is being created even when it is not necessary?)

lobrien avatar Jun 19 '18 15:06 lobrien

The only way one of those XML files would ever be created, is if it existed as a type in the assemblies at some point during a previous mdoc update run ... this can be at least partially verified by searching the repository for the string _Extensions; there's no code that will automatically create that based on some criteria :)

joelmartinez avatar Jun 19 '18 15:06 joelmartinez

@lobrien I think we had discussed this over chat, but wanted to add some more context here on the GH issue. Was the root cause here that these *_Extensions types were being removed during the latest mdoc update run? Were these valid types in the latest version of the assemblies?

joelmartinez avatar Jul 05 '18 15:07 joelmartinez