[Docs] Added pending inline comments to Page class #20933

jsuarezruiz · 2024-03-01T08:46:45Z

Description of Change

Added pending inline comments to Page class.

jknaudt21

I have similar comments as in: #20912

Additionally, I would say to keep an eye out to not to directly mention type that a method returns in the summary if possible and instead opt to use more general language instead.

src/Controls/src/Core/PlatformConfiguration/WindowsSpecific/Page.cs

src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs

Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>

src/Controls/src/Core/PlatformConfiguration/WindowsSpecific/Page.cs

src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs

jknaudt21 · 2024-03-11T23:37:39Z

src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs

 		public static void SetPrefersHomeIndicatorAutoHidden(BindableObject element, bool value)
 		{
 			element.SetValue(PrefersHomeIndicatorAutoHiddenProperty, value);
 		}

-		/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific/Page.xml" path="//Member[@MemberName='PrefersHomeIndicatorAutoHidden']/Docs/*" />
+		/// <summary>
+		/// Gets a Boolean that indicates whether is allowed to hide the visual indicator for returning to the Home Screen.


Similar comment as SetPrefersHomeIndicatorAutoHidden

jknaudt21 · 2024-03-11T23:38:03Z

src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs

 		public static bool PrefersHomeIndicatorAutoHidden(this IPlatformElementConfiguration<iOS, FormsElement> config)
 		{
 			return GetPrefersHomeIndicatorAutoHidden(config.Element);
 		}

-		/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific/Page.xml" path="//Member[@MemberName='SetPrefersHomeIndicatorAutoHidden'][2]/Docs/*" />
+		/// <summary>
+		/// Sets a Boolean that indicates whether is allowed to hide the visual indicator for returning to the Home Screen.


How is this property different to SetPrefersHomeIndicatorAutoHidden?

Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>

…age-comments

Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>

…age-comments

jknaudt21 · 2024-03-25T19:28:09Z

src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific/Page.xml

This file should be entirely deleted

jknaudt21 · 2024-03-25T19:28:34Z

src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration.iOSSpecific/Page.xml

This file should be entirely deleted

src/Controls/src/Core/PlatformConfiguration/WindowsSpecific/Page.cs

src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs

src/TestUtils/src/UITest.Appium/HelperExtensions.cs

PureWeen · 2024-05-08T23:03:29Z

src/Controls/src/Core/PlatformConfiguration/WindowsSpecific/Page.cs

@@ -9,35 +9,56 @@ namespace Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific
 {
 	using FormsElement = Maui.Controls.Page;

-	/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific/Page.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific.Page']/Docs/*" />
+	/// <summary>
+	/// The page instance that Microsoft.Maui.Controls created on the Windows platform.


This isn't really correct

This is just an extension class for setting platform specifics

@jsuarezruiz

PureWeen · 2024-05-08T23:04:23Z

src/Controls/src/Core/PlatformConfiguration/WindowsSpecific/Page.cs

 		public static ToolbarPlacement GetToolbarPlacement(BindableObject element)
 		{
 			return (ToolbarPlacement)element.GetValue(ToolbarPlacementProperty);
 		}

-		/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific/Page.xml" path="//Member[@MemberName='SetToolbarPlacement'][1]/Docs/*" />
+		/// <summary>
+		/// Sets a value that controls the placement of the toolbar.


This doesn't actually do anything right now. Is that useful to note ?

@jsuarezruiz

maui/src/Controls/src/Core/Toolbar/Toolbar.Windows.cs

Line 170 in 7d21950

public static void MapToolbarPlacement(IToolbarHandler arg1, Toolbar arg2)

Not implemented

How should we manage this case?

Include some notes in the docs?

Implement it?

Deprecate/remove it.

I think there are 2 approaches here:

We can make it invisible from the IDE by addding [EditorBrowsable(EditorBrowsableState.Never)]

Adding a remark saying that this functionality hasn't been implemeted yet.

The ideal scenario would be implementing the missing functionality, but that may go beyond the scop of this PR.

@davidbritch what would be your recommended approach here?

If the API does nothing right now I'd hide it in the IDE.

@jsuarezruiz. With this change I think we should be good to merge. I'd hate for this PR to go stale

jknaudt21 · 2024-06-06T03:42:39Z

src/Controls/src/Core/PlatformConfiguration/WindowsSpecific/Page.cs

 		public static ToolbarPlacement GetToolbarPlacement(BindableObject element)
 		{
 			return (ToolbarPlacement)element.GetValue(ToolbarPlacementProperty);
 		}

-		/// <include file="../../../../docs/Microsoft.Maui.Controls.PlatformConfiguration.WindowsSpecific/Page.xml" path="//Member[@MemberName='SetToolbarPlacement'][1]/Docs/*" />
+		/// <summary>
+		/// Sets a value that controls the placement of the toolbar.


I think there are 2 approaches here:

We can make it invisible from the IDE by addding [EditorBrowsable(EditorBrowsableState.Never)]

Adding a remark saying that this functionality hasn't been implemeted yet.

The ideal scenario would be implementing the missing functionality, but that may go beyond the scop of this PR.

@davidbritch what would be your recommended approach here?

Added pending inline comments to Page class

bdb385a

jsuarezruiz added area-docs Conceptual docs, API docs, Samples t/housekeeping ♻︎ labels Mar 1, 2024

jsuarezruiz requested a review from a team as a code owner March 1, 2024 08:46

jsuarezruiz requested review from rmarinho and PureWeen March 1, 2024 08:46

jknaudt21 requested changes Mar 1, 2024

View reviewed changes

src/Controls/src/Core/PlatformConfiguration/WindowsSpecific/Page.cs Outdated Show resolved Hide resolved

src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs Outdated Show resolved Hide resolved

jsuarezruiz and others added 2 commits March 5, 2024 15:39

Update src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs

14123e8

Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>

More changes

3a1007a

jsuarezruiz requested a review from jknaudt21 March 5, 2024 14:44

jknaudt21 requested changes Mar 11, 2024

View reviewed changes

jsuarezruiz and others added 15 commits March 12, 2024 12:18

Merge branch 'main' into page-comments

7413448

Changes from PR feedback

33731dc

Update src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs

07174b5

Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>

Update src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs

957f822

Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>

Update src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs

f802bee

Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>

More changes

65f22eb

Merge branch 'page-comments' of https://github.com/dotnet/maui into p…

06db5a1

…age-comments

More changes

e226374

more changes

d9fe8b2

Update src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs

04baaf2

Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>

Update src/Controls/src/Core/PlatformConfiguration/iOSSpecific/Page.cs

965cdce

Co-authored-by: Juan Diego Herrera <juherrera@microsoft.com>

More changes

55dda46

Merge branch 'page-comments' of https://github.com/dotnet/maui into p…

a43efc9

…age-comments

Removed outdated xml comments

efe44df

More changes

bd05bbc

jknaudt21 reviewed Mar 25, 2024

View reviewed changes

jsuarezruiz added 3 commits March 26, 2024 14:39

Added pending langwords

d35795e

More fixes

52dbd0e

More changes

0d13ee2

jsuarezruiz added 3 commits April 11, 2024 12:00

Merge branch 'main' into page-comments

933c22f

Removed Windows platform specific Page xml file

7a03122

Removed iOS platform specific page xml docs

2159676

jsuarezruiz force-pushed the page-comments branch from 8136301 to 2159676 Compare April 23, 2024 11:09

jsuarezruiz added 3 commits April 24, 2024 15:34

Merge branch 'main' into page-comments

981ba5d

Merge branch 'main' into page-comments

bf119ab

More fixes

2082bd2

jknaudt21 reviewed May 7, 2024

View reviewed changes

src/TestUtils/src/UITest.Appium/HelperExtensions.cs Outdated Show resolved Hide resolved

jknaudt21 previously approved these changes May 7, 2024

View reviewed changes

Merge branch 'main' into page-comments

e0e0815

jsuarezruiz dismissed jknaudt21’s stale review via e0e0815 May 8, 2024 10:21

jknaudt21 previously approved these changes May 8, 2024

View reviewed changes

PureWeen requested changes May 8, 2024

View reviewed changes

jsuarezruiz added 2 commits June 3, 2024 13:16

Merge branch 'main' into page-comments

62b49e7

Updated docs

4c0a124

jsuarezruiz dismissed jknaudt21’s stale review via 4c0a124 June 3, 2024 13:28

jsuarezruiz requested review from PureWeen and jknaudt21 June 3, 2024 13:41

jknaudt21 approved these changes Jun 6, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs] Added pending inline comments to Page class #20933

[Docs] Added pending inline comments to Page class #20933

jsuarezruiz commented Mar 1, 2024

jknaudt21 left a comment

jknaudt21 Mar 11, 2024

jknaudt21 Mar 11, 2024

jknaudt21 Mar 25, 2024

jknaudt21 Mar 25, 2024

PureWeen May 8, 2024

jknaudt21 May 23, 2024

jsuarezruiz Jun 3, 2024

PureWeen May 8, 2024

jknaudt21 May 23, 2024

jsuarezruiz Jun 3, 2024

jsuarezruiz Jun 3, 2024

jknaudt21 Jun 6, 2024

davidbritch Jun 6, 2024

jknaudt21 Jun 14, 2024

jknaudt21 Jun 6, 2024

[Docs] Added pending inline comments to Page class #20933

Are you sure you want to change the base?

[Docs] Added pending inline comments to Page class #20933

Conversation

jsuarezruiz commented Mar 1, 2024

Description of Change

jknaudt21 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment