Skip to content

Commit c07bc94

Browse files
committed
Fix some xml docs
1 parent 9bb1974 commit c07bc94

File tree

3 files changed

+18
-4
lines changed

3 files changed

+18
-4
lines changed

src/Plotly.NET/ChartAPI/Chart.fs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1783,7 +1783,7 @@ type Chart =
17831783
/// <summary>
17841784
/// Sets the imaginary Axis on the polar object with the given id on the input chart's layout.
17851785
/// </summary>
1786-
/// <param name="angularAxis">The ImaginaryAxis to set on the target polar object on the chart's layout</param>
1786+
/// <param name="imaginaryAxis">The ImaginaryAxis to set on the target polar object on the chart's layout</param>
17871787
/// <param name="id">The target polar id with which the ImaginaryAxis should be set.(default is 1)</param>
17881788
/// <param name="Combine">Wether or not to combine the objects if there is already an axis set (default is false)</param>
17891789
[<CompiledName("SetImaginaryAxis")>]

src/Plotly.NET/ChartAPI/ChartSmith.fs

+2
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,7 @@ module ChartSmith =
351351
/// </summary>
352352
/// <param name="real">Sets the real component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.</param>
353353
/// <param name="imag">Sets the imaginary component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.</param>
354+
/// <param name="ShowMarkers">Wether or not to show markers for each datum.</param>
354355
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
355356
/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
356357
/// <param name="Opacity">Sets the opactity of the trace</param>
@@ -446,6 +447,7 @@ module ChartSmith =
446447
/// In general, LineSmith charts plot complex numbers on a transformed two-dimensional Cartesian complex plane as datums connected by a line. Complex numbers with positive real parts map inside the circle. Those with negative real parts map outside the circle.
447448
/// </summary>
448449
/// <param name="realImag">Sets the real and imaginary components of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.</param>
450+
/// <param name="ShowMarkers">Wether or not to show markers for each datum.</param>
449451
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>
450452
/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>
451453
/// <param name="Opacity">Sets the opactity of the trace</param>

src/Plotly.NET/Config/ObjectAbstractions/Edits.fs

+15-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ type Edits() =
1111
inherit DynamicObj()
1212

1313
/// <summary>
14-
///
14+
/// Returns a new Edits Object with the given styling.
1515
/// </summary>
16-
/// <param name="AnnotationPosition">Determines if the main anchor of the annotation is editable. The main anchor corresponds to the text (if no arrow) or the arrow (which drags the whole thing leaving the arrow length & direction unchanged).</param>
16+
/// <param name="AnnotationPosition">Determines if the main anchor of the annotation is editable. The main anchor corresponds to the text (if no arrow) or the arrow (which drags the whole thing leaving the arrow length and direction unchanged).</param>
1717
/// <param name="AnnotationTail">Has only an effect for annotations with arrows. Enables changing the length and direction of the arrow.</param>
1818
/// <param name="AnnotationText">Enables editing annotation text.</param>
1919
/// <param name="AxisTitleText">Enables editing axis title text.</param>
@@ -51,7 +51,19 @@ type Edits() =
5151

5252
)
5353

54-
// Applies the styles to Config()
54+
/// <summary>
55+
/// Returns a function that apllioes the given styles to an Edits Object.
56+
/// </summary>
57+
/// <param name="AnnotationPosition">Determines if the main anchor of the annotation is editable. The main anchor corresponds to the text (if no arrow) or the arrow (which drags the whole thing leaving the arrow length and direction unchanged).</param>
58+
/// <param name="AnnotationTail">Has only an effect for annotations with arrows. Enables changing the length and direction of the arrow.</param>
59+
/// <param name="AnnotationText">Enables editing annotation text.</param>
60+
/// <param name="AxisTitleText">Enables editing axis title text.</param>
61+
/// <param name="ColorbarPosition">Enables moving colorbars.</param>
62+
/// <param name="ColorbarTitleText">Enables moving colorbars.</param>
63+
/// <param name="LegendPosition">Enables moving colorbars.</param>
64+
/// <param name="LegendText">Enables editing the trace name fields from the legend</param>
65+
/// <param name="ShapePosition">Enables editing the trace name fields from the legend</param>
66+
/// <param name="TitleText">Enables editing the global layout title.</param>
5567
static member style
5668
(
5769
[<Optional; DefaultParameterValue(null)>] ?AnnotationPosition: bool,

0 commit comments

Comments
 (0)