Merge pull request #681 from mono/develop

huangmin-ms · web-flow · commit f49680ec1fea · 2023-12-20T13:48:47.000+08:00
add tag SetMethodName
diff --git a/mdoc/Consts.cs b/mdoc/Consts.cs
@@ -3,7 +3,7 @@ namespace Mono.Documentation
 {
     public static class Consts
     {
-        public static string MonoVersion = "5.9.2.4";
+        public static string MonoVersion = "5.9.3";
         public const string DocId = "DocId";
         public const string CppCli = "C++ CLI";
         public const string CppCx = "C++ CX";
diff --git a/mdoc/Mono.Documentation/MDocUpdater.cs b/mdoc/Mono.Documentation/MDocUpdater.cs
@@ -2411,66 +2411,98 @@ internal static IEnumerable<T> Sort<T> (IEnumerable<T> list)
             return l;
         }
 
-        private void UpdateMember (DocsNodeInfo info, FrameworkTypeEntry typeEntry, Dictionary<string, List<MemberReference>> implementedMembers, IEnumerable<Eiimembers> eiiMenbers)
+        private void UpdateMember(DocsNodeInfo info, FrameworkTypeEntry typeEntry, Dictionary<string, List<MemberReference>> implementedMembers, IEnumerable<Eiimembers> eiiMenbers)
         {
             XmlElement me = (XmlElement)info.Node;
             MemberReference mi = info.Member;
-            typeEntry.ProcessMember (mi);
+            typeEntry.ProcessMember(mi);
 
 
-            var memberName = GetMemberName (mi);
-            me.SetAttribute ("MemberName", memberName);
+            var memberName = GetMemberName(mi);
+            me.SetAttribute("MemberName", memberName);
 
-            WriteElementText (me, "MemberType", GetMemberType (mi));
+            WriteElementText(me, "MemberType", GetMemberType(mi));
+            MakeSetMethodName(typeEntry, me, mi);
             AddImplementedMembers(typeEntry, mi, implementedMembers, me, eiiMenbers);
 
             if (!no_assembly_versions)
             {
                 if (!IsMultiAssembly)
-                    UpdateAssemblyVersions (me, mi, true);
+                    UpdateAssemblyVersions(me, mi, true);
                 else
                 {
-                    var node = AddAssemblyNameToNode (me, mi.Module, mi.DeclaringType.Resolve());
+                    var node = AddAssemblyNameToNode(me, mi.Module, mi.DeclaringType.Resolve());
 
                     if (typeEntry.IsMemberOnFirstFramework(mi))
                     {
                         node.SelectNodes("AssemblyVersion").Cast<XmlNode>().ToList().ForEach(e => e.ParentNode.RemoveChild(e));
                     }
 
-                    UpdateAssemblyVersionForAssemblyInfo (node, me, new[] { GetAssemblyVersion (mi.Module.Assembly) }, add: true);
+                    UpdateAssemblyVersionForAssemblyInfo(node, me, new[] { GetAssemblyVersion(mi.Module.Assembly) }, add: true);
                 }
             }
             else
             {
-                ClearElement (me, "AssemblyInfo");
+                ClearElement(me, "AssemblyInfo");
             }
 
-			MakeMemberAttributes (me, mi, typeEntry);
+            MakeMemberAttributes(me, mi, typeEntry);
 
-            MakeReturnValue (typeEntry, me, mi, MDocUpdater.HasDroppedNamespace (mi));
+            MakeReturnValue(typeEntry, me, mi, MDocUpdater.HasDroppedNamespace(mi));
             if (mi is MethodReference)
             {
                 MethodReference mb = (MethodReference)mi;
-                if (mb.IsGenericMethod ())
-                    MakeTypeParameters (typeEntry, me, mb.GenericParameters, mi, MDocUpdater.HasDroppedNamespace (mi));
+                if (mb.IsGenericMethod())
+                    MakeTypeParameters(typeEntry, me, mb.GenericParameters, mi, MDocUpdater.HasDroppedNamespace(mi));
             }
             bool fxAlternateTriggered = false;
-            MakeParameters (me, mi, typeEntry, ref fxAlternateTriggered, MDocUpdater.HasDroppedNamespace (mi));
+            MakeParameters(me, mi, typeEntry, ref fxAlternateTriggered, MDocUpdater.HasDroppedNamespace(mi));
 
             string fieldValue;
-            if (mi is FieldDefinition && GetFieldConstValue ((FieldDefinition)mi, out fieldValue))
-                WriteElementText (me, "MemberValue", fieldValue);
+            if (mi is FieldDefinition && GetFieldConstValue((FieldDefinition)mi, out fieldValue))
+                WriteElementText(me, "MemberValue", fieldValue);
+
+            info.Node = WriteElement(me, "Docs");
+            MakeDocNode(info, typeEntry.Framework.Importers, typeEntry);
 
-            info.Node = WriteElement (me, "Docs");
-            MakeDocNode (info, typeEntry.Framework.Importers, typeEntry);
-            
             foreach (MemberFormatter f in FormatterManager.MemberFormatters)
             {
-                UpdateSignature (f, mi, me, typeEntry, implementedMembers);
+                UpdateSignature(f, mi, me, typeEntry, implementedMembers);
             }
 
-            OrderMemberNodes (me, me.ChildNodes);
-            UpdateExtensionMethods (me, info);
+            OrderMemberNodes(me, me.ChildNodes);
+            UpdateExtensionMethods(me, info);
+        }
+
+        public static void MakeSetMethodName(FrameworkTypeEntry typeEntry, XmlElement me, MemberReference mi)
+        {
+            if (mi is PropertyDefinition)
+            {
+                var setMethodName = ((PropertyDefinition)mi).SetMethod?.Name.Split('.').LastOrDefault();
+                if (setMethodName != null && !setMethodName.StartsWith("set"))
+                {
+                    DocUtils.AddElementWithFx(
+                        typeEntry,
+                        parent: me,
+                        isFirst: typeEntry.IsMemberOnFirstFramework(mi),
+                        isLast: typeEntry.IsMemberOnLastFramework(mi),
+                        allfxstring: new Lazy<string>(() => typeEntry.AllFrameworkStringForMember(mi)),
+                        clear: parent =>
+                        {
+                            ClearElement(parent, "SetMethodName");
+                        },
+                        findExisting: parent =>
+                        {
+                            return parent.SelectSingleNode($"Member/SetMethodName") as XmlElement;
+                        },
+                        addItem: parent =>
+                        {
+                            var newNode = WriteElementText(parent, "SetMethodName", setMethodName, forceNewElement: false);
+
+                            return newNode;
+                        });
+                }
+            }
         }
 
         private static void UpdateSignature(MemberFormatter formatter, TypeDefinition type, XmlElement xmlElement, FrameworkTypeEntry typeEntry)
@@ -2913,6 +2945,7 @@ static void AddXmlNode (XmlElement[] relevant, Func<XmlElement, bool> valueMatch
         "Metadata",
         "MemberSignature",
         "MemberType",
+        "SetMethodName",
         "Implements",
         "AssemblyInfo",
         "Attributes",
diff --git a/mdoc/Resources/monodoc-ecma.xsd b/mdoc/Resources/monodoc-ecma.xsd
@@ -89,6 +89,16 @@ add masterdoc support?
       </xs:simpleContent>
     </xs:complexType>
   </xs:element>
+
+  <xs:element name="SetMethodName">
+  	<xs:complexType>
+  		<xs:simpleContent>
+  			<xs:extension base="xs:string">
+  				<xs:attribute name="FrameworkAlternate" use="optional" />
+  			</xs:extension>
+  		</xs:simpleContent>
+  	</xs:complexType>
+  </xs:element>
   
   <xs:element name="Meta">
     <xs:complexType>
@@ -531,6 +541,7 @@ add masterdoc support?
         <xs:element ref="Metadata" minOccurs="0" maxOccurs="1" />
         <xs:element ref="MemberSignature" minOccurs="1" maxOccurs="unbounded" />
         <xs:element ref="MemberType" maxOccurs="1" />
+        <xs:element ref="SetMethodName" minOccurs="0" maxOccurs="1" />
         <xs:element ref="Implements" minOccurs="0" maxOccurs="1" />
         <xs:element ref="AssemblyInfo" minOccurs="0" maxOccurs="1" />
         <xs:element ref="Attributes" minOccurs="0" maxOccurs="1" />
diff --git a/mdoc/mdoc.Test/MDocUpdaterTests.cs b/mdoc/mdoc.Test/MDocUpdaterTests.cs
@@ -125,6 +125,32 @@ public void RemoveInvalidAssembliesInfo()
             // delitem.ParentNode.RemoveChild(child);        
         }
 
+        [Test]
+        public void MakeSetMethodName_Test()
+        {
+            List<FrameworkEntry> entries = new List<FrameworkEntry>();
+            FrameworkEntry frameworkEntry = new FrameworkEntry(entries, entries);
+            frameworkEntry.Name = "winui-2.8";
+            FrameworkTypeEntry typeEntry = new FrameworkTypeEntry(frameworkEntry);
+
+            var doc = new XmlDocument();
+            doc.LoadXml(XmlConsts.SetMethodName);
+
+            var member = GetType(typeof(mdoc.Test2.EiiImplementClass)).Properties.FirstOrDefault(t => t.FullName == "System.String mdoc.Test2.EiiImplementClass::init()");
+            MDocUpdater.MakeSetMethodName(typeEntry, doc.DocumentElement, member);
+            var node = doc.SelectSingleNode($"Member/SetMethodName");
+            Assert.IsNull(node);
+
+            member = GetType(typeof(mdoc.Test2.EiiImplementClass)).Properties.FirstOrDefault(t => t.FullName == "System.String mdoc.Test2.EiiImplementClass::source()");
+            member.SetMethod.Name = "put_Source";
+            MDocUpdater.MakeSetMethodName(typeEntry, doc.DocumentElement, member);
+            node = doc.SelectSingleNode($"Member/SetMethodName");
+            Assert.IsNotNull(node);
+            Assert.AreEqual(node.InnerText, member.SetMethod.Name);
+            Assert.AreEqual(node.Attributes["FrameworkAlternate"].Value, frameworkEntry.Name);
+
+        }
+
         [Test]
         public void UpdateToRight_MethodInterface_Test()
         {
diff --git a/mdoc/mdoc.Test/SampleClasses/EiiImplementclass.cs b/mdoc/mdoc.Test/SampleClasses/EiiImplementclass.cs
@@ -15,7 +15,7 @@ public class EiiImplementClass : Interface_A,Interface_B
 
         public int no { get; }
         int Interface_B.no { get;  }
-
+        
         public string GetNo() => "1";
         string Interface_A.GetNo() => "7";
 
@@ -31,5 +31,9 @@ event EventHandler<EventArgs> Interface_B.ItemChanged
             remove { }
         }
 
+        public string source { get; set;}
+
+        public string init { get; init;}
+
     }
 }
diff --git a/mdoc/mdoc.Test/XmlConsts.cs b/mdoc/mdoc.Test/XmlConsts.cs
@@ -706,5 +706,16 @@ class XmlConsts
 </Type>
 ";
         #endregion
+
+        #region
+        public const string SetMethodName = @"<Member MemberName=""Source"">
+      <MemberSignature Language=""C#"" Value=""public Windows.UI.Xaml.Media.ImageSource Source { get; set; }"" />
+      <MemberSignature Language=""ILAsm"" Value="".property instance class Windows.UI.Xaml.Media.ImageSource Source"" />
+      <MemberSignature Language=""DocId"" Value=""P:Microsoft.UI.Xaml.Controls.ImageIcon.Source"" />
+      <MemberSignature Language=""VB.NET"" Value=""Public Property Source As ImageSource"" />
+      <MemberSignature Language=""F#"" Value=""member this.Source : Windows.UI.Xaml.Media.ImageSource with get, set"" Usage=""Source"" />
+      <MemberType>Property</MemberType>
+    </Member>";
+        #endregion
     }
 }
diff --git a/mdoc/mdoc.Test/mdoc.Test.FSharp/Collections.fs b/mdoc/mdoc.Test/mdoc.Test.FSharp/Collections.fs
@@ -9,7 +9,7 @@ let f (x:Map<int, int>) = 0
 let f2 (x:seq<int>) = 0
 
 type MDocInterface<'key> = interface
-end
+    end
 
 type MDocTestMap<'Key, 'Value> = class
     interface MDocInterface<KeyValuePair<'Key, 'Value>>
diff --git a/mdoc/mdoc.nuspec b/mdoc/mdoc.nuspec
@@ -2,7 +2,7 @@
 <package >
   <metadata>
     <id>mdoc</id>
-    <version>5.9.2.4</version>
+    <version>5.9.3</version>
     <title>mdoc</title>
     <authors>Microsoft</authors>
     <owners>Microsoft</owners>

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ namespace Mono.Documentation`
`3`	`3`	`{`
`4`	`4`	`public static class Consts`
`5`	`5`	`{`
`6`		`- public static string MonoVersion = "5.9.2.4";`
	`6`	`+ public static string MonoVersion = "5.9.3";`
`7`	`7`	`public const string DocId = "DocId";`
`8`	`8`	`public const string CppCli = "C++ CLI";`
`9`	`9`	`public const string CppCx = "C++ CX";`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public class EiiImplementClass : Interface_A,Interface_B`
`15`	`15`
`16`	`16`	`public int no { get; }`
`17`	`17`	`int Interface_B.no { get; }`
`18`		`-`
	`18`	`+`
`19`	`19`	`public string GetNo() => "1";`
`20`	`20`	`string Interface_A.GetNo() => "7";`
`21`	`21`
`@@ -31,5 +31,9 @@ event EventHandler<EventArgs> Interface_B.ItemChanged`
`31`	`31`	`remove { }`
`32`	`32`	`}`
`33`	`33`
	`34`	`+ public string source { get; set;}`
	`35`	`+`
	`36`	`+ public string init { get; init;}`
	`37`	`+`
`34`	`38`	`}`
`35`	`39`	`}`