Use <remarks> rather than <remark> in the documentation comments (#1776)

Fixes #1775
dotnet · Oct 8, 2024 · 29b0f44 · 29b0f44
1 parent b26b674
commit 29b0f44
Show file tree

Hide file tree

Showing 112 changed files with 14,457 additions and 14,457 deletions.
diff --git a/gen/DocumentFormat.OpenXml.Generator.Models/Editor/DocumentCommentExtensions.cs b/gen/DocumentFormat.OpenXml.Generator.Models/Editor/DocumentCommentExtensions.cs
@@ -14,7 +14,7 @@ public static void WriteDocumentationComment(this TextWriter writer, string summ
     public static void WriteDocumentationComment(this TextWriter writer, DocumentCommentOptions option)
     {
         AddParagraphs("summary", writer, option.Summary);
-        AddParagraphs("remark", writer, option.Remarks);
+        AddParagraphs("remarks", writer, option.Remarks);
 
         foreach (var parameter in option.Parameters)
         {

diff --git a/...DocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas-microsoft-com_office_excel.g.cs b/...DocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas-microsoft-com_office_excel.g.cs
@@ -22,7 +22,7 @@ namespace DocumentFormat.OpenXml.Vml.Spreadsheet
     /// <para>This class is available in Office 2007 and above.</para>
     /// <para>When the object is serialized out as xml, it's qualified name is xvml:ClientData.</para>
     /// </summary>
-    /// <remark>
+    /// <remarks>
     /// <para>The following table lists the possible child types:</para>
     /// <list type="bullet">
     ///   <item><description><see cref="DocumentFormat.OpenXml.Vml.Spreadsheet.CommentRowTarget" /> <c>&lt;xvml:Row></c></description></item>
@@ -93,7 +93,7 @@ namespace DocumentFormat.OpenXml.Vml.Spreadsheet
     ///   <item><description><see cref="DocumentFormat.OpenXml.Vml.Spreadsheet.DdeObject" /> <c>&lt;xvml:DDE></c></description></item>
     ///   <item><description><see cref="DocumentFormat.OpenXml.Vml.Spreadsheet.UIObject" /> <c>&lt;xvml:UIObj></c></description></item>
     /// </list>
-    /// </remark>
+    /// </remarks>
     public partial class ClientData : OpenXmlCompositeElement
     {
         /// <summary>

diff --git a/...ocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas-microsoft-com_office_office.g.cs b/...ocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas-microsoft-com_office_office.g.cs
diff --git a/...enerator/DocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas-microsoft-com_vml.g.cs b/...enerator/DocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas-microsoft-com_vml.g.cs
diff --git a/...ocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_ink_2010_main.g.cs b/...ocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_ink_2010_main.g.cs
@@ -21,14 +21,14 @@ namespace DocumentFormat.OpenXml.Office2010.Ink
     /// <para>This class is available in Office 2007 and above.</para>
     /// <para>When the object is serialized out as xml, it's qualified name is msink:context.</para>
     /// </summary>
-    /// <remark>
+    /// <remarks>
     /// <para>The following table lists the possible child types:</para>
     /// <list type="bullet">
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office2010.Ink.SourceLink" /> <c>&lt;msink:sourceLink></c></description></item>
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office2010.Ink.DestinationLink" /> <c>&lt;msink:destinationLink></c></description></item>
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office2010.Ink.ContextNodeProperty" /> <c>&lt;msink:property></c></description></item>
     /// </list>
-    /// </remark>
+    /// </remarks>
     public partial class ContextNode : OpenXmlCompositeElement
     {
         /// <summary>

diff --git a/...mat.OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_office_2006_01_customui.g.cs b/...mat.OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_office_2006_01_customui.g.cs
diff --git a/...tFormat.OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_office_2006_activeX.g.cs b/...tFormat.OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_office_2006_activeX.g.cs
@@ -21,12 +21,12 @@ namespace DocumentFormat.OpenXml.Office.ActiveX
     /// <para>This class is available in Office 2007 and above.</para>
     /// <para>When the object is serialized out as xml, it's qualified name is ax:ocx.</para>
     /// </summary>
-    /// <remark>
+    /// <remarks>
     /// <para>The following table lists the possible child types:</para>
     /// <list type="bullet">
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.ActiveX.ActiveXObjectProperty" /> <c>&lt;ax:ocxPr></c></description></item>
     /// </list>
-    /// </remark>
+    /// </remarks>
     public partial class ActiveXControlData : OpenXmlCompositeElement
     {
         /// <summary>
@@ -64,9 +64,9 @@ public ActiveXControlData(string outerXml) : base(outerXml)
         /// <para>classid</para>
         /// <para>Represents the following attribute in the schema: ax:classid</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:ax=http://schemas.microsoft.com/office/2006/activeX
-        /// </remark>
+        /// </remarks>
         public StringValue? ActiveXControlClassId
         {
             get => GetAttribute<StringValue>();
@@ -77,9 +77,9 @@ public StringValue? ActiveXControlClassId
         /// <para>license</para>
         /// <para>Represents the following attribute in the schema: ax:license</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:ax=http://schemas.microsoft.com/office/2006/activeX
-        /// </remark>
+        /// </remarks>
         public StringValue? License
         {
             get => GetAttribute<StringValue>();
@@ -90,9 +90,9 @@ public StringValue? License
         /// <para>id</para>
         /// <para>Represents the following attribute in the schema: r:id</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:r=http://schemas.openxmlformats.org/officeDocument/2006/relationships
-        /// </remark>
+        /// </remarks>
         public StringValue? Id
         {
             get => GetAttribute<StringValue>();
@@ -103,9 +103,9 @@ public StringValue? Id
         /// <para>persistence</para>
         /// <para>Represents the following attribute in the schema: ax:persistence</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:ax=http://schemas.microsoft.com/office/2006/activeX
-        /// </remark>
+        /// </remarks>
         public EnumValue<DocumentFormat.OpenXml.Office.ActiveX.PersistenceValues>? Persistence
         {
             get => GetAttribute<EnumValue<DocumentFormat.OpenXml.Office.ActiveX.PersistenceValues>>();
@@ -143,13 +143,13 @@ internal override void ConfigureMetadata(ElementMetadata.Builder builder)
     /// <para>This class is available in Office 2007 and above.</para>
     /// <para>When the object is serialized out as xml, it's qualified name is ax:ocxPr.</para>
     /// </summary>
-    /// <remark>
+    /// <remarks>
     /// <para>The following table lists the possible child types:</para>
     /// <list type="bullet">
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.ActiveX.SharedComFont" /> <c>&lt;ax:font></c></description></item>
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.ActiveX.SharedComPicture" /> <c>&lt;ax:picture></c></description></item>
     /// </list>
-    /// </remark>
+    /// </remarks>
     public partial class ActiveXObjectProperty : OpenXmlCompositeElement
     {
         /// <summary>
@@ -187,9 +187,9 @@ public ActiveXObjectProperty(string outerXml) : base(outerXml)
         /// <para>name</para>
         /// <para>Represents the following attribute in the schema: ax:name</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:ax=http://schemas.microsoft.com/office/2006/activeX
-        /// </remark>
+        /// </remarks>
         public StringValue? Name
         {
             get => GetAttribute<StringValue>();
@@ -200,9 +200,9 @@ public StringValue? Name
         /// <para>value</para>
         /// <para>Represents the following attribute in the schema: ax:value</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:ax=http://schemas.microsoft.com/office/2006/activeX
-        /// </remark>
+        /// </remarks>
         public StringValue? Value
         {
             get => GetAttribute<StringValue>();
@@ -235,9 +235,9 @@ internal override void ConfigureMetadata(ElementMetadata.Builder builder)
         /// <para>SharedComFont.</para>
         /// <para>Represents the following element tag in the schema: ax:font.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:ax = http://schemas.microsoft.com/office/2006/activeX
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.ActiveX.SharedComFont? SharedComFont
         {
             get => GetElement<DocumentFormat.OpenXml.Office.ActiveX.SharedComFont>();
@@ -248,9 +248,9 @@ public DocumentFormat.OpenXml.Office.ActiveX.SharedComFont? SharedComFont
         /// <para>SharedComPicture.</para>
         /// <para>Represents the following element tag in the schema: ax:picture.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:ax = http://schemas.microsoft.com/office/2006/activeX
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.ActiveX.SharedComPicture? SharedComPicture
         {
             get => GetElement<DocumentFormat.OpenXml.Office.ActiveX.SharedComPicture>();
@@ -266,12 +266,12 @@ public DocumentFormat.OpenXml.Office.ActiveX.SharedComPicture? SharedComPicture
     /// <para>This class is available in Office 2007 and above.</para>
     /// <para>When the object is serialized out as xml, it's qualified name is ax:font.</para>
     /// </summary>
-    /// <remark>
+    /// <remarks>
     /// <para>The following table lists the possible child types:</para>
     /// <list type="bullet">
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.ActiveX.ActiveXObjectProperty" /> <c>&lt;ax:ocxPr></c></description></item>
     /// </list>
-    /// </remark>
+    /// </remarks>
     public partial class SharedComFont : OpenXmlCompositeElement
     {
         /// <summary>
@@ -309,9 +309,9 @@ public SharedComFont(string outerXml) : base(outerXml)
         /// <para>persistence</para>
         /// <para>Represents the following attribute in the schema: ax:persistence</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:ax=http://schemas.microsoft.com/office/2006/activeX
-        /// </remark>
+        /// </remarks>
         public EnumValue<DocumentFormat.OpenXml.Office.ActiveX.PersistenceValues>? Persistence
         {
             get => GetAttribute<EnumValue<DocumentFormat.OpenXml.Office.ActiveX.PersistenceValues>>();
@@ -322,9 +322,9 @@ public EnumValue<DocumentFormat.OpenXml.Office.ActiveX.PersistenceValues>? Persi
         /// <para>id</para>
         /// <para>Represents the following attribute in the schema: r:id</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:r=http://schemas.openxmlformats.org/officeDocument/2006/relationships
-        /// </remark>
+        /// </remarks>
         public StringValue? Id
         {
             get => GetAttribute<StringValue>();
@@ -367,9 +367,9 @@ public SharedComPicture() : base()
         /// <para>id</para>
         /// <para>Represents the following attribute in the schema: r:id</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:r=http://schemas.openxmlformats.org/officeDocument/2006/relationships
-        /// </remark>
+        /// </remarks>
         public StringValue? Id
         {
             get => GetAttribute<StringValue>();

diff --git a/....OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_office_2006_coverPageProps.g.cs b/....OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_office_2006_coverPageProps.g.cs
@@ -21,7 +21,7 @@ namespace DocumentFormat.OpenXml.Office.CoverPageProps
     /// <para>This class is available in Office 2007 and above.</para>
     /// <para>When the object is serialized out as xml, it's qualified name is cppr:CoverPageProperties.</para>
     /// </summary>
-    /// <remark>
+    /// <remarks>
     /// <para>The following table lists the possible child types:</para>
     /// <list type="bullet">
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.CoverPageProps.PublishDate" /> <c>&lt;cppr:PublishDate></c></description></item>
@@ -31,7 +31,7 @@ namespace DocumentFormat.OpenXml.Office.CoverPageProps
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.CoverPageProps.CompanyFaxNumber" /> <c>&lt;cppr:CompanyFax></c></description></item>
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.CoverPageProps.CompanyEmailAddress" /> <c>&lt;cppr:CompanyEmail></c></description></item>
     /// </list>
-    /// </remark>
+    /// </remarks>
     public partial class CoverPageProperties : OpenXmlCompositeElement
     {
         /// <summary>
@@ -90,9 +90,9 @@ internal override void ConfigureMetadata(ElementMetadata.Builder builder)
         /// <para>PublishDate.</para>
         /// <para>Represents the following element tag in the schema: cppr:PublishDate.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:cppr = http://schemas.microsoft.com/office/2006/coverPageProps
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.CoverPageProps.PublishDate? PublishDate
         {
             get => GetElement<DocumentFormat.OpenXml.Office.CoverPageProps.PublishDate>();
@@ -103,9 +103,9 @@ public DocumentFormat.OpenXml.Office.CoverPageProps.PublishDate? PublishDate
         /// <para>DocumentAbstract.</para>
         /// <para>Represents the following element tag in the schema: cppr:Abstract.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:cppr = http://schemas.microsoft.com/office/2006/coverPageProps
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.CoverPageProps.DocumentAbstract? DocumentAbstract
         {
             get => GetElement<DocumentFormat.OpenXml.Office.CoverPageProps.DocumentAbstract>();
@@ -116,9 +116,9 @@ public DocumentFormat.OpenXml.Office.CoverPageProps.DocumentAbstract? DocumentAb
         /// <para>CompanyAddress.</para>
         /// <para>Represents the following element tag in the schema: cppr:CompanyAddress.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:cppr = http://schemas.microsoft.com/office/2006/coverPageProps
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.CoverPageProps.CompanyAddress? CompanyAddress
         {
             get => GetElement<DocumentFormat.OpenXml.Office.CoverPageProps.CompanyAddress>();
@@ -129,9 +129,9 @@ public DocumentFormat.OpenXml.Office.CoverPageProps.CompanyAddress? CompanyAddre
         /// <para>CompanyPhoneNumber.</para>
         /// <para>Represents the following element tag in the schema: cppr:CompanyPhone.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:cppr = http://schemas.microsoft.com/office/2006/coverPageProps
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.CoverPageProps.CompanyPhoneNumber? CompanyPhoneNumber
         {
             get => GetElement<DocumentFormat.OpenXml.Office.CoverPageProps.CompanyPhoneNumber>();
@@ -142,9 +142,9 @@ public DocumentFormat.OpenXml.Office.CoverPageProps.CompanyPhoneNumber? CompanyP
         /// <para>CompanyFaxNumber.</para>
         /// <para>Represents the following element tag in the schema: cppr:CompanyFax.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:cppr = http://schemas.microsoft.com/office/2006/coverPageProps
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.CoverPageProps.CompanyFaxNumber? CompanyFaxNumber
         {
             get => GetElement<DocumentFormat.OpenXml.Office.CoverPageProps.CompanyFaxNumber>();
@@ -155,9 +155,9 @@ public DocumentFormat.OpenXml.Office.CoverPageProps.CompanyFaxNumber? CompanyFax
         /// <para>CompanyEmailAddress.</para>
         /// <para>Represents the following element tag in the schema: cppr:CompanyEmail.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:cppr = http://schemas.microsoft.com/office/2006/coverPageProps
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.CoverPageProps.CompanyEmailAddress? CompanyEmailAddress
         {
             get => GetElement<DocumentFormat.OpenXml.Office.CoverPageProps.CompanyEmailAddress>();

diff --git a/...or.OpenXmlGenerator/schemas_microsoft_com_office_2006_customDocumentInformationPanel.g.cs b/...or.OpenXmlGenerator/schemas_microsoft_com_office_2006_customDocumentInformationPanel.g.cs
@@ -21,14 +21,14 @@ namespace DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel
     /// <para>This class is available in Office 2007 and above.</para>
     /// <para>When the object is serialized out as xml, it's qualified name is cdip:customPropertyEditors.</para>
     /// </summary>
-    /// <remark>
+    /// <remarks>
     /// <para>The following table lists the possible child types:</para>
     /// <list type="bullet">
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.CustomPropertyEditor" /> <c>&lt;cdip:customPropertyEditor></c></description></item>
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.DefaultPropertyEditorNamespace" /> <c>&lt;cdip:defaultPropertyEditorNamespace></c></description></item>
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.ShowOnOpen" /> <c>&lt;cdip:showOnOpen></c></description></item>
     /// </list>
-    /// </remark>
+    /// </remarks>
     public partial class CustomPropertyEditors : OpenXmlCompositeElement
     {
         /// <summary>
@@ -81,9 +81,9 @@ internal override void ConfigureMetadata(ElementMetadata.Builder builder)
         /// <para>ShowOnOpen.</para>
         /// <para>Represents the following element tag in the schema: cdip:showOnOpen.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:cdip = http://schemas.microsoft.com/office/2006/customDocumentInformationPanel
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.ShowOnOpen? ShowOnOpen
         {
             get => GetElement<DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.ShowOnOpen>();
@@ -94,9 +94,9 @@ public DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.ShowOnOpen?
         /// <para>DefaultPropertyEditorNamespace.</para>
         /// <para>Represents the following element tag in the schema: cdip:defaultPropertyEditorNamespace.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:cdip = http://schemas.microsoft.com/office/2006/customDocumentInformationPanel
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.DefaultPropertyEditorNamespace? DefaultPropertyEditorNamespace
         {
             get => GetElement<DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.DefaultPropertyEditorNamespace>();
@@ -263,13 +263,13 @@ internal override void ConfigureMetadata(ElementMetadata.Builder builder)
     /// <para>This class is available in Office 2007 and above.</para>
     /// <para>When the object is serialized out as xml, it's qualified name is cdip:customPropertyEditor.</para>
     /// </summary>
-    /// <remark>
+    /// <remarks>
     /// <para>The following table lists the possible child types:</para>
     /// <list type="bullet">
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.PropertyEditorNamespace" /> <c>&lt;cdip:XMLNamespace></c></description></item>
     ///   <item><description><see cref="DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.XsnFileLocation" /> <c>&lt;cdip:XSNLocation></c></description></item>
     /// </list>
-    /// </remark>
+    /// </remarks>
     public partial class CustomPropertyEditor : OpenXmlCompositeElement
     {
         /// <summary>
@@ -320,9 +320,9 @@ internal override void ConfigureMetadata(ElementMetadata.Builder builder)
         /// <para>PropertyEditorNamespace.</para>
         /// <para>Represents the following element tag in the schema: cdip:XMLNamespace.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:cdip = http://schemas.microsoft.com/office/2006/customDocumentInformationPanel
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.PropertyEditorNamespace? PropertyEditorNamespace
         {
             get => GetElement<DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.PropertyEditorNamespace>();
@@ -333,9 +333,9 @@ public DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.PropertyEdit
         /// <para>XsnFileLocation.</para>
         /// <para>Represents the following element tag in the schema: cdip:XSNLocation.</para>
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// xmlns:cdip = http://schemas.microsoft.com/office/2006/customDocumentInformationPanel
-        /// </remark>
+        /// </remarks>
         public DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.XsnFileLocation? XsnFileLocation
         {
             get => GetElement<DocumentFormat.OpenXml.Office.CustomDocumentInformationPanel.XsnFileLocation>();