Skip to content

Commit b8b3d10

Browse files
committed
Added comments explaining what the equivalent __SHOWFRAME enum value is.
1 parent a6ae3f7 commit b8b3d10

File tree

1 file changed

+37
-10
lines changed
  • src/toolkit/Community.VisualStudio.Toolkit.Shared/Windows

1 file changed

+37
-10
lines changed

src/toolkit/Community.VisualStudio.Toolkit.Shared/Windows/WindowFrame.cs

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ public async Task<bool> IsOnScreenAsync()
232232
public async Task<DocumentView?> GetDocumentViewAsync()
233233
{
234234
await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
235-
235+
236236
// Force the loading of a document that may be pending initialization.
237237
// See https://docs.microsoft.com/en-us/visualstudio/extensibility/internals/delayed-document-loading
238238
_frame.GetProperty((int)__VSFPROPID.VSFPROPID_DocView, out _);
@@ -442,23 +442,50 @@ public enum FramePosition
442442
/// </summary>
443443
public enum FrameShow
444444
{
445-
/// <summary>Window (tabbed or otherwise) is hidden.</summary>
445+
/// <summary>
446+
/// <para>Window (tabbed or otherwise) is hidden.</para>
447+
/// <para>Equivalent to <see cref="__FRAMESHOW.FRAMESHOW_WinHidden"/>.</para>
448+
/// </summary>
446449
Hidden = __FRAMESHOW.FRAMESHOW_WinHidden,
447-
/// <summary>A nontabbed window is made visible.</summary>
450+
/// <summary>
451+
/// <para>A non-tabbed window is made visible.</para>
452+
/// <para>Equivalent to <see cref="__FRAMESHOW.FRAMESHOW_WinShown"/>.</para>
453+
/// </summary>
448454
Shown = __FRAMESHOW.FRAMESHOW_WinShown,
449-
/// <summary>A tabbed window is activated (made visible).</summary>
455+
/// <summary>
456+
/// <para>A tabbed window is activated (made visible).</para>
457+
/// <para>Equivalent to <see cref="__FRAMESHOW.FRAMESHOW_TabActivated"/>.</para>
458+
/// </summary>
450459
TabActivated = __FRAMESHOW.FRAMESHOW_TabActivated,
451-
/// <summary>A tabbed window is deactivated.</summary>
460+
/// <summary>
461+
/// <para>A tabbed window is deactivated.</para>
462+
/// <para>Equivalent to <see cref="__FRAMESHOW.FRAMESHOW_TabDeactivated"/>.</para>
463+
/// </summary>
452464
TabDeactivated = __FRAMESHOW.FRAMESHOW_TabDeactivated,
453-
/// <summary>Window is restored to normal state.</summary>
465+
/// <summary>
466+
/// <para>Window is restored to normal state.</para>
467+
/// <para>Equivalent to <see cref="__FRAMESHOW.FRAMESHOW_WinRestored"/>.</para>
468+
/// </summary>
454469
Restored = __FRAMESHOW.FRAMESHOW_WinRestored,
455-
/// <summary>Window is minimized.</summary>
470+
/// <summary>
471+
/// <para>Window is minimized.</para>
472+
/// <para>Equivalent to <see cref="__FRAMESHOW.FRAMESHOW_WinMinimized"/>.</para>
473+
/// </summary>
456474
Minimized = __FRAMESHOW.FRAMESHOW_WinMinimized,
457-
/// <summary>Window is maximized.</summary>
475+
/// <summary>
476+
/// <para>Window is maximized.</para>
477+
/// <para>Equivalent to <see cref="__FRAMESHOW.FRAMESHOW_WinMaximized"/>.</para>
478+
/// </summary>
458479
Maximized = __FRAMESHOW.FRAMESHOW_WinMaximized,
459-
/// <summary>Multi-instance tool window destroyed.</summary>
480+
/// <summary>
481+
/// <para>Multi-instance tool window destroyed.</para>
482+
/// <para>Equivalent to <see cref="__FRAMESHOW.FRAMESHOW_DestroyMultInst"/>.</para>
483+
/// </summary>
460484
DestroyMultipleInstance = __FRAMESHOW.FRAMESHOW_DestroyMultInst,
461-
/// <summary>Autohidden window is about to slide into view.</summary>
485+
/// <summary>
486+
/// <para>Auto-hidden window is about to slide into view.</para>
487+
/// <para>Equivalent to <see cref="__FRAMESHOW.FRAMESHOW_AutoHideSlideBegin"/>.</para>
488+
/// </summary>
462489
AutoHideSlideBegin = __FRAMESHOW.FRAMESHOW_AutoHideSlideBegin
463490
}
464491

0 commit comments

Comments
 (0)