Skip to content

Commit 327a47c

Browse files
committed
optimize comment
1 parent 2e33807 commit 327a47c

File tree

3 files changed

+21
-35
lines changed

3 files changed

+21
-35
lines changed

SharpConstraintLayout.Maui.Native/SharpConstraintLayout.Maui.Native.csproj

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<SupportedOSPlatformVersion Condition="$(TargetFramework.Contains('-windows'))">10.0.17763.0</SupportedOSPlatformVersion>
1414
<TargetPlatformMinVersion Condition="$(TargetFramework.Contains('-windows'))">10.0.17763.0</TargetPlatformMinVersion>
1515
<RootNamespace>SharpConstraintLayout.Maui</RootNamespace>
16-
<Version>2.1.1.3</Version>
16+
<Version>2.1.3</Version>
1717
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
1818
<Authors>zhouyang</Authors>
1919
<Description>crossplatform constraintlayout at dotnet(android,ios ,windows)</Description>
@@ -23,6 +23,7 @@
2323
<PackageTags>constraintlayout;MAUI;android;ios;WinUI3</PackageTags>
2424
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
2525
<PackageReleaseNotes>some optimist for native view</PackageReleaseNotes>
26+
<GenerateDocumentationFile>True</GenerateDocumentationFile>
2627
</PropertyGroup>
2728
<!--only ios and maccatalyst have these-->
2829
<ItemGroup Condition="'$(TargetFramework)'!= 'net6.0-ios' and '$(TargetFramework)' != 'net6.0-maccatalyst'">

SharpConstraintLayout.Maui/Helper/Widget/Flow.cs

Lines changed: 18 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -230,9 +230,8 @@ protected override void init()
230230
}
231231

232232
/// <summary>
233-
/// Set the orientation of the layout
233+
/// Set the orientation of the layout. Can be: <see cref="Horizontal"/>, or <see cref="Vertical"/>
234234
/// </summary>
235-
/// <param name="orientation">either Flow.HORIZONTAL or FLow.VERTICAL</param>
236235
public virtual void SetOrientation(int orientation)
237236
{
238237
mFlow.Orientation = orientation;
@@ -290,23 +289,17 @@ public virtual void SetPaddingBottom(int value)
290289
}
291290

292291
/// <summary>
293-
/// Set the style of the last Horizontal column.
292+
/// Set the style of the last Horizontal column. Can be: <see cref="ChainSpread"/>, <see cref="ChainSpreadInside"/>, or <see cref="ChainPacked"/>.
294293
/// </summary>
295-
/// <param name="style">
296-
/// Flow.CHAIN_SPREAD, Flow.CHAIN_SPREAD_INSIDE, or Flow.CHAIN_PACKED
297-
/// </param>
298294
public virtual void SetLastHorizontalStyle(int style)
299295
{
300296
mFlow.LastHorizontalStyle = style;
301297
this.RequestReLayout();
302298
}
303299

304300
/// <summary>
305-
/// Set the style of the last vertical row.
301+
/// Set the style of the last vertical row. Can be: <see cref="ChainSpread"/>, <see cref="ChainSpreadInside"/>, or <see cref="ChainPacked"/>.
306302
/// </summary>
307-
/// <param name="style">
308-
/// Flow.CHAIN_SPREAD, Flow.CHAIN_SPREAD_INSIDE, or Flow.CHAIN_PACKED
309-
/// </param>
310303
public virtual void SetLastVerticalStyle(int style)
311304
{
312305
mFlow.LastVerticalStyle = style;
@@ -335,11 +328,9 @@ public virtual void SetLastVerticalBias(float value)
335328

336329
/// <summary>
337330
/// Set wrap mode for the layout. Can be:
338-
///
339-
/// Flow.WRAP_NONE (default) -- no wrap behavior, create a single chain Flow.WRAP_CHAIN --
340-
/// if not enough space to fit the referenced elements, will create additional chains after
341-
/// the first one Flow.WRAP_ALIGNED -- if not enough space to fit the referenced elements,
342-
/// will wrap the elements, keeping them aligned (like a table)
331+
/// <see cref="WrapNone"/> (default) -- no wrap behavior, create a single chain.
332+
/// <see cref="WrapChain"/> -- if not enough space to fit the referenced elements, will create additional chains after the first one.
333+
/// <see cref="WrapAligned"/> -- if not enough space to fit the referenced elements, will wrap the elements, keeping them aligned (like a table).
343334
/// </summary>
344335
/// <param name="mode"></param>
345336
public virtual void SetWrapMode(int value)
@@ -349,9 +340,7 @@ public virtual void SetWrapMode(int value)
349340
}
350341

351342
/// <summary>
352-
/// Set horizontal chain style. Can be:
353-
///
354-
/// Flow.CHAIN_SPREAD Flow.CHAIN_SPREAD_INSIDE Flow.CHAIN_PACKED
343+
/// Set horizontal chain style. Can be: <see cref="ChainSpread"/>, <see cref="ChainSpreadInside"/>, <see cref="ChainPacked"/>.
355344
/// </summary>
356345
/// <param name="style"></param>
357346
public virtual void SetHorizontalStyle(int value)
@@ -361,9 +350,7 @@ public virtual void SetHorizontalStyle(int value)
361350
}
362351

363352
/// <summary>
364-
/// Set vertical chain style. Can be:
365-
///
366-
/// Flow.CHAIN_SPREAD Flow.CHAIN_SPREAD_INSIDE Flow.CHAIN_PACKED
353+
/// Set vertical chain style. Can be: <see cref="ChainSpread"/>, <see cref="ChainSpreadInside"/>, <see cref="ChainPacked"/>.
367354
/// </summary>
368355
/// <param name="style"></param>
369356
public virtual void SetVerticalStyle(int value)
@@ -393,7 +380,7 @@ public virtual void SetVerticalBias(float bias)
393380
}
394381

395382
/// <summary>
396-
/// Similar to setHorizontalStyle(), but only applies to the first chain.
383+
/// Similar to <see cref="SetHorizontalStyle"/>, but only applies to the first chain.
397384
/// </summary>
398385
/// <param name="style"></param>
399386
public virtual void SetFirstHorizontalStyle(int value)
@@ -403,7 +390,7 @@ public virtual void SetFirstHorizontalStyle(int value)
403390
}
404391

405392
/// <summary>
406-
/// Similar to setVerticalStyle(), but only applies to the first chain.
393+
/// Similar to <see cref="SetVerticalStyle"/>, but only applies to the first chain.
407394
/// </summary>
408395
/// <param name="style"></param>
409396
public virtual void SetFirstVerticalStyle(int value)
@@ -413,7 +400,7 @@ public virtual void SetFirstVerticalStyle(int value)
413400
}
414401

415402
/// <summary>
416-
/// Similar to setHorizontalBias(), but only applied to the first chain.
403+
/// Similar to <see cref="SetHorizontalBias"/>, but only applied to the first chain.
417404
/// </summary>
418405
/// <param name="bias"></param>
419406
public virtual void SetFirstHorizontalBias(float value)
@@ -423,7 +410,7 @@ public virtual void SetFirstHorizontalBias(float value)
423410
}
424411

425412
/// <summary>
426-
/// Similar to setVerticalBias(), but only applied to the first chain.
413+
/// Similar to <see cref="SetVerticalBias"/>, but only applied to the first chain.
427414
/// </summary>
428415
/// <param name="bias"></param>
429416
public virtual void SetFirstVerticalBias(float value)
@@ -433,11 +420,10 @@ public virtual void SetFirstVerticalBias(float value)
433420
}
434421

435422
/// <summary>
436-
/// Set up the horizontal alignment of the elements in the layout, if the layout orientation
437-
/// is set to Flow.VERTICAL
423+
/// Set up the horizontal alignment of the elements in the layout, if the layout <see cref="SetOrientation(int)"/>
424+
/// is set to <see cref="Vertical"/>.
438425
///
439-
/// Can be either: Flow.HORIZONTAL_ALIGN_START Flow.HORIZONTAL_ALIGN_END
440-
/// Flow.HORIZONTAL_ALIGN_CENTER
426+
/// Can be either: <see cref="HorizontalAlignStart"/>, <see cref="HorizontalAlignEnd"/>, <see cref="HorizontalAlignCenter"/>.
441427
/// </summary>
442428
/// <param name="align"></param>
443429
public virtual void SetHorizontalAlign(int value)
@@ -447,11 +433,10 @@ public virtual void SetHorizontalAlign(int value)
447433
}
448434

449435
/// <summary>
450-
/// Set up the vertical alignment of the elements in the layout, if the layout orientation
451-
/// is set to Flow.HORIZONTAL
436+
/// Set up the vertical alignment of the elements in the layout, if the layout <see cref="SetOrientation(int)"/>
437+
/// is set to <see cref="Horizontal"/>.
452438
///
453-
/// Can be either: Flow.VERTICAL_ALIGN_TOP Flow.VERTICAL_ALIGN_BOTTOM
454-
/// Flow.VERTICAL_ALIGN_CENTER Flow.VERTICAL_ALIGN_BASELINE
439+
/// Can be either: <see cref="VerticalAlignTop"/>, <see cref="VerticalAlignBottom"/>, <see cref="VerticalAlignCenter"/>, <see cref="VerticalAlignBaseline"/>.
455440
/// </summary>
456441
/// <param name="align"></param>
457442
public virtual void SetVerticalAlign(int value)

SharpConstraintLayout.Maui/SharpConstraintLayout.Maui.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'windows'">10.0.17763.0</SupportedOSPlatformVersion>
1616
<TargetPlatformMinVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'windows'">10.0.17763.0</TargetPlatformMinVersion>
1717
<SupportedOSPlatformVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'tizen'">6.5</SupportedOSPlatformVersion>
18-
<Version>2.1.2</Version>
18+
<Version>2.1.3</Version>
1919
<Description>constraintlayout for maui</Description>
2020
<Copyright></Copyright>
2121
<PackageProjectUrl>https://github.com/xtuzy/SharpConstraintLayout</PackageProjectUrl>

0 commit comments

Comments
 (0)