Merge pull request #5680 from drewnoakes/doc-cleanup

Remove empty documentation elements

Author: drewnoakes

src/Microsoft.VisualStudio.AppDesigner/ApplicationDesigner/ApplicationDesignerEditorFactory.vb

@@ -150,7 +150,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' Disconnect from the owning site
         ''' </summary>
-        ''' <remarks></remarks>
         Public Function Close() As Integer Implements IVsEditorFactory.Close
             _siteProvider = Nothing
             _site = Nothing
@@ -159,7 +158,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' Wrapper of COM interface which delegates to Internal
         ''' </summary>
-        ''' <remarks></remarks>
         Private Function IVsEditorFactory_CreateEditorInstance(
                 vscreateeditorflags As UInteger,
                 FileName As String,
@@ -209,7 +207,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' </summary>
         ''' <param name="rguidLogicalView"></param>
         ''' <param name="pbstrPhysicalView"></param>
-        ''' <remarks></remarks>
         Public Function MapLogicalView(ByRef rguidLogicalView As Guid, ByRef pbstrPhysicalView As String) As Integer Implements IVsEditorFactory.MapLogicalView
             pbstrPhysicalView = Nothing
 
@@ -229,7 +226,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' Called by owning site after creation
         ''' </summary>
         ''' <param name="Site"></param>
-        ''' <remarks></remarks>
         Public Function SetSite(Site As OLE.Interop.IServiceProvider) As Integer Implements IVsEditorFactory.SetSite
             'This same Site already set?  Or Site not yet initialized (= Nothing)?  If so, NOP.
             If _site Is Site Then

src/Microsoft.VisualStudio.AppDesigner/ApplicationDesigner/ApplicationDesignerLoader.vb

@@ -23,7 +23,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
     ''' <summary>
     ''' Designer loader for the ApplicationDesigner
     ''' </summary>
-    ''' <remarks></remarks>
     Public NotInheritable Class ApplicationDesignerLoader
         Inherits BasicDesignerLoader
         Implements IDisposable
@@ -49,7 +48,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' NOTE: Remember to call RemoveService on any service object we don't own, when the Loader is disposed
         '''  Otherwise, the service container will dispose those objects. 
         ''' </summary>
-        ''' <remarks></remarks>
         Protected Overrides Sub Initialize()
             MyBase.Initialize()
 
@@ -89,7 +87,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <param name="Hierarchy"></param>
         ''' <param name="ItemId"></param>
         ''' <param name="punkDocData"></param>
-        ''' <remarks></remarks>
         Public Sub InitializeEx(ServiceProvider As Shell.ServiceProvider, Hierarchy As IVsHierarchy, ItemId As UInteger, punkDocData As Object)
 
             If m_DocDataService IsNot Nothing Then
@@ -117,7 +114,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' it needs an updated version of the file contents).
         ''' </summary>
         ''' <param name="serializationManager"></param>
-        ''' <remarks></remarks>
         Protected Overrides Sub PerformFlush(serializationManager As IDesignerSerializationManager)
             Debug.Assert(Modified, "PerformFlush shouldn't get called if the designer's not dirty")
 
@@ -207,7 +203,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' Dispose of managed and unmanaged resources
         ''' </summary>
         ''' <param name="disposing">True if calling from Dispose()</param>
-        ''' <remarks></remarks>
         Protected Overloads Sub Dispose(disposing As Boolean)
             If disposing Then
                 LoaderHost.RemoveService(GetType(DesignerDocDataService))

src/Microsoft.VisualStudio.AppDesigner/ApplicationDesigner/ApplicationDesignerPanel.vb

@@ -85,7 +85,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <param name="Hierarchy"></param>
         ''' <param name="ItemId"></param>
         ''' <param name="PropertyPageInfo"></param>
-        ''' <remarks></remarks>
         Public Sub New(View As ApplicationDesignerView, Hierarchy As IVsHierarchy, ItemId As UInteger, PropertyPageInfo As PropertyPageInfo)
             Me.New(View, Hierarchy, ItemId)
 
@@ -105,7 +104,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <param name="View">The owning project designer view</param>
         ''' <param name="Hierarchy"></param>
         ''' <param name="ItemId"></param>
-        ''' <remarks></remarks>
         Public Sub New(View As ApplicationDesignerView, Hierarchy As IVsHierarchy, ItemId As UInteger)
             Debug.Assert(View IsNot Nothing)
             Debug.Assert(Hierarchy IsNot Nothing)
@@ -130,8 +128,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' Returns the PropertyPageInfo for this designer panel, if it corresponds to a property page.
         ''' Otherwise returns Nothing.
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public ReadOnly Property PropertyPageInfo() As PropertyPageInfo
             Get
                 Return _propertyPageInfo
@@ -169,8 +165,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' Provides a custom view control that can be displayed instead of hosting a designer.  We can display either
         '''   a custom view provider or a hosted designer, but not both at once.
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property CustomViewProvider() As CustomViewProvider
             Get
                 Return _customViewProvider
@@ -572,7 +566,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' Notify the shell of the current selection so that the Project menus etc. are correct
         ''' </summary>
-        ''' <remarks></remarks>
         Private Sub UpdateSelection()
             Common.Switches.TracePDPerfBegin("ApplicationDesignerPanel.UpdateSelection")
             'When we call IVsWindowFrame.Hide() on a tab (when changing to another tab), the shell nulls out the 
@@ -653,9 +646,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' Get/set the window frame owned by this panel
         ''' </summary>
-        ''' <value></value>
-        ''' <returns></returns>
-        ''' <remarks></remarks>
         Public Property VsWindowFrame() As IVsWindowFrame
             Get
                 Return _vsWindowFrame
@@ -679,8 +669,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' The Guid used by the editor for this panel.  For property pages, this is always
         '''   PropPageDesignerView's guid.
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property EditorGuid() As Guid
             Get
                 Return _editorGuid
@@ -699,8 +687,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' The Guid used by the object actually represented in this panel.  For property pages,
         '''   this is the guid of the property page.  For all others, this is the same as EditorGuid.
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public ReadOnly Property ActualGuid() As Guid
             Get
                 If _propertyPageInfo IsNot Nothing Then
@@ -714,8 +700,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' Physical view guid for the editor
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property PhysicalView() As String
             Get
                 Return _physicalView
@@ -728,8 +712,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' The editor's caption
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property EditorCaption() As String
             Get
                 Return _editorCaption
@@ -742,8 +724,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' The filename moniker of the file which is being edited by the editor
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property MkDocument() As String
             Get
                 If _mkDocument <> "" Then
@@ -763,8 +743,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' The filename moniker of the file which is being edited by the editor
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property CustomMkDocumentProvider() As CustomDocumentMonikerProvider
             Get
                 Return _customMkDocumentProvider
@@ -778,8 +756,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' The DocData for the editor
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property DocData() As Object
             Get
                 Return _docData
@@ -792,8 +768,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' The DocView for the editor
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property DocView() As Control
             Get
                 Return _docView
@@ -806,8 +780,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' Flags to be passed to VsUIShellOpenDocument
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property EditFlags() As UInteger
             Get
                 Return _editFlags
@@ -820,8 +792,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' The title that should be used for this panel's tab
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property TabTitle() As String
             Get
                 Return _tabTitle
@@ -843,8 +813,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' The name for the tab that is not localized and is seen by QA automation tools
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property TabAutomationName() As String
             Get
                 Return _tabAutomationName
@@ -860,7 +828,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         '''   same size as the hosting panel (as if it were dock filled).  This sets the native
         '''   window's size to the size of the hosting panel.
         ''' </summary>
-        ''' <remarks></remarks>
         Protected Sub UpdateWindowFrameBounds()
             'Note: don't need to worry about updating size of CustomView because it's set to dock fill
             If VsWindowFrame IsNot Nothing Then
@@ -900,7 +867,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' Commits any pending changes on the designer
         ''' </summary>
         ''' <returns>return False if it failed</returns>
-        ''' <remarks></remarks>
         Public Function CommitPendingEdit() As Boolean
             If VsWindowFrame IsNot Nothing Then
                 Dim docViewObject As Object = Nothing
@@ -996,8 +962,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' Returns true if this page should show the '*' dirty indicator in its tab
         ''' </summary>
-        ''' <returns></returns>
-        ''' <remarks></remarks>
         Public Function IsDirty() As Boolean
             If IsPropertyPage Then
                 'CONSIDER: If we decide to support IVsDocDataContainer, then DocDatas contained by the property
@@ -1030,7 +994,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' </summary>
         ''' <param name="sender"></param>
         ''' <param name="e"></param>
-        ''' <remarks></remarks>
         Private Sub PageHostingPanel_HandleCreated(sender As Object, e As EventArgs) Handles _pageHostingPanel.HandleCreated
             If _vsWindowFrame IsNot Nothing Then
                 Debug.Fail("PageHostingPanel handle was recreated after the nested window frame's ParentHwnd property was set to its HWND.  " _
@@ -1045,7 +1008,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' Disposes of contained objects
         ''' </summary>
         ''' <param name="disposing"></param>
-        ''' <remarks></remarks>
         Protected Overloads Overrides Sub Dispose(disposing As Boolean)
             If disposing Then
                 ' Dispose managed resources.
@@ -1145,8 +1107,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' to avoid that we just close this property page and leave the app designer open...
         ''' </summary>
         ''' <param name="pgrfSaveOptions"></param>
-        ''' <returns></returns>
-        ''' <remarks></remarks>
         Private Function OnClose(ByRef pgrfSaveOptions As UInteger) As Integer Implements IVsWindowFrameNotify2.OnClose
             If _inOnClose Then
                 Return NativeMethods.S_OK

src/Microsoft.VisualStudio.AppDesigner/ApplicationDesigner/ApplicationDesignerRootComponent.vb

@@ -1,4 +1,4 @@
-' Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the Apache License, Version 2.0.  See License.txt in the project root for license information.
+' Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the Apache License, Version 2.0.  See License.txt in the project root for license information.
 
 Imports System.ComponentModel
 Imports System.ComponentModel.Design
@@ -10,7 +10,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
     ''' <summary>
     ''' This class represents the root component of the Application Designer.
     ''' </summary>
-    ''' <remarks></remarks>
     <Designer(GetType(ApplicationDesignerRootDesigner), GetType(IRootDesigner))>
     Public NotInheritable Class ApplicationDesignerRootComponent
         Inherits Component
@@ -26,7 +25,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         '''   resx file to be edited by the user.
         ''' </summary>
         ''' <value>The associated ResourceEditorRootDesigner.</value>
-        ''' <remarks></remarks>
         Public ReadOnly Property RootDesigner() As ApplicationDesignerRootDesigner
             Get
                 If _rootDesigner Is Nothing Then
@@ -44,8 +42,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' The IVsHierarchy associated with the AppDesigner node
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property Hierarchy() As IVsHierarchy
             Get
                 Return _hierarchy
@@ -58,8 +54,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' The ItemId associated with the AppDesigner node
         ''' </summary>
-        ''' <value></value>
-        ''' <remarks></remarks>
         Public Property ItemId() As UInteger
             Get
                 Return _itemId

src/Microsoft.VisualStudio.AppDesigner/ApplicationDesigner/ApplicationDesignerRootDesigner.vb

@@ -13,7 +13,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
     ''' This is the designer for the top-level resource editor component (ApplicationDesigner).  I.e., this
     ''' is the top-level designer.  
     ''' </summary>
-    ''' <remarks></remarks>
     Public NotInheritable Class ApplicationDesignerRootDesigner
         Inherits AppDesDesignerFramework.BaseRootDesigner
         Implements IRootDesigner
@@ -25,7 +24,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' Returns the ApplicationDesignerRootComponent component that is being edited by this designer.
         ''' </summary>
         ''' <value>The ApplicationDesignerRootComponent object.</value>
-        ''' <remarks></remarks>
         Public Shadows ReadOnly Property Component() As ApplicationDesignerRootComponent
             Get
                 Dim RootComponent As ApplicationDesignerRootComponent = CType(MyBase.Component, ApplicationDesignerRootComponent)
@@ -60,7 +58,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' Disposes of the root designer
         ''' </summary>
         ''' <param name="Disposing"></param>
-        ''' <remarks></remarks>
         Protected Overloads Overrides Sub Dispose(Disposing As Boolean)
             If Disposing Then
                 If _view IsNot Nothing Then
@@ -77,7 +74,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' We currently support only Windows Forms technology (i.e., our designer view, ResourceEditorView,
         ''' inherits from System.Windows.Forms.Control)
         ''' </summary>
-        ''' <value></value>
         ''' <remarks>
         ''' The view technology we support, which is currently only Windows Forms
         ''' </remarks>
@@ -92,7 +88,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         '''   our resource editor's designer surface.  In this case, we return an instance of ResourceEditorView.
         ''' </summary>
         ''' <param name="Technology"></param>
-        ''' <returns></returns>
         ''' <remarks>
         '''   The newly-instantiated ResourceEditorView object.
         ''' </remarks>
@@ -114,8 +109,6 @@ Namespace Microsoft.VisualStudio.Editors.ApplicationDesigner
         ''' <summary>
         ''' Wrapper function to expose our UI object
         ''' </summary>
-        ''' <returns></returns>
-        ''' <remarks></remarks>
         Public Function GetView() As ApplicationDesignerView
             Return CType(RootDesigner_GetView(ViewTechnology.Default), ApplicationDesignerView)
         End Function