Skip to content

Commit be68409

Browse files
committed
chore: Documenting members
1 parent 42a54fa commit be68409

10 files changed

+100
-59
lines changed

src/Uno.UI/UI/Xaml/Controls/CommandBar/CommandBarDefaultLabelPosition.cs

+20-7
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,25 @@
22
using System.Collections.Generic;
33
using System.Text;
44

5-
namespace Microsoft.UI.Xaml.Controls
5+
namespace Microsoft.UI.Xaml.Controls;
6+
7+
/// <summary>
8+
/// Defines constants that specify the placement and visibility of AppBarButton labels in a CommandBar.
9+
/// </summary>
10+
public enum CommandBarDefaultLabelPosition
611
{
7-
public enum CommandBarDefaultLabelPosition
8-
{
9-
Bottom,
10-
Right,
11-
Collapsed,
12-
}
12+
/// <summary>
13+
/// App bar button labels are shown below the icon. Labels are visible only when the command bar is open.
14+
/// </summary>
15+
Bottom = 0,
16+
17+
/// <summary>
18+
/// App bar button labels are shown to the right of the icon. Labels are visible even when the command bar is closed.
19+
/// </summary>
20+
Right = 1,
21+
22+
/// <summary>
23+
/// App bar button labels are always hidden whether the command bar is open or closed.
24+
/// </summary>
25+
Collapsed = 2,
1326
}

src/Uno.UI/UI/Xaml/Controls/CommandBar/CommandBarDynamicOverflowAction.cs

+15-6
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,20 @@
22
using System.Collections.Generic;
33
using System.Text;
44

5-
namespace Microsoft.UI.Xaml.Controls
5+
namespace Microsoft.UI.Xaml.Controls;
6+
7+
/// <summary>
8+
/// Defines constants that specify whether items were added to or removed from the CommandBar overflow menu.
9+
/// </summary>
10+
public enum CommandBarDynamicOverflowAction
611
{
7-
public enum CommandBarDynamicOverflowAction
8-
{
9-
AddingToOverflow,
10-
RemovingFromOverflow,
11-
}
12+
/// <summary>
13+
/// Items are added to the overflow menu.
14+
/// </summary>
15+
AddingToOverflow = 0,
16+
17+
/// <summary>
18+
/// Items are removed from the overflow menu.
19+
/// </summary>
20+
RemovingFromOverflow = 1,
1221
}

src/Uno.UI/UI/Xaml/Controls/CommandBar/CommandBarLabelPosition.cs

+15-6
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,20 @@
22
using System.Collections.Generic;
33
using System.Text;
44

5-
namespace Microsoft.UI.Xaml.Controls
5+
namespace Microsoft.UI.Xaml.Controls;
6+
7+
/// <summary>
8+
/// Defines constants that specify the placement and visibility of an app bar button's label.
9+
/// </summary>
10+
public enum CommandBarLabelPosition
611
{
7-
public enum CommandBarLabelPosition
8-
{
9-
Default,
10-
Collapsed,
11-
}
12+
/// <summary>
13+
/// The placement and visibility of the app bar button's label is determined by the value of the CommandBar.DefaultLabelPosition property.
14+
/// </summary>
15+
Default,
16+
17+
/// <summary>
18+
/// The app bar button's label is always hidden whether the command bar is open or closed.
19+
/// </summary>
20+
Collapsed,
1221
}

src/Uno.UI/UI/Xaml/Controls/CommandBar/CommandBarOverflowButtonVisibility.cs

+20-7
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,25 @@
22
using System.Collections.Generic;
33
using System.Text;
44

5-
namespace Microsoft.UI.Xaml.Controls
5+
namespace Microsoft.UI.Xaml.Controls;
6+
7+
/// <summary>
8+
/// Defines constants that specify when a command bar's overflow button is shown.
9+
/// </summary>
10+
public enum CommandBarOverflowButtonVisibility
611
{
7-
public enum CommandBarOverflowButtonVisibility
8-
{
9-
Auto,
10-
Visible,
11-
Collapsed,
12-
}
12+
/// <summary>
13+
/// The overflow button automatically hides when there are no secondary commands and the closed state of the CommandBar is the same as the open state.
14+
/// </summary>
15+
Auto = 0,
16+
17+
/// <summary>
18+
/// The overflow button is always shown.
19+
/// </summary>
20+
Visible = 1,
21+
22+
/// <summary>
23+
/// The overflow button is never shown.
24+
/// </summary>
25+
Collapsed = 2,
1326
}

src/Uno.UI/UI/Xaml/Controls/CommandBar/DynamicOverflowItemsChangingEventArgs.cs

+10-9
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22
using System.Collections.Generic;
33
using System.Text;
44

5-
namespace Microsoft.UI.Xaml.Controls
5+
namespace Microsoft.UI.Xaml.Controls;
6+
7+
/// <summary>
8+
/// Provides data for the CommandBar.DynamicOverflowItemsChanging event.
9+
/// </summary>
10+
public partial class DynamicOverflowItemsChangingEventArgs
611
{
7-
public partial class DynamicOverflowItemsChangingEventArgs
8-
{
9-
public global::Microsoft.UI.Xaml.Controls.CommandBarDynamicOverflowAction Action
10-
{
11-
get;
12-
internal set;
13-
}
14-
}
12+
/// <summary>
13+
/// Gets a value that indicates whether items were added to or removed from the CommandBar overflow menu.
14+
/// </summary>
15+
public CommandBarDynamicOverflowAction Action { get; internal set; }
1516
}

src/Uno.UI/UI/Xaml/Controls/CommandBar/ICommandBarElement.cs

+4-5
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
using System.Collections.Generic;
33
using System.Text;
44

5-
namespace Microsoft.UI.Xaml.Controls
5+
namespace Microsoft.UI.Xaml.Controls;
6+
7+
public partial interface ICommandBarElement
68
{
7-
public partial interface ICommandBarElement
8-
{
9-
bool IsCompact { get; set; }
10-
}
9+
bool IsCompact { get; set; }
1110
}

src/Uno.UI/UI/Xaml/Controls/CommandBar/ICommandBarElement2.cs

+5-6
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
using System.Collections.Generic;
33
using System.Text;
44

5-
namespace Microsoft.UI.Xaml.Controls
5+
namespace Microsoft.UI.Xaml.Controls;
6+
7+
public partial interface ICommandBarElement2
68
{
7-
public partial interface ICommandBarElement2
8-
{
9-
int DynamicOverflowOrder { get; set; }
10-
bool IsInOverflow { get; }
11-
}
9+
int DynamicOverflowOrder { get; set; }
10+
bool IsInOverflow { get; }
1211
}

src/Uno.UI/UI/Xaml/Controls/CommandBar/ICommandBarElement3.cs

+4-5
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
using System.Collections.Generic;
33
using System.Text;
44

5-
namespace Microsoft.UI.Xaml.Controls
5+
namespace Microsoft.UI.Xaml.Controls;
6+
7+
internal interface ICommandBarElement3
68
{
7-
internal interface ICommandBarElement3
8-
{
9-
bool IsInOverflow { get; set; }
10-
}
9+
bool IsInOverflow { get; set; }
1110
}

src/Uno.UI/UI/Xaml/Controls/CommandBar/ICommandBarLabeledElement.cs

+6-7
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,13 @@
22
using System.Collections.Generic;
33
using System.Text;
44

5-
namespace Microsoft.UI.Xaml.Controls
5+
namespace Microsoft.UI.Xaml.Controls;
6+
7+
internal interface ICommandBarLabeledElement
68
{
7-
internal interface ICommandBarLabeledElement
8-
{
9-
void SetDefaultLabelPosition(CommandBarDefaultLabelPosition defaultLabelPosition);
9+
void SetDefaultLabelPosition(CommandBarDefaultLabelPosition defaultLabelPosition);
1010

11-
bool GetHasBottomLabel();
11+
bool GetHasBottomLabel();
1212

13-
bool GetHasRightLabel();
14-
}
13+
bool GetHasRightLabel();
1514
}

src/Uno.UI/UI/Xaml/Controls/CommandBar/ICommandBarOverflowElement.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using System.Collections.Generic;
33
using System.Text;
44

5-
namespace Microsoft.UI.Xaml.Controls
5+
namespace Microsoft.UI.Xaml.Controlsů
66
{
77
internal interface ICommandBarOverflowElement
88
{

0 commit comments

Comments
 (0)