Skip to content

Commit 0c3e610

Browse files
committed
Add XML comments for all polar trace styles, add missing arg
1 parent 1cc5874 commit 0c3e610

3 files changed

Lines changed: 97 additions & 9 deletions

File tree

src/Plotly.NET/Traces/Trace2D.fs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ type Trace2D(traceTypeName) =
9494
static member initSplom(applyStyle: Trace2D -> Trace2D) = Trace2D("splom") |> applyStyle
9595

9696

97+
/// Create various functions for applying 2D chart styles to traces
9798
type Trace2DStyle() =
9899

99100
/// Sets the given axis anchor id(s) on a Trace object.

src/Plotly.NET/Traces/Trace3D.fs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ type Trace3D(traceTypeName) =
4444

4545

4646
//-------------------------------------------------------------------------------------------------------------------------------------------------
47-
/// Functions provide the styling of the Chart objects
47+
/// Create various functions for applying 3D chart styles to traces
4848
type Trace3DStyle() =
4949

5050
// ######################## 3d-Charts
@@ -57,7 +57,7 @@ type Trace3DStyle() =
5757
trace)
5858

5959
/// <summary>
60-
/// Applies the style parameters of the Scatter3d chart to the given trace
60+
/// Create a function that applies the styles of a 3D scatter plot to a Trace object
6161
/// </summary>
6262
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover.</param>
6363
/// <param name="Visible">Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).</param>
@@ -201,7 +201,7 @@ type Trace3DStyle() =
201201

202202

203203
/// <summary>
204-
/// Applies the style parameters of the surface chart to the given trace
204+
/// Create a function that applies the styles of a surface chart to the given trace
205205
/// </summary>
206206
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover.</param>
207207
/// <param name="Visible">Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).</param>
@@ -348,7 +348,7 @@ type Trace3DStyle() =
348348

349349

350350
/// <summary>
351-
/// Applies the style parameters of the mesh3d chart to the given trace
351+
/// Create a function that applies the styles of a mesh3d chart to the given trace
352352
/// </summary>
353353
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover.</param>
354354
/// <param name="Visible">Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).</param>
@@ -517,7 +517,7 @@ type Trace3DStyle() =
517517

518518

519519
/// <summary>
520-
/// Applies the style parameters of the cone chart to the given trace
520+
/// Create a function that applies the styles of a cone chart to the given trace
521521
/// </summary>
522522
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover.</param>
523523
/// <param name="Visible">Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).</param>
@@ -665,7 +665,7 @@ type Trace3DStyle() =
665665
cone)
666666

667667
/// <summary>
668-
/// Applies the style parameters of the streamtube chart to the given trace
668+
/// Create a function that applies the styles of a streamtube chart to the given trace
669669
/// </summary>
670670
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover.</param>
671671
/// <param name="Visible">Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).</param>
@@ -813,7 +813,7 @@ type Trace3DStyle() =
813813
streamTube)
814814

815815
/// <summary>
816-
/// Applies the style parameters of the volume chart to the given trace
816+
/// Create a function that applies the styles of a volume chart to the given trace
817817
/// </summary>
818818
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover.</param>
819819
/// <param name="Visible">Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).</param>
@@ -968,7 +968,7 @@ type Trace3DStyle() =
968968
volume
969969

970970
/// <summary>
971-
/// Applies the style parameters of the isosurface chart to the given trace
971+
/// Create a function that applies the styles of a isosurface chart to the given trace
972972
/// </summary>
973973
/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover.</param>
974974
/// <param name="Visible">Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).</param>

0 commit comments

Comments
 (0)