fix all xml doc warnings

Author: kMutagene

src/Plotly.NET.CSharp/ChartAPI/Chart.cs

@@ -10,11 +10,22 @@
 
 namespace Plotly.NET.CSharp
 {
+    /// <summary>
+    /// 
+    /// </summary>
     public static partial class Chart
     {
+        /// <summary>
+        /// Create a combined chart with the given charts merged
+        /// </summary>
+        /// <param name="gCharts">the charts to combine</param>
+        /// <returns></returns>
         public static GenericChart Combine(IEnumerable<GenericChart> gCharts) => Plotly.NET.Chart.Combine(gCharts);
 
-
+        /// <summary>
+        /// Creates a chart that is completely invisible when rendered. The Chart object however is NOT empty! Combining this chart with other charts will have unforseen consequences (it has for example invisible axes that can override other axes if used in Chart.Combine)
+        /// </summary>
+        /// <returns></returns>
         public static GenericChart Invisible()  => Plotly.NET.Chart.Invisible();
 
         /// <summary>

src/Plotly.NET.CSharp/ChartAPI/Chart2D.cs

@@ -18,11 +18,9 @@ public static partial class Chart
         ///
         /// Scatter charts are the basis of Point, Line, and Bubble Charts, and can be customized as such. We also provide abstractions for those: Chart.Line, Chart.Point, Chart.Bubble
         /// </summary>
-        /// <param name="X">Sets the x coordinates of the plotted data.</param>
-        /// <param name="MultiX">Sets the x coordinates of the plotted data. Use two inner arrays here to plot multicategorial data</param>
-        /// <param name="Y">Sets the y coordinates of the plotted data.</param>
-        /// <param name="MultiY">Sets the x coordinates of the plotted data. Use two inner arrays here to plot multicategorial data</param>
-        /// <param name="Mode">Determines the drawing mode for this scatter trace.</param>
+        /// <param name="x">Sets the x coordinates of the plotted data.</param>
+        /// <param name="y">Sets the y coordinates of the plotted data.</param>
+        /// <param name="mode">Determines the drawing mode for this scatter trace.</param>
         /// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
         /// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
         /// <param name="Opacity">Sets the opactity of the trace</param>

src/Plotly.NET/ChartAPI/Chart.fs

@@ -664,6 +664,10 @@ type Chart =
     /// <summary>
     /// Applies the given styles to the ColorBar object(s) of the chart's trace(s). Overwrites attributes with the same name that are already set.
     /// </summary>
+    /// <param name="TitleText">Sets the colorbar's title</param>
+    /// <param name="TitleFont">Sets the title font.</param>
+    /// <param name="TitleStandoff">Sets the standoff distance (in px) between the axis labels and the title text The default value is a function of the axis tick labels, the title `font.size` and the axis `linewidth`. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By setting `standoff` and turning on `automargin`, plotly.js will push the margins to fit the axis title at given standoff distance.</param>
+    /// <param name="Title">Sets the Title object (use this for more finegrained control than the other title-associated arguments)</param>
     /// <param name="BGColor">Sets the color of padded area.</param>
     /// <param name="BorderColor">Sets the axis line color.</param>
     /// <param name="BorderWidth">Sets the width (in px) or the border enclosing this color bar.</param>
@@ -700,7 +704,6 @@ type Chart =
     /// <param name="TickText">Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.</param>
     /// <param name="TickVals">Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.</param>
     /// <param name="TickWidth">Sets the tick width (in px).</param>
-    /// <param name="Title">Sets the ColorBar title.</param>
     /// <param name="X">Sets the x position of the color bar (in plot fraction).</param>
     /// <param name="XAnchor">Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.</param>
     /// <param name="XPad">Sets the amount of padding (in px) along the x direction.</param>
@@ -3690,12 +3693,20 @@ type Chart =
     /// <summary>
     /// Applies the given styles to the chart's DisplayOptions object. Overwrites attributes with the same name that are already set.
     /// </summary>
+    /// <param name="DocumentTitle">The title metadata for the document</param>
+    /// <param name="DocumentCharset">The document charset</param>
+    /// <param name="DocumentDescription">The description metadata for the document</param>
+    /// <param name="DocumentFavicon">base64 encoded favicon image</param>
     /// <param name="AdditionalHeadTags">Additional tags that will be included in the document's head </param>
-    /// <param name="Description">HTML tags that appear below the chart in HTML docs</param>
+    /// <param name="ChartDescription">HTML tags that appear below the chart in HTML docs</param>
     /// <param name="PlotlyJSReference">Sets how plotly is referenced in the head of html docs. When CDN, a script tag that references the plotly.js CDN is included in the output. When Full, a script tag containing the plotly.js source code (~3MB) is included in the output. HTML files generated with this option are fully self-contained and can be used offline</param>
     [<CompiledName("WithDisplayOptionsStyle")>]
     static member withDisplayOptionsStyle
         (
+            ?DocumentTitle: string,
+            ?DocumentCharset: string,
+            ?DocumentDescription: string,
+            ?DocumentFavicon: XmlNode,
             ?AdditionalHeadTags: XmlNode list,
             ?ChartDescription: XmlNode list,
             ?PlotlyJSReference: PlotlyJSReference
@@ -3704,6 +3715,10 @@ type Chart =
 
             let displayOpts' =
                 DisplayOptions.init (
+                    ?DocumentTitle = DocumentTitle,
+                    ?DocumentCharset = DocumentCharset,
+                    ?DocumentDescription = DocumentDescription,
+                    ?DocumentFavicon = DocumentFavicon,
                     ?AdditionalHeadTags = AdditionalHeadTags,
                     ?ChartDescription = ChartDescription,
                     ?PlotlyJSReference = PlotlyJSReference

src/Plotly.NET/ChartAPI/Chart2D.fs

@@ -4398,7 +4398,7 @@ module Chart2D =
         /// <param name="ContoursOperation">Sets the constraint operation. "=" keeps regions equal to `value` "&lt;" and "&lt;=" keep regions less than `value` "&gt;" and "&gt;=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.</param>
         /// <param name="ContoursType">If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.</param>
         /// <param name="ShowContoursLabels">Determines whether to label the contour lines with their values.</param>
-        /// <param name="ContourLabelFont">Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.</param>
+        /// <param name="ContoursLabelFont">Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.</param>
         /// <param name="ContoursStart">Sets the starting contour level value. Must be less than `contours.end`</param>
         /// <param name="ContoursEnd">Sets the end contour level value. Must be more than `contours.start`</param>
         /// <param name="Contours">Sets the styles of the contours (use this for more finegrained control than the other contour-associated arguments).</param>
@@ -4545,15 +4545,14 @@ module Chart2D =
         /// <param name="ContoursOperation">Sets the constraint operation. "=" keeps regions equal to `value` "&lt;" and "&lt;=" keep regions less than `value` "&gt;" and "&gt;=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.</param>
         /// <param name="ContoursType">If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.</param>
         /// <param name="ShowContoursLabels">Determines whether to label the contour lines with their values.</param>
-        /// <param name="ContourLabelFont">Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.</param>
+        /// <param name="ContoursLabelFont">Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.</param>
         /// <param name="ContoursStart">Sets the starting contour level value. Must be less than `contours.end`</param>
         /// <param name="ContoursEnd">Sets the end contour level value. Must be more than `contours.start`</param>
         /// <param name="Contours">Sets the styles of the contours (use this for more finegrained control than the other contour-associated arguments).</param>
         /// <param name="ColorBar">Sets the styles of the colorbar for this trace.</param>
         /// <param name="ColorScale">Sets the colorscale for this trace.</param>
         /// <param name="ShowScale">Whether or not to show the colorscale/colorbar</param>
         /// <param name="ReverseScale">Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.</param>
-        /// <param name="Contours">Sets the style of the contours</param>
         /// <param name="NContours">Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is "true" or if `contours.size` is missing.</param>
         /// <param name="UseDefaults">If set to false, ignore the global default settings set in `Defaults`</param>
         [<Extension>]
@@ -5123,7 +5122,7 @@ module Chart2D =
         /// <param name="ContoursOperation">Sets the constraint operation. "=" keeps regions equal to `value` "&lt;" and "&lt;=" keep regions less than `value` "&gt;" and "&gt;=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.</param>
         /// <param name="ContoursType">If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.</param>
         /// <param name="ShowContoursLabels">Determines whether to label the contour lines with their values.</param>
-        /// <param name="ContourLabelFont">Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.</param>
+        /// <param name="ContoursLabelFont">Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.</param>
         /// <param name="ContoursStart">Sets the starting contour level value. Must be less than `contours.end`</param>
         /// <param name="ContoursEnd">Sets the end contour level value. Must be more than `contours.start`</param>
         /// <param name="Contours">Sets the styles of the contours (use this for more finegrained control than the other contour-associated arguments).</param>
@@ -5827,7 +5826,7 @@ module Chart2D =
         /// <param name="ContoursOperation">Sets the constraint operation. "=" keeps regions equal to `value` "&lt;" and "&lt;=" keep regions less than `value` "&gt;" and "&gt;=" keep regions greater than `value` "[]", "()", "[)", and "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", "](", ")[" keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.</param>
         /// <param name="ContoursType">If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.</param>
         /// <param name="ShowContoursLabels">Determines whether to label the contour lines with their values.</param>
-        /// <param name="ContourLabelFont">Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.</param>
+        /// <param name="ContoursLabelFont">Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.</param>
         /// <param name="ContoursStart">Sets the starting contour level value. Must be less than `contours.end`</param>
         /// <param name="ContoursEnd">Sets the end contour level value. Must be more than `contours.start`</param>
         /// <param name="Contours">Sets the styles of the contours (use this for more finegrained control than the other contour-associated arguments).</param>

src/Plotly.NET/ChartAPI/GenericChart.fs

@@ -534,7 +534,7 @@ type GenericChart =
     /// If false, empty objects are used.
     /// </summary>
     /// <param name="useDefaults">wether or not to set default objects for Layout, Config and DisplayOptions</param>
-    /// <param name="traces">the input Trace collection</param>
+    /// <param name="trace">the input Trace</param>
     static member ofTraceObject (useDefaults: bool) (trace: Trace) = GenericChart.ofTraceObjects useDefaults (Seq.singleton trace)
 
     /// <summary>

src/Plotly.NET/CommonAbstractions/ColorBar.fs

@@ -200,9 +200,11 @@ type ColorBar() =
     /// <param name="X">Sets the x position of the color bar (in plot fraction). Defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*.</param>
     /// <param name="XAnchor">'Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center*, or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.</param>
     /// <param name="XPad">Sets the amount of padding (in px) along the x direction.</param>
+    /// <param name="XRef">Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.</param>
     /// <param name="Y">Sets the y position of the color bar (in plot fraction).Defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*.'</param>
     /// <param name="YAnchor">'Sets this color bar\'s vertical position anchor. This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar.Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.'</param>
     /// <param name="YPad">Sets the amount of padding (in px) along the y direction.</param>
+    /// <param name="YRef">Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.</param>
     static member style
         (
             ?BGColor: Color,

src/Plotly.NET/DisplayOptions/DisplayOptions.fs

@@ -22,8 +22,12 @@ type DisplayOptions() =
     /// <summary>
     /// Returns a new DisplayOptions object with the given styles
     /// </summary>
+    /// <param name="DocumentTitle">The title metadata for the document</param>
+    /// <param name="DocumentCharset">The document charset</param>
+    /// <param name="DocumentDescription">The description metadata for the document</param>
+    /// <param name="DocumentFavicon">base64 encoded favicon image</param>
     /// <param name="AdditionalHeadTags">Additional tags that will be included in the document's head </param>
-    /// <param name="Description">HTML tags that appear below the chart in HTML docs</param>
+    /// <param name="ChartDescription">HTML tags that appear below the chart in HTML docs</param>
     /// <param name="PlotlyJSReference">Sets how plotly is referenced in the head of html docs. When CDN, a script tag that references the plotly.js CDN is included in the output. When Full, a script tag containing the plotly.js source code (~3MB) is included in the output. HTML files generated with this option are fully self-contained and can be used offline</param>
     static member init
         (
@@ -49,8 +53,12 @@ type DisplayOptions() =
     /// <summary>
     /// Returns a function sthat applies the given styles to a DisplayOptions object
     /// </summary>
+    /// <param name="DocumentTitle">The title metadata for the document</param>
+    /// <param name="DocumentCharset">The document charset</param>
+    /// <param name="DocumentDescription">The description metadata for the document</param>
+    /// <param name="DocumentFavicon">base64 encoded favicon image</param>
     /// <param name="AdditionalHeadTags">Additional tags that will be included in the document's head </param>
-    /// <param name="Description">HTML tags that appear below the chart in HTML docs</param>
+    /// <param name="ChartDescription">HTML tags that appear below the chart in HTML docs</param>
     /// <param name="PlotlyJSReference">Sets how plotly is referenced in the head of html docs. When CDN, a script tag that references the plotly.js CDN is included in the output. When Full, a script tag containing the plotly.js source code (~3MB) is included in the output. HTML files generated with this option are fully self-contained and can be used offline</param>
     static member style
         (