Skip to content

A fix to the use of <remark> tags rather than <remarks> in the documentation comments #1776

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

Merged
merged 3 commits into from
Oct 8, 2024
Merged

A fix to the use of <remark> tags rather than <remarks> in the documentation comments #1776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7c4f6d
Fixes the code generator to use <remarks>.
AlissaSabre Aug 24, 2024
f0d1c08
Fixes manually written <remark> tags.
AlissaSabre Aug 24, 2024
7e08714
Adds the files produced by the fixed generator.
AlissaSabre Aug 27, 2024
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
2 changes: 1 addition & 1 deletion gen/DocumentFormat.OpenXml.Generator.Models/Editor/DocumentCommentExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
4 changes: 2 additions & 2 deletions ...DocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas-microsoft-com_office_excel.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
224 changes: 112 additions & 112 deletions ...ocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas-microsoft-com_office_office.g.cs
View file
Open in desktop

Large diffs are not rendered by default.

1,688 changes: 844 additions & 844 deletions ...enerator/DocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas-microsoft-com_vml.g.cs
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions ...ocumentFormat.OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_ink_2010_main.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
144 changes: 72 additions & 72 deletions ...mat.OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_office_2006_01_customui.g.cs
View file
Open in desktop

Large diffs are not rendered by default.

56 changes: 28 additions & 28 deletions ...tFormat.OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_office_2006_activeX.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>();
Expand All @@ -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>();
Expand All @@ -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>();
Expand All @@ -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>>();
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>();
Expand All @@ -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>();
Expand Down Expand Up @@ -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>();
Expand All @@ -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>();
Expand All @@ -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>
Expand Down Expand Up @@ -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>>();
Expand All @@ -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>();
Expand Down Expand Up @@ -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>();
Expand Down
28 changes: 14 additions & 14 deletions ....OpenXml.Generator.OpenXmlGenerator/schemas_microsoft_com_office_2006_coverPageProps.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>();
Expand All @@ -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>();
Expand All @@ -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>();
Expand All @@ -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>();
Expand All @@ -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>();
Expand All @@ -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>();
Expand Down
24 changes: 12 additions & 12 deletions ...or.OpenXmlGenerator/schemas_microsoft_com_office_2006_customDocumentInformationPanel.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>();
Expand All @@ -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>();
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>();
Expand All @@ -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>();
Expand Down
Loading