diff options
| author | Joel Martinez <joelmartinez@gmail.com> | 2015-10-08 00:32:52 +0300 |
|---|---|---|
| committer | Duncan Mak <duncanm@microsoft.com> | 2016-10-08 03:31:05 +0300 |
| commit | b72b210ee0ad829d81b47e58928f7b11417b1cf4 (patch) | |
| tree | 6cb7d0e25af9284d92515a70d0af1fc8a5c5a204 /mdoc/Test/en.expected-dropns-multi | |
| parent | f95711659072d5a632b341e888c7c0e06c13ee3a (diff) | |
[mdoc] `multiassembly` option for duplicated types
The new `multiassembly` option lets you run `mdoc update` on assemblies that
contain the same types. This can come into play when you have a set of assemblies
that run on different platforms, with a slightly differing API surface area on
each platform (for example: tvOS, watchOS, iOS); in this case you can maintain
all of the documentation in a single set of XML documents.
With this option enabled, an `AssemblyInfo` node will be added for every assembly
that a type is found in, in addition to every member. While this may seem verbose,
it's really the only way to capture the information about what assemblies a given
type or member can be found in.
Diffstat (limited to 'mdoc/Test/en.expected-dropns-multi')
4 files changed, 217 insertions, 0 deletions
diff --git a/mdoc/Test/en.expected-dropns-multi/MyFramework.MyNamespace/MyClass.xml b/mdoc/Test/en.expected-dropns-multi/MyFramework.MyNamespace/MyClass.xml new file mode 100644 index 00000000..ee429765 --- /dev/null +++ b/mdoc/Test/en.expected-dropns-multi/MyFramework.MyNamespace/MyClass.xml @@ -0,0 +1,118 @@ +<Type Name="MyClass" FullName="MyFramework.MyNamespace.MyClass"> + <TypeSignature Language="C#" Value="public class MyClass" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MyClass extends System.Object" /> + <AssemblyInfo apistyle="classic"> + <AssemblyName>DocTest-DropNS-classic</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="classic"> + <AssemblyName>DocTest-DropNS-classic-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="unified"> + <AssemblyName>DocTest-DropNS-unified</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="unified"> + <AssemblyName>DocTest-DropNS-unified-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Object</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public MyClass ();" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" /> + <MemberType>Constructor</MemberType> + <AssemblyInfo apistyle="classic"> + <AssemblyName>DocTest-DropNS-classic</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="classic"> + <AssemblyName>DocTest-DropNS-classic-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="unified"> + <AssemblyName>DocTest-DropNS-unified</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="unified"> + <AssemblyName>DocTest-DropNS-unified-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Parameters /> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Hello"> + <MemberSignature Language="C#" Value="public float Hello (int value);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 Hello(int32 value) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo apistyle="classic"> + <AssemblyName>DocTest-DropNS-classic</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="classic"> + <AssemblyName>DocTest-DropNS-classic-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="unified"> + <AssemblyName>DocTest-DropNS-unified</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="unified"> + <AssemblyName>DocTest-DropNS-unified-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Single</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="value" Type="System.Int32" /> + </Parameters> + <Docs> + <param name="value">To be added.</param> + <summary>To be added.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="MyProperty"> + <MemberSignature Language="C#" Value="public string MyProperty { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance string MyProperty" /> + <MemberType>Property</MemberType> + <AssemblyInfo apistyle="classic"> + <AssemblyName>DocTest-DropNS-classic</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="classic"> + <AssemblyName>DocTest-DropNS-classic-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="unified"> + <AssemblyName>DocTest-DropNS-unified</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="unified"> + <AssemblyName>DocTest-DropNS-unified-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.String</ReturnType> + </ReturnValue> + <Docs> + <summary>To be added.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + </Members> +</Type> diff --git a/mdoc/Test/en.expected-dropns-multi/MyFramework.MyNamespace/OnlyInMulti.xml b/mdoc/Test/en.expected-dropns-multi/MyFramework.MyNamespace/OnlyInMulti.xml new file mode 100644 index 00000000..dbcf1304 --- /dev/null +++ b/mdoc/Test/en.expected-dropns-multi/MyFramework.MyNamespace/OnlyInMulti.xml @@ -0,0 +1,40 @@ +<Type Name="OnlyInMulti" FullName="MyFramework.MyNamespace.OnlyInMulti"> + <TypeSignature Language="C#" Value="public class OnlyInMulti" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit OnlyInMulti extends System.Object" /> + <AssemblyInfo apistyle="classic"> + <AssemblyName>DocTest-DropNS-classic-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="unified"> + <AssemblyName>DocTest-DropNS-unified-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Object</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public OnlyInMulti ();" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" /> + <MemberType>Constructor</MemberType> + <AssemblyInfo apistyle="classic"> + <AssemblyName>DocTest-DropNS-classic-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <AssemblyInfo apistyle="unified"> + <AssemblyName>DocTest-DropNS-unified-multitest</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Parameters /> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + </Members> +</Type> diff --git a/mdoc/Test/en.expected-dropns-multi/index.xml b/mdoc/Test/en.expected-dropns-multi/index.xml new file mode 100644 index 00000000..3baf401c --- /dev/null +++ b/mdoc/Test/en.expected-dropns-multi/index.xml @@ -0,0 +1,53 @@ +<Overview> + <Assemblies> + <Assembly Name="DocTest-DropNS-classic" Version="0.0.0.0"> + <Attributes> + <Attribute> + <AttributeName>System.Diagnostics.Debuggable(System.Diagnostics.DebuggableAttribute+DebuggingModes.IgnoreSymbolStoreSequencePoints)</AttributeName> + </Attribute> + <Attribute> + <AttributeName>System.Runtime.CompilerServices.RuntimeCompatibility(WrapNonExceptionThrows=true)</AttributeName> + </Attribute> + </Attributes> + </Assembly> + <Assembly Name="DocTest-DropNS-classic-multitest" Version="0.0.0.0"> + <Attributes> + <Attribute> + <AttributeName>System.Diagnostics.Debuggable(System.Diagnostics.DebuggableAttribute+DebuggingModes.IgnoreSymbolStoreSequencePoints)</AttributeName> + </Attribute> + <Attribute> + <AttributeName>System.Runtime.CompilerServices.RuntimeCompatibility(WrapNonExceptionThrows=true)</AttributeName> + </Attribute> + </Attributes> + </Assembly> + <Assembly Name="DocTest-DropNS-unified" Version="0.0.0.0"> + <Attributes> + <Attribute> + <AttributeName>System.Diagnostics.Debuggable(System.Diagnostics.DebuggableAttribute+DebuggingModes.IgnoreSymbolStoreSequencePoints)</AttributeName> + </Attribute> + <Attribute> + <AttributeName>System.Runtime.CompilerServices.RuntimeCompatibility(WrapNonExceptionThrows=true)</AttributeName> + </Attribute> + </Attributes> + </Assembly> + <Assembly Name="DocTest-DropNS-unified-multitest" Version="0.0.0.0"> + <Attributes> + <Attribute> + <AttributeName>System.Diagnostics.Debuggable(System.Diagnostics.DebuggableAttribute+DebuggingModes.IgnoreSymbolStoreSequencePoints)</AttributeName> + </Attribute> + <Attribute> + <AttributeName>System.Runtime.CompilerServices.RuntimeCompatibility(WrapNonExceptionThrows=true)</AttributeName> + </Attribute> + </Attributes> + </Assembly> + </Assemblies> + <Remarks>To be added.</Remarks> + <Copyright>To be added.</Copyright> + <Types> + <Namespace Name="MyFramework.MyNamespace"> + <Type Name="MyClass" Kind="Class" /> + <Type Name="OnlyInMulti" Kind="Class" /> + </Namespace> + </Types> + <Title>Untitled</Title> +</Overview> diff --git a/mdoc/Test/en.expected-dropns-multi/ns-MyFramework.MyNamespace.xml b/mdoc/Test/en.expected-dropns-multi/ns-MyFramework.MyNamespace.xml new file mode 100644 index 00000000..74df75af --- /dev/null +++ b/mdoc/Test/en.expected-dropns-multi/ns-MyFramework.MyNamespace.xml @@ -0,0 +1,6 @@ +<Namespace Name="MyFramework.MyNamespace"> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> +</Namespace> |