Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[update] Try to keep existing order for type and member signatures. #662

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from
Open

[update] Try to keep existing order for type and member signatures. #662

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
d499d22
Merge pull request #584 from mono/develop
huangmin-ms Oct 19, 2021
f8a55d4
Merge pull request #595 from mono/develop
huangmin-ms Jan 13, 2022
5671681
Merge pull request #603 from mono/develop
huangmin-ms Jan 28, 2022
1a34ff5
Merge pull request #605 from mono/develop
huangmin-ms Jan 28, 2022
47b7145
Merge pull request #616 from mono/develop
huangmin-ms Mar 3, 2022
489be60
Merge pull request #622 from mono/develop
huangmin-ms Mar 24, 2022
8adc14d
Merge pull request #626 from mono/develop
huangmin-ms Apr 24, 2022
7bead46
Merge pull request #636 from mono/develop
huangmin-ms Jun 1, 2022
cc77d91
Merge pull request #643 from mono/develop
huangmin-ms Jul 7, 2022
97c1778
Merge pull request #644 from mono/develop
huangmin-ms Jul 15, 2022
e0baf60
Merge pull request #648 from mono/develop
huangmin-ms Aug 15, 2022
d92d897
Merge pull request #651 from mono/develop
huangmin-ms Sep 2, 2022
18ebe04
Merge pull request #656 from mono/develop
huangmin-ms Nov 14, 2022
f21c774
Merge pull request #658 from mono/develop
huangmin-ms Nov 14, 2022
9f6ac3a
[update] Try to keep existing order for type and member signatures.
rolfbjarne Jan 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 41 additions & 2 deletions mdoc/Mono.Documentation/MDocUpdater.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2476,8 +2476,17 @@ private static void UpdateSignature(MemberFormatter formatter, TypeDefinition ty
return;

// if first framework of type, clear signatures and generate from scratch
// try to keep order if there's only one existing element
XmlNode previousSiblingOfExistingElement = null;
XmlNode nextSiblingOfExistingElement = null;
if (typeEntry.Framework.IsFirstFrameworkForType(typeEntry))
{
if (existingElements.Count() == 1)
{
var firstExistingElement = existingElements.First();
previousSiblingOfExistingElement = firstExistingElement.PreviousSibling;
nextSiblingOfExistingElement = firstExistingElement.NextSibling;
}
existingElements.ForEach(e => e.ParentNode.RemoveChild(e));
existingElements = QueryXmlElementsByXpath(xmlElement, elementXPath).ToList();
}
Expand Down Expand Up @@ -2510,7 +2519,18 @@ private static void UpdateSignature(MemberFormatter formatter, TypeDefinition ty
if (!elementFound) //not exists, add signature with fxa
{
var newElement = xmlElement.OwnerDocument.CreateElement(elementName);
xmlElement.AppendChild(newElement);
if (previousSiblingOfExistingElement != null)
{
xmlElement.InsertAfter(newElement, previousSiblingOfExistingElement);
}
else if (nextSiblingOfExistingElement != null)
{
xmlElement.InsertBefore(newElement, nextSiblingOfExistingElement);
}
else
{
xmlElement.AppendChild(newElement);
}
newElement.SetAttribute("Language", formatter.Language);

if (!string.IsNullOrWhiteSpace(valueToUse))
Expand Down Expand Up @@ -2578,8 +2598,16 @@ public static void UpdateSignature(MemberFormatter formatter, MemberReference me
return;

// pre: clear all the signatures
XmlNode previousSiblingOfExistingElement = null;
XmlNode nextSiblingOfExistingElement = null;
if (typeEntry.IsMemberOnFirstFramework(member))
{
if (existingElements.Count() == 1)
{
var firstExistingElement = existingElements.First();
previousSiblingOfExistingElement = firstExistingElement.PreviousSibling;
nextSiblingOfExistingElement = firstExistingElement.NextSibling;
}
foreach (var element in existingElements)// xmlElement.SelectNodes(elementName).SafeCast<XmlElement>())
{
// remove element
Expand Down Expand Up @@ -2620,7 +2648,18 @@ public static void UpdateSignature(MemberFormatter formatter, MemberReference me
if (!elementFound) //not exists, just add it with fxa
{
var newElement = xmlElement.OwnerDocument.CreateElement(elementName);
xmlElement.AppendChild(newElement);
if (previousSiblingOfExistingElement != null)
{
xmlElement.InsertAfter(newElement, previousSiblingOfExistingElement);
}
else if (nextSiblingOfExistingElement != null)
{
xmlElement.InsertBefore(newElement, nextSiblingOfExistingElement);
}
else
{
xmlElement.AppendChild(newElement);
}
newElement.SetAttribute("Language", formatter.Language);

if (!string.IsNullOrWhiteSpace(valueToUse))
Expand Down
26 changes: 13 additions & 13 deletions mdoc/Test/en.expected-eii-implementation-ecmadoc/CustomNamespace/ClassEnumerator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ClassEnumerator ();" />
<MemberSignature Language="ILAsm" Value=".method public specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="JavaScript" Value="function ClassEnumerator()" Usage="var classEnumerator = new ClassEnumerator();" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; ClassEnumerator();" />
<MemberSignature Language="C++ CX" Value="public:&#xA; ClassEnumerator();" />
<MemberSignature Language="C++ WINRT" Value=" ClassEnumerator();" />
<MemberSignature Language="ILAsm" Value=".method public specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="JavaScript" Value="function ClassEnumerator()" Usage="var classEnumerator = new ClassEnumerator();" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.65535.65535</AssemblyVersion>
Expand All @@ -44,11 +44,11 @@
</Member>
<Member MemberName="CustomNamespace.CustomInterface.Prop1" ExplicitInterfaceMemberName="CustomProp1">
<MemberSignature Language="C#" Value="int CustomNamespace.CustomInterface.Prop1 { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 CustomProp1" />
<MemberSignature Language="VB.NET" Value=" Property CustomProp1 As Integer Implements CustomInterface.Prop1" />
<MemberSignature Language="F#" Value="member this.CustomNamespace.CustomInterface.Prop1 : int with get, set" Usage="CustomNamespace.CustomInterface.Prop1" />
<MemberSignature Language="C++ CLI" Value="property int CustomNamespace::CustomInterface::Prop1 { int get(); void set(int value); };" />
<MemberSignature Language="C++ CX" Value="property int CustomNamespace::CustomInterface::Prop1 { int get(); void set(int value); };" />
<MemberSignature Language="F#" Value="member this.CustomNamespace.CustomInterface.Prop1 : int with get, set" Usage="CustomNamespace.CustomInterface.Prop1" />
<MemberSignature Language="ILAsm" Value=".property instance int32 CustomProp1" />
<MemberSignature Language="VB.NET" Value=" Property CustomProp1 As Integer Implements CustomInterface.Prop1" />
<MemberSignature Language="C++ WINRT" Value="int CustomProp1();&#xA;&#xA;void CustomProp1(int value);" />
<MemberType>Property</MemberType>
<AssemblyInfo>
Expand All @@ -65,11 +65,11 @@
</Member>
<Member MemberName="CustomNamespace.CustomInterface.Prop2" ExplicitInterfaceMemberName="CustomProp2">
<MemberSignature Language="C#" Value="object CustomNamespace.CustomInterface.Prop2 { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object CustomProp2" />
<MemberSignature Language="VB.NET" Value=" ReadOnly Property CustomProp2 As Object Implements CustomInterface.Prop2" />
<MemberSignature Language="F#" Value="member this.CustomNamespace.CustomInterface.Prop2 : obj" Usage="CustomNamespace.CustomInterface.Prop2" />
<MemberSignature Language="C++ CLI" Value="property System::Object ^ CustomNamespace::CustomInterface::Prop2 { System::Object ^ get(); };" />
<MemberSignature Language="C++ CX" Value="property Platform::Object ^ CustomNamespace::CustomInterface::Prop2 { Platform::Object ^ get(); };" />
<MemberSignature Language="F#" Value="member this.CustomNamespace.CustomInterface.Prop2 : obj" Usage="CustomNamespace.CustomInterface.Prop2" />
<MemberSignature Language="ILAsm" Value=".property instance object CustomProp2" />
<MemberSignature Language="VB.NET" Value=" ReadOnly Property CustomProp2 As Object Implements CustomInterface.Prop2" />
<MemberSignature Language="C++ WINRT" Value="winrt::Windows::Foundation::IInspectable CustomProp2();" />
<MemberType>Property</MemberType>
<AssemblyInfo>
Expand All @@ -86,13 +86,13 @@
</Member>
<Member MemberName="Main">
<MemberSignature Language="C#" Value="public static void Main (string[] cmdArgs);" />
<MemberSignature Language="ILAsm" Value=".method public static void Main(string[] cmdArgs) cil managed" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub Main (cmdArgs As String())" />
<MemberSignature Language="F#" Value="static member Main : string[] -&gt; unit" Usage="CustomNamespace.ClassEnumerator.Main cmdArgs" />
<MemberSignature Language="JavaScript" Value="function main(cmdArgs)" Usage="CustomNamespace.ClassEnumerator.main(cmdArgs)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static void Main(cli::array &lt;System::String ^&gt; ^ cmdArgs);" />
<MemberSignature Language="C++ CX" Value="public:&#xA; static void Main(Platform::Array &lt;Platform::String ^&gt; ^ cmdArgs);" />
<MemberSignature Language="C++ WINRT" Value=" static void Main(winrt::array_view &lt;winrt::hstring const&amp;&gt; const&amp; cmdArgs);" />
<MemberSignature Language="F#" Value="static member Main : string[] -&gt; unit" Usage="CustomNamespace.ClassEnumerator.Main cmdArgs" />
<MemberSignature Language="ILAsm" Value=".method public static void Main(string[] cmdArgs) cil managed" />
<MemberSignature Language="JavaScript" Value="function main(cmdArgs)" Usage="CustomNamespace.ClassEnumerator.main(cmdArgs)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub Main (cmdArgs As String())" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.65535.65535</AssemblyVersion>
Expand Down