diff options
author | GRODNO\Anton_Sokolovskii <a.sokolovsky15@gmail.com> | 2017-10-25 19:53:12 +0300 |
---|---|---|
committer | Joel Martinez <joelmartinez@gmail.com> | 2017-10-26 21:04:12 +0300 |
commit | 795fb3341c643f187db0626e1f09229e2ce4acb1 (patch) | |
tree | 7a86d29cc11d5e2213f442965b4663ecc4755e4b /mdoc/Test | |
parent | bc635e48317843fb126c4be0875d50ab1eeb61db (diff) |
mdoc: Preserving remarks created post-factum on import
Added attribute "overwrite" for the following elements: remarks, summary, value, returns, param, typeparam, altmember, exception, permission
Closes #97
Diffstat (limited to 'mdoc/Test')
-rw-r--r-- | mdoc/Test/test-overwrite-attribute/Expected_SomeClass.xml | 86 | ||||
-rw-r--r-- | mdoc/Test/test-overwrite-attribute/Input_SomeClass.xml | 86 | ||||
-rw-r--r-- | mdoc/Test/test-overwrite-attribute/SomeClass.cs | 20 |
3 files changed, 192 insertions, 0 deletions
diff --git a/mdoc/Test/test-overwrite-attribute/Expected_SomeClass.xml b/mdoc/Test/test-overwrite-attribute/Expected_SomeClass.xml new file mode 100644 index 00000000..dc11bfa8 --- /dev/null +++ b/mdoc/Test/test-overwrite-attribute/Expected_SomeClass.xml @@ -0,0 +1,86 @@ +<Type Name="SomeClass" FullName="SomeClass"> + <TypeSignature Language="C#" Value="public class SomeClass" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SomeClass extends System.Object" /> + <AssemblyInfo> + <AssemblyName>SomeClass</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Object</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary overwrite="false">Preserved summary</summary> + <remarks>New remark</remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public SomeClass ();" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" /> + <MemberType>Constructor</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Parameters /> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="DoSomething"> + <MemberSignature Language="C#" Value="public void DoSomething ();" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DoSomething() cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters /> + <Docs> + <summary>To be added.</summary> + <returns>New Returns something</returns> + <remarks>To be added.</remarks> + <exception cref="T:System.Exception">New exception</exception> + </Docs> + </Member> + <Member MemberName="SomeMethod"> + <MemberSignature Language="C#" Value="public void SomeMethod (int a, int b);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SomeMethod(int32 a, int32 b) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="a" Type="System.Int32" /> + <Parameter Name="b" Type="System.Int32" /> + </Parameters> + <Docs> + <param name="a" overwrite="false">Preserved First Parameter</param> + <param name="b">New Second Parameter</param> + <summary>New summary</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="SomeProperty"> + <MemberSignature Language="C#" Value="public string SomeProperty { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance string SomeProperty" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.String</ReturnType> + </ReturnValue> + <Docs> + <summary>To be added.</summary> + <value overwrite="false">Preserved Value for Property</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + </Members> +</Type> diff --git a/mdoc/Test/test-overwrite-attribute/Input_SomeClass.xml b/mdoc/Test/test-overwrite-attribute/Input_SomeClass.xml new file mode 100644 index 00000000..4de43821 --- /dev/null +++ b/mdoc/Test/test-overwrite-attribute/Input_SomeClass.xml @@ -0,0 +1,86 @@ +<Type Name="SomeClass" FullName="SomeClass"> + <TypeSignature Language="C#" Value="public class SomeClass" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SomeClass extends System.Object" /> + <AssemblyInfo> + <AssemblyName>SomeClass</AssemblyName> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Object</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary overwrite="false">Preserved summary</summary> + <remarks>Old remark</remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public SomeClass ();" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" /> + <MemberType>Constructor</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Parameters /> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="DoSomething"> + <MemberSignature Language="C#" Value="public void DoSomething ();" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DoSomething() cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters /> + <Docs> + <summary>To be added.</summary> + <returns>Old Returns something</returns> + <remarks>To be added.</remarks> + <exception cref="T:System.Exception">Old exception</exception> + </Docs> + </Member> + <Member MemberName="SomeMethod"> + <MemberSignature Language="C#" Value="public void SomeMethod (int a, int b);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SomeMethod(int32 a, int32 b) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="a" Type="System.Int32" /> + <Parameter Name="b" Type="System.Int32" /> + </Parameters> + <Docs> + <param name="a" overwrite="false">Preserved First Parameter</param> + <param name="b" overwrite="AnyOtherValue">Old Second Parameter</param> + <summary>Old summary</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="SomeProperty"> + <MemberSignature Language="C#" Value="public string SomeProperty { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance string SomeProperty" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <AssemblyVersion>0.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.String</ReturnType> + </ReturnValue> + <Docs> + <summary>To be added.</summary> + <value overwrite="false">Preserved Value for Property</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + </Members> +</Type> diff --git a/mdoc/Test/test-overwrite-attribute/SomeClass.cs b/mdoc/Test/test-overwrite-attribute/SomeClass.cs new file mode 100644 index 00000000..4acd3e4b --- /dev/null +++ b/mdoc/Test/test-overwrite-attribute/SomeClass.cs @@ -0,0 +1,20 @@ +///<summary>Ignored summary</summary> +///<remarks>New remark</remarks> +public class SomeClass +{ + ///<summary>New summary</summary> + ///<param name="a">Ignored First Parameter</param> + ///<param name="b">New Second Parameter</param> + public void SomeMethod(int a, int b) + { + + } + /// <exception cref="System.Exception">New exception</exception> + /// <returns>New Returns something</returns> + public void DoSomething() + { + + } + /// <value>Ignored Value for Property</value> + public string SomeProperty { get; set; } +} |