diff --git a/.editorconfig b/.editorconfig index 6b402243..d1a37da2 100644 --- a/.editorconfig +++ b/.editorconfig @@ -202,6 +202,8 @@ dotnet_diagnostic.MA0053.severity = warning MA0053.public_class_should_be_sealed = true # MA0076: Do not use implicit culture-sensitive ToString in interpolated strings dotnet_diagnostic.MA0076.severity = warning +# MA0154: Use langword in XML comment +dotnet_diagnostic.MA0154.severity = warning # Disable MA0053 (sealing class) for types that have been publicly exposed in a previous version [{AutoFilterOptions.cs,ColumnOptions.cs,RowOptions.cs,SpreadCheetahOptions.cs,WorksheetOptions.cs,WorksheetRowGenerator.cs}] diff --git a/Directory.Packages.props b/Directory.Packages.props index 761b456e..e51614d2 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -9,7 +9,7 @@ - + diff --git a/SpreadCheetah/Cell.cs b/SpreadCheetah/Cell.cs index 76842f40..86c3ad0b 100644 --- a/SpreadCheetah/Cell.cs +++ b/SpreadCheetah/Cell.cs @@ -19,7 +19,7 @@ public readonly record struct Cell /// /// Initializes a new instance of the struct with a text value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public Cell(string? value, StyleId? styleId = null) : this(new DataCell(value), null, styleId) { @@ -34,7 +34,7 @@ public Cell(int value, StyleId? styleId = null) : this(new DataCell(value), null /// /// Initializes a new instance of the struct with an integer value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public Cell(int? value, StyleId? styleId = null) : this(new DataCell(value), null, styleId) { @@ -50,7 +50,7 @@ public Cell(long value, StyleId? styleId = null) : this(new DataCell(value), nul /// /// Initializes a new instance of the struct with a long integer value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// Note that Open XML limits the precision to 15 significant digits for numbers. This could potentially lead to a loss of precision. /// public Cell(long? value, StyleId? styleId = null) : this(new DataCell(value), null, styleId) @@ -66,7 +66,7 @@ public Cell(float value, StyleId? styleId = null) : this(new DataCell(value), nu /// /// Initializes a new instance of the struct with a floating point value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public Cell(float? value, StyleId? styleId = null) : this(new DataCell(value), null, styleId) { @@ -82,7 +82,7 @@ public Cell(double value, StyleId? styleId = null) : this(new DataCell(value), n /// /// Initializes a new instance of the struct with a double-precision floating-point value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// Note that Open XML limits the precision to 15 significant digits for numbers. This could potentially lead to a loss of precision. /// public Cell(double? value, StyleId? styleId = null) : this(new DataCell(value), null, styleId) @@ -99,7 +99,7 @@ public Cell(decimal value, StyleId? styleId = null) : this(new DataCell(value), /// /// Initializes a new instance of the struct with a decimal floating-point value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// Note that Open XML limits the precision to 15 significant digits for numbers. This could potentially lead to a loss of precision. /// public Cell(decimal? value, StyleId? styleId = null) : this(new DataCell(value), null, styleId) @@ -119,7 +119,7 @@ public Cell(DateTime value, StyleId? styleId = null) : this(new DataCell(value), /// Initializes a new instance of the struct with a value and an optional style. /// Will be displayed in the number format from if set, /// otherwise will be used instead. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public Cell(DateTime? value, StyleId? styleId = null) : this(new DataCell(value), null, styleId) { @@ -134,7 +134,7 @@ public Cell(bool value, StyleId? styleId = null) : this(new DataCell(value), nul /// /// Initializes a new instance of the struct with a boolean value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public Cell(bool? value, StyleId? styleId = null) : this(new DataCell(value), null, styleId) { diff --git a/SpreadCheetah/DataCell.cs b/SpreadCheetah/DataCell.cs index d14bb2b1..140284d9 100644 --- a/SpreadCheetah/DataCell.cs +++ b/SpreadCheetah/DataCell.cs @@ -13,7 +13,7 @@ public readonly record struct DataCell /// /// Initializes a new instance of the struct with a text value. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public DataCell(string? value) { @@ -32,7 +32,7 @@ public DataCell(int value) /// /// Initializes a new instance of the struct with an integer value. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public DataCell(int? value) { @@ -50,7 +50,7 @@ public DataCell(long value) : this((double)value) /// /// Initializes a new instance of the struct with a long integer value. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// Note that Open XML limits the precision to 15 significant digits for numbers. This could potentially lead to a loss of precision. /// public DataCell(long? value) : this((double?)value) @@ -68,7 +68,7 @@ public DataCell(float value) /// /// Initializes a new instance of the struct with a floating-point value. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public DataCell(float? value) { @@ -88,7 +88,7 @@ public DataCell(double value) /// /// Initializes a new instance of the struct with a double-precision floating-point value. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// Note that Open XML limits the precision to 15 significant digits for numbers. This could potentially lead to a loss of precision. /// public DataCell(double? value) @@ -107,7 +107,7 @@ public DataCell(decimal value) : this(decimal.ToDouble(value)) /// /// Initializes a new instance of the struct with a decimal floating-point value. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// Note that Open XML limits the precision to 15 significant digits for numbers. This could potentially lead to a loss of precision. /// public DataCell(decimal? value) : this(value != null ? decimal.ToDouble(value.GetValueOrDefault()) : null) @@ -127,7 +127,7 @@ public DataCell(DateTime value) /// /// Initializes a new instance of the struct with a value. /// Will be displayed in the number format from . - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public DataCell(DateTime? value) { @@ -145,7 +145,7 @@ public DataCell(bool value) /// /// Initializes a new instance of the struct with a boolean value. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public DataCell(bool? value) { diff --git a/SpreadCheetah/Images/ImageCanvas.cs b/SpreadCheetah/Images/ImageCanvas.cs index dd055ca4..7e27be1d 100644 --- a/SpreadCheetah/Images/ImageCanvas.cs +++ b/SpreadCheetah/Images/ImageCanvas.cs @@ -101,8 +101,8 @@ private static ImageCanvas FillCell(SingleCellRelativeReference upperLeft, ushor /// The parameter decides whether or not the image should move when /// cells further up or left change size. /// The parameter decides whether or not the image should resize when - /// the cell is being resized. can only be set to true - /// if is also set to true. + /// the cell is being resized. can only be set to + /// if is also set to . /// public static ImageCanvas FillCell(ReadOnlySpan cellReference, bool moveWithCells = true, bool resizeWithCells = true) { @@ -119,8 +119,8 @@ public static ImageCanvas FillCell(ReadOnlySpan cellReference, bool moveWi /// The parameter decides whether or not the image should move when /// cells further up or left change size. /// The parameter decides whether or not the image should resize when - /// the cell range is being resized. can only be set to true - /// if is also set to true. + /// the cell range is being resized. can only be set to + /// if is also set to . /// public static ImageCanvas FillCells(ReadOnlySpan upperLeftReference, ReadOnlySpan lowerRightReference, bool moveWithCells = true, bool resizeWithCells = true) { diff --git a/SpreadCheetah/SpreadCheetahOptions.cs b/SpreadCheetah/SpreadCheetahOptions.cs index 79771a1b..3bd4d304 100644 --- a/SpreadCheetah/SpreadCheetahOptions.cs +++ b/SpreadCheetah/SpreadCheetahOptions.cs @@ -60,7 +60,7 @@ public string? DefaultDateTimeNumberFormat /// Microsoft Spreadsheet Compare tool. /// /// Writing the attribute will slightly affect the performance of writing cells, and will also increase the resulting file size. - /// Defaults to false. + /// Defaults to . /// public bool WriteCellReferenceAttributes { get; set; } } diff --git a/SpreadCheetah/Spreadsheet.cs b/SpreadCheetah/Spreadsheet.cs index 3ca1cc2f..0c7e0399 100644 --- a/SpreadCheetah/Spreadsheet.cs +++ b/SpreadCheetah/Spreadsheet.cs @@ -432,7 +432,7 @@ public void AddDataValidation(string reference, DataValidation validation) /// A1:A1048576References all cells in column A. /// A5:XFD5References all cells in row 5. /// - /// Note that there can be max 65534 data validations in a worksheet. This method returns false if attempting to add more than that. + /// Note that there can be max 65534 data validations in a worksheet. This method returns if attempting to add more than that. /// public bool TryAddDataValidation(string reference, DataValidation validation) { diff --git a/SpreadCheetah/SpreadsheetUtility.cs b/SpreadCheetah/SpreadsheetUtility.cs index 14d16da4..f872fbec 100644 --- a/SpreadCheetah/SpreadsheetUtility.cs +++ b/SpreadCheetah/SpreadsheetUtility.cs @@ -59,7 +59,7 @@ public static string GetColumnName(int columnNumber) /// /// Try to write the UTF8 column name from a column number into the specified span. E.g. column number 1 results in column name 'A'. - /// Returns true if the column name was written into the span, and false otherwise. + /// Returns if the column name was written into the span, and otherwise. /// public static bool TryGetColumnNameUtf8(int columnNumber, Span destination, out int bytesWritten) { @@ -106,7 +106,7 @@ public static bool TryGetColumnNameUtf8(int columnNumber, Span destination /// /// Try to parse the column number from a column name. E.g. column name 'A' can be parsed to column number 1. - /// Returns true if the column number was parsed successfully, and false otherwise. + /// Returns if the column number was parsed successfully, and otherwise. /// public static bool TryParseColumnName(ReadOnlySpan columnName, out int columnNumber) { diff --git a/SpreadCheetah/StyledCell.cs b/SpreadCheetah/StyledCell.cs index 9a1eb503..fba5230e 100644 --- a/SpreadCheetah/StyledCell.cs +++ b/SpreadCheetah/StyledCell.cs @@ -14,7 +14,7 @@ public readonly record struct StyledCell /// /// Initializes a new instance of the struct with a text value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public StyledCell(string? value, StyleId? styleId) { @@ -33,7 +33,7 @@ public StyledCell(int value, StyleId? styleId) /// /// Initializes a new instance of the struct with an integer value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public StyledCell(int? value, StyleId? styleId) { @@ -53,7 +53,7 @@ public StyledCell(long value, StyleId? styleId) /// /// Initializes a new instance of the struct with a long integer value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// Note that Open XML limits the precision to 15 significant digits for numbers. This could potentially lead to a loss of precision. /// public StyledCell(long? value, StyleId? styleId) @@ -73,7 +73,7 @@ public StyledCell(float value, StyleId? styleId) /// /// Initializes a new instance of the struct with a floating point value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public StyledCell(float? value, StyleId? styleId) { @@ -93,7 +93,7 @@ public StyledCell(double value, StyleId? styleId) /// /// Initializes a new instance of the struct with a double-precision floating-point value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// Note that Open XML limits the precision to 15 significant digits for numbers. This could potentially lead to a loss of precision. /// public StyledCell(double? value, StyleId? styleId) @@ -114,7 +114,7 @@ public StyledCell(decimal value, StyleId? styleId) /// /// Initializes a new instance of the struct with a decimal floating-point value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// Note that Open XML limits the precision to 15 significant digits for numbers. This could potentially lead to a loss of precision. /// public StyledCell(decimal? value, StyleId? styleId) @@ -138,7 +138,7 @@ public StyledCell(DateTime value, StyleId? styleId) /// Initializes a new instance of the struct with a value and an optional style. /// Will be displayed in the number format from if set, /// otherwise will be used instead. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public StyledCell(DateTime? value, StyleId? styleId) { @@ -157,7 +157,7 @@ public StyledCell(bool value, StyleId? styleId) /// /// Initializes a new instance of the struct with a boolean value and an optional style. - /// If value is null, the cell will be empty. + /// If value is , the cell will be empty. /// public StyledCell(bool? value, StyleId? styleId) { diff --git a/SpreadCheetah/Styling/Font.cs b/SpreadCheetah/Styling/Font.cs index b9cff316..8c0cc2d8 100644 --- a/SpreadCheetah/Styling/Font.cs +++ b/SpreadCheetah/Styling/Font.cs @@ -19,13 +19,13 @@ public string? Name set => _name = XmlUtility.XmlEncode(value.WithEnsuredMaxLength(31)); } - /// Bold font weight. Defaults to false. + /// Bold font weight. Defaults to . public bool Bold { get; set; } - /// Italic font type. Defaults to false. + /// Italic font type. Defaults to . public bool Italic { get; set; } - /// Adds a horizontal line through the center of the characters. Defaults to false. + /// Adds a horizontal line through the center of the characters. Defaults to . public bool Strikethrough { get; set; } /// Font size. Defaults to 11. diff --git a/SpreadCheetah/Validations/DataValidation.cs b/SpreadCheetah/Validations/DataValidation.cs index 2afcee37..e54f9b6c 100644 --- a/SpreadCheetah/Validations/DataValidation.cs +++ b/SpreadCheetah/Validations/DataValidation.cs @@ -37,11 +37,11 @@ private DataValidation( Value2 = value2; } - /// Ignore cells without values. Defaults to true. + /// Ignore cells without values. Defaults to . public bool IgnoreBlank { get; set; } = true; - /// Show an error alert for invalid values. Defaults to true. + /// Show an error alert for invalid values. Defaults to . public bool ShowErrorAlert { get; set; } = true; - /// Show the input message box. Defaults to true. + /// Show the input message box. Defaults to . public bool ShowInputMessage { get; set; } = true; /// Title for error alerts. Maximum 32 characters. @@ -219,7 +219,7 @@ public static DataValidation ListValues(IEnumerable values, bool showDro /// The values can't contain commas. /// The combined length of the values (including required comma separators) can't exceed 255 characters. /// - /// Returns false if any of these requirements are not met. + /// Returns if any of these requirements are not met. /// public static bool TryCreateListValues(IEnumerable values, bool showDropdown, [NotNullWhen(true)] out DataValidation? dataValidation) { diff --git a/SpreadCheetah/Worksheets/ColumnOptions.cs b/SpreadCheetah/Worksheets/ColumnOptions.cs index f7ae8d32..b46ca4f1 100644 --- a/SpreadCheetah/Worksheets/ColumnOptions.cs +++ b/SpreadCheetah/Worksheets/ColumnOptions.cs @@ -20,7 +20,7 @@ public double? Width private double? _width; /// - /// Is the column hidden or not. Defaults to false. + /// Is the column hidden or not. Defaults to . /// public bool Hidden { get; set; } }