Do not use placeholders in summaries

src/.editorconfig

@@ -413,3 +413,5 @@ dotnet_diagnostic.SA1514.severity = warning      # Element documentation header
 dotnet_diagnostic.SA1623.severity = warning      # Property summary documentation must match accessors
 dotnet_diagnostic.SA1626.severity = warning      # Single-line comments must not use documentation style slashes
 dotnet_diagnostic.SA1636.severity = none         # Disable file header matching
+dotnet_diagnostic.SA1649.severity = warning      # File name must match first type name
+dotnet_diagnostic.SA1651.severity = warning      # Do not use placeholders in summaries

src/DotNetStac/Collection/IStacSummaryItem.cs

@@ -21,7 +21,7 @@ public interface IStacSummaryItem : IEnumerable<JToken>
         /// Gets the summary item as a JToken
         /// </summary>
         /// <value>
-        /// <placeholder>The summary item as a JToken</placeholder>
+        /// The summary item as a JToken
         /// </value>
         JToken AsJToken { get; }
 

src/DotNetStac/Collection/StacSummaryItem.cs

@@ -42,7 +42,7 @@ public JToken this[object key]
         /// Gets jToken transformer
         /// </summary>
         /// <value>
-        /// <placeholder>JToken transformer</placeholder>
+        /// JToken transformer
         /// </value>
         public JToken AsJToken => this.summary;
 

src/DotNetStac/Collection/StacSummaryRangeObject.cs

@@ -43,7 +43,7 @@ public StacSummaryRangeObject(T min, T max) : base(new JObject())
         /// </summary>
         /// <returns>Minimum of the range</returns>
         /// <value>
-        /// <placeholder>Minimum of the range</placeholder>
+        /// Minimum of the range
         /// </value>
         public T Min { get => this.summary["minimum"].Value<T>(); set => this.summary["minimum"] = new JValue(value); }
 
@@ -52,7 +52,7 @@ public StacSummaryRangeObject(T min, T max) : base(new JObject())
         /// </summary>
         /// <returns>Maximum of the range</returns>
         /// <value>
-        /// <placeholder>Maximum of the range</placeholder>
+        /// Maximum of the range
         /// </value>
         public T Max { get => this.summary["maximum"].Value<T>(); set => this.summary["maximum"] = new JValue(value); }
 

src/DotNetStac/Collection/StacSummaryValueSet.cs

@@ -50,19 +50,19 @@ public void Add(T item)
         /// Gets summary Value Set total of items
         /// </summary>
         /// <value>
-        /// <placeholder>Summary Value Set total of items</placeholder>
+        /// Summary Value Set total of items
         /// </value>
 
         /// <value>
-        /// <placeholder>Summary Value Set total of items</placeholder>
+        /// Summary Value Set total of items
         /// </value>
         public int Count => this.summary.Count();
 
         /// <summary>
         /// Gets get the Summary Value Set as an enumerable
         /// </summary>
         /// <value>
-        /// <placeholder>Get the Summary Value Set as an enumerable</placeholder>
+        /// Get the Summary Value Set as an enumerable
         /// </value>
         public IEnumerable<T> SummarySet { get => this.summary.ToObject<List<T>>(); }
 

src/DotNetStac/Collection/StacTemporalExtent.cs

@@ -39,7 +39,7 @@ public StacTemporalExtent(StacTemporalExtent temporal)
         /// Gets or sets potential temporal extents.
         /// </summary>
         /// <value>
-        /// <placeholder>Potential temporal extents.</placeholder>
+        /// Potential temporal extents.
         /// </value>
         [JsonProperty("interval")]
         public DateTime?[][] Interval { get; set; }

src/DotNetStac/Common/PropertyObservableCollection.cs

@@ -8,6 +8,8 @@
 
 namespace Stac.Common
 {
+#pragma warning disable SA1649 // File name should match first type name
+
     /// <summary>
     /// A collection that is observable and that is also stored in a <see cref="IStacPropertiesContainer"/> as a property.
     /// </summary>
@@ -30,27 +32,29 @@ public PropertyObservableCollection(IStacPropertiesContainer propertiesContainer
         /// Gets the properties container.
         /// </summary>
         /// <value>
-        /// <placeholder>The properties container.</placeholder>
+        /// The properties container.
         /// </value>
         public IStacPropertiesContainer PropertiesContainer { get; }
 
         /// <summary>
         /// Gets the property key.
         /// </summary>
         /// <value>
-        /// <placeholder>The property key.</placeholder>
+        /// The property key.
         /// </value>
         public string Key { get; }
 
         private void ObservableCollectionInPropertiesChanged(object sender, NotifyCollectionChangedEventArgs e)
         {
             this.PropertiesContainer.RemoveProperty(this.Key);
-            if (this.Count == 0)
-            {
-                return;
-            }
-
+            if (this.Count == 0)
+            {
+                return;
+            }
+
             this.PropertiesContainer.SetProperty(this.Key, this.ToList());
         }
     }
+
+#pragma warning restore SA1649 // File name should match first type name
 }

src/DotNetStac/Common/Statistics.cs

@@ -38,7 +38,7 @@ public Statistics(double? minimum, double? maximum, double? mean, double? stdev,
         /// Gets or sets mean value
         /// </summary>
         /// <value>
-        /// <placeholder>Mean value</placeholder>
+        /// Mean value
         /// </value>
         [JsonProperty("mean")]
         public double? Mean { get; set; }
@@ -47,7 +47,7 @@ public Statistics(double? minimum, double? maximum, double? mean, double? stdev,
         /// Gets or sets minimum value
         /// </summary>
         /// <value>
-        /// <placeholder>Minimum value</placeholder>
+        /// Minimum value
         /// </value>
         [JsonProperty("minimum")]
         public double? Minimum { get; set; }
@@ -56,7 +56,7 @@ public Statistics(double? minimum, double? maximum, double? mean, double? stdev,
         /// Gets or sets maximum value
         /// </summary>
         /// <value>
-        /// <placeholder>Maximum value</placeholder>
+        /// Maximum value
         /// </value>
         [JsonProperty("maximum")]
         public double? Maximum { get; set; }
@@ -65,7 +65,7 @@ public Statistics(double? minimum, double? maximum, double? mean, double? stdev,
         /// Gets or sets standard Deviation
         /// </summary>
         /// <value>
-        /// <placeholder>Standard Deviation</placeholder>
+        /// Standard Deviation
         /// </value>
         [JsonProperty("stdev")]
         public double? Stdev { get; set; }
@@ -74,7 +74,7 @@ public Statistics(double? minimum, double? maximum, double? mean, double? stdev,
         /// Gets or sets valid percentage
         /// </summary>
         /// <value>
-        /// <placeholder>Valid percentage</placeholder>
+        /// Valid percentage
         /// </value>
         [JsonProperty("valid_percent")]
         public double? ValidPercent { get; set; }
@@ -83,7 +83,7 @@ public Statistics(double? minimum, double? maximum, double? mean, double? stdev,
         /// Gets or sets additional fields
         /// </summary>
         /// <value>
-        /// <placeholder>Additional fields</placeholder>
+        /// Additional fields
         /// </value>
         [JsonExtensionData]
         public IDictionary<string, object> Properties { get => this.properties; set => this.properties = value; }

src/DotNetStac/Extensions/Alternate/AlternateAssetObject.cs

@@ -42,7 +42,7 @@ public AlternateAssetObject(string href, IStacObject parent = null, string title
         /// Gets or sets rEQUIRED. URI to the asset object. Relative and absolute URI are both allowed.
         /// </summary>
         /// <value>
-        /// <placeholder>REQUIRED. URI to the asset object. Relative and absolute URI are both allowed.</placeholder>
+        /// REQUIRED. URI to the asset object. Relative and absolute URI are both allowed.
         /// </value>
         [JsonProperty("href")]
         [JsonRequired]
@@ -52,7 +52,7 @@ public AlternateAssetObject(string href, IStacObject parent = null, string title
         /// Gets or sets the displayed title for clients and users.
         /// </summary>
         /// <value>
-        /// <placeholder>The displayed title for clients and users.</placeholder>
+        /// The displayed title for clients and users.
         /// </value>
         [JsonProperty("title")]
         public string Title { get => this.title; set => this.title = value; }
@@ -61,7 +61,7 @@ public AlternateAssetObject(string href, IStacObject parent = null, string title
         /// Gets or sets a description of the Asset providing additional details, such as how it was processed or created. CommonMark 0.29 syntax MAY be used for rich text representation.
         /// </summary>
         /// <value>
-        /// <placeholder>A description of the Asset providing additional details, such as how it was processed or created. CommonMark 0.29 syntax MAY be used for rich text representation.</placeholder>
+        /// A description of the Asset providing additional details, such as how it was processed or created. CommonMark 0.29 syntax MAY be used for rich text representation.
         /// </value>
         [JsonProperty("description")]
         public string Description { get => this.description; set => this.description = value; }
@@ -70,7 +70,7 @@ public AlternateAssetObject(string href, IStacObject parent = null, string title
         /// Gets or sets additional fields
         /// </summary>
         /// <value>
-        /// <placeholder>Additional fields</placeholder>
+        /// Additional fields
         /// </value>
         [JsonExtensionData]
         public IDictionary<string, object> Properties { get => this.properties; set => this.properties = value; }
@@ -79,11 +79,11 @@ public AlternateAssetObject(string href, IStacObject parent = null, string title
         /// Gets parent Stac Object
         /// </summary>
         /// <value>
-        /// <placeholder>Parent Stac Object</placeholder>
+        /// Parent Stac Object
         /// </value>
 
         /// <value>
-        /// <placeholder>Parent Stac Object</placeholder>
+        /// Parent Stac Object
         /// </value>
         [JsonIgnore]
         public IStacObject StacObjectContainer => this._parent;
@@ -92,11 +92,11 @@ public AlternateAssetObject(string href, IStacObject parent = null, string title
         /// Gets uri
         /// </summary>
         /// <value>
-        /// <placeholder>Uri</placeholder>
+        /// Uri
         /// </value>
 
         /// <value>
-        /// <placeholder>Uri</placeholder>
+        /// Uri
         /// </value>
         [JsonIgnore]
         public Uri Uri => new Uri(this.href);

src/DotNetStac/Extensions/Alternate/AlternateStacExtension.cs

@@ -31,7 +31,7 @@ internal AlternateStacExtension(StacAsset stacAsset) : base(JsonSchemaUrl, stacA
         /// Gets or sets a dictionary of alternate location information for an asset.
         /// </summary>
         /// <value>
-        /// <placeholder>A dictionary of alternate location information for an asset.</placeholder>
+        /// A dictionary of alternate location information for an asset.
         /// </value>
         public IDictionary<string, AlternateAssetObject> AlternateAssets
         {
@@ -52,7 +52,7 @@ public IDictionary<string, AlternateAssetObject> AlternateAssets
         /// Gets potential fields and their types
         /// </summary>
         /// <value>
-        /// <placeholder>Potential fields and their types</placeholder>
+        /// Potential fields and their types
         /// </value>
         public override IDictionary<string, Type> ItemFields => assetFields;
 

src/DotNetStac/Extensions/Datacube/DatacubeDimensionObject.cs

@@ -25,7 +25,7 @@ public class DatacubeDimension : IStacPropertiesContainer
         /// Gets or sets type of the dimension.
         /// </summary>
         /// <value>
-        /// <placeholder>Type of the dimension.</placeholder>
+        /// Type of the dimension.
         /// </value>
         [JsonProperty("type")]
         public string Type { get => this.type; set => this.type = value; }
@@ -34,7 +34,7 @@ public class DatacubeDimension : IStacPropertiesContainer
         /// Gets or sets detailed multi-line description to explain the dimension. <seealso href="http://commonmark.org/">CommonMark 0.29</seealso> syntax MAY be used for rich text representation.
         /// </summary>
         /// <value>
-        /// <placeholder>Detailed multi-line description to explain the dimension. <seealso href="http://commonmark.org/">CommonMark 0.29</seealso> syntax MAY be used for rich text representation.</placeholder>
+        /// Detailed multi-line description to explain the dimension. <seealso href="http://commonmark.org/">CommonMark 0.29</seealso> syntax MAY be used for rich text representation.
         /// </value>
         [JsonProperty("description")]
         public string Description { get => this.description; set => this.description = value; }
@@ -43,7 +43,7 @@ public class DatacubeDimension : IStacPropertiesContainer
         /// Gets or sets extent (lower and upper bounds) of the dimension as two-element array. Open intervals with null are not allowed.
         /// </summary>
         /// <value>
-        /// <placeholder>Extent (lower and upper bounds) of the dimension as two-element array. Open intervals with null are not allowed.</placeholder>
+        /// Extent (lower and upper bounds) of the dimension as two-element array. Open intervals with null are not allowed.
         /// </value>
         [JsonProperty("extent")]
         public double[] Extent { get => this.extent; set => this.extent = value; }
@@ -52,7 +52,7 @@ public class DatacubeDimension : IStacPropertiesContainer
         /// Gets or sets optionally, an ordered list of all values.
         /// </summary>
         /// <value>
-        /// <placeholder>Optionally, an ordered list of all values.</placeholder>
+        /// Optionally, an ordered list of all values.
         /// </value>
         [JsonProperty("values")]
         public object Values { get => this.values; set => this.values = value; }
@@ -61,7 +61,7 @@ public class DatacubeDimension : IStacPropertiesContainer
         /// Gets or sets the space between the values. Use null for irregularly spaced steps.
         /// </summary>
         /// <value>
-        /// <placeholder>The space between the values. Use null for irregularly spaced steps.</placeholder>
+        /// The space between the values. Use null for irregularly spaced steps.
         /// </value>
         [JsonProperty("step")]
         public double? Step { get => this.step; set => this.step = value; }
@@ -70,7 +70,7 @@ public class DatacubeDimension : IStacPropertiesContainer
         /// Gets or sets additional fields
         /// </summary>
         /// <value>
-        /// <placeholder>Additional fields</placeholder>
+        /// Additional fields
         /// </value>
         [JsonExtensionData]
         public IDictionary<string, object> Properties { get => this.properties; set => this.properties = value; }
@@ -94,7 +94,7 @@ public class DatacubeDimensionSpatial : DatacubeDimension
         /// Gets or sets axis of the spatial dimension.
         /// </summary>
         /// <value>
-        /// <placeholder>Axis of the spatial dimension.</placeholder>
+        /// Axis of the spatial dimension.
         /// </value>
         [JsonProperty("axis")]
         public DatacubeAxis? Axis { get => this.axis; set => this.axis = value; }
@@ -103,7 +103,7 @@ public class DatacubeDimensionSpatial : DatacubeDimension
         /// Gets or sets the spatial reference system for the data, specified as <seealso href="http://www.epsg-registry.org/">numerical EPSG code</seealso>, <seealso href="http://docs.opengeospatial.org/is/18-010r7/18-010r7.html">WKT2 (ISO 19162) string</seealso> or <seealso href="https://proj.org/specifications/projjson.html">PROJJSON object</seealso>. Defaults to EPSG code 4326.
         /// </summary>
         /// <value>
-        /// <placeholder>The spatial reference system for the data, specified as <seealso href="http://www.epsg-registry.org/">numerical EPSG code</seealso>, <seealso href="http://docs.opengeospatial.org/is/18-010r7/18-010r7.html">WKT2 (ISO 19162) string</seealso> or <seealso href="https://proj.org/specifications/projjson.html">PROJJSON object</seealso>. Defaults to EPSG code 4326.</placeholder>
+        /// The spatial reference system for the data, specified as <seealso href="http://www.epsg-registry.org/">numerical EPSG code</seealso>, <seealso href="http://docs.opengeospatial.org/is/18-010r7/18-010r7.html">WKT2 (ISO 19162) string</seealso> or <seealso href="https://proj.org/specifications/projjson.html">PROJJSON object</seealso>. Defaults to EPSG code 4326.
         /// </value>
         [JsonProperty("reference_system")]
         public object ReferenceSystem { get => this.reference_system; set => this.reference_system = value; }
@@ -129,7 +129,7 @@ public class DatacubeDimensionSpatialVertical : DatacubeDimensionSpatial
         /// Gets or sets the unit of measurement for the data, preferably compliant to <seealso href="https://ncics.org/portfolio/other-resources/udunits2">UDUNITS-2</seealso> units (singular).        
         /// </summary>
         /// <value>
-        /// <placeholder>The unit of measurement for the data, preferably compliant to <seealso href="https://ncics.org/portfolio/other-resources/udunits2">UDUNITS-2</seealso> units (singular).        </placeholder>
+        /// The unit of measurement for the data, preferably compliant to <seealso href="https://ncics.org/portfolio/other-resources/udunits2">UDUNITS-2</seealso> units (singular).        
         /// </value>
         [JsonProperty("unit")]
         public string Unit { get => this.unit; set => this.unit = value; }
@@ -159,7 +159,7 @@ public class DatacubeDimensionAdditional : DatacubeDimension
         /// Gets or sets the unit of measurement for the data, preferably compliant to <seealso href="https://ncics.org/portfolio/other-resources/udunits2">UDUNITS-2</seealso> units (singular).        
         /// </summary>
         /// <value>
-        /// <placeholder>The unit of measurement for the data, preferably compliant to <seealso href="https://ncics.org/portfolio/other-resources/udunits2">UDUNITS-2</seealso> units (singular).        </placeholder>
+        /// The unit of measurement for the data, preferably compliant to <seealso href="https://ncics.org/portfolio/other-resources/udunits2">UDUNITS-2</seealso> units (singular).        
         /// </value>
         [JsonProperty("unit")]
         public string Unit { get => this.unit; set => this.unit = value; }
@@ -168,7 +168,7 @@ public class DatacubeDimensionAdditional : DatacubeDimension
         /// Gets or sets the spatial reference system for the data, specified as <seealso href="http://www.epsg-registry.org/">numerical EPSG code</seealso>, <seealso href="http://docs.opengeospatial.org/is/18-010r7/18-010r7.html">WKT2 (ISO 19162) string</seealso> or <seealso href="https://proj.org/specifications/projjson.html">PROJJSON object</seealso>. Defaults to EPSG code 4326.
         /// </summary>
         /// <value>
-        /// <placeholder>The spatial reference system for the data, specified as <seealso href="http://www.epsg-registry.org/">numerical EPSG code</seealso>, <seealso href="http://docs.opengeospatial.org/is/18-010r7/18-010r7.html">WKT2 (ISO 19162) string</seealso> or <seealso href="https://proj.org/specifications/projjson.html">PROJJSON object</seealso>. Defaults to EPSG code 4326.</placeholder>
+        /// The spatial reference system for the data, specified as <seealso href="http://www.epsg-registry.org/">numerical EPSG code</seealso>, <seealso href="http://docs.opengeospatial.org/is/18-010r7/18-010r7.html">WKT2 (ISO 19162) string</seealso> or <seealso href="https://proj.org/specifications/projjson.html">PROJJSON object</seealso>. Defaults to EPSG code 4326.
         /// </value>
         [JsonProperty("reference_system")]
         public object ReferenceSystem { get => this.reference_system; set => this.reference_system = value; }