Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove /// <include file=' an ///<internalonly/> comments #425

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 0 additions & 10 deletions src/System.Windows.Forms.Design.Editors/src/Misc/NativeMethods.cs
Expand Up @@ -4505,62 +4505,52 @@ public override string ToString()
}
public sealed class CommonHandles
{
/// <include file='doc\NativeMethods.uex' path='docs/doc[@for="NativeMethods.CommonHandles.Accelerator"]/*' />
/// <devdoc>
/// Handle type for accelerator tables.
/// </devdoc>
public static readonly int Accelerator = System.Internal.HandleCollector.RegisterType("Accelerator", 80, 50);

/// <include file='doc\NativeMethods.uex' path='docs/doc[@for="NativeMethods.CommonHandles.Cursor"]/*' />
/// <devdoc>
/// handle type for cursors.
/// </devdoc>
public static readonly int Cursor = System.Internal.HandleCollector.RegisterType("Cursor", 20, 500);

/// <include file='doc\NativeMethods.uex' path='docs/doc[@for="NativeMethods.CommonHandles.EMF"]/*' />
/// <devdoc>
/// Handle type for enhanced metafiles.
/// </devdoc>
public static readonly int EMF = System.Internal.HandleCollector.RegisterType("EnhancedMetaFile", 20, 500);

/// <include file='doc\NativeMethods.uex' path='docs/doc[@for="NativeMethods.CommonHandles.Find"]/*' />
/// <devdoc>
/// Handle type for file find handles.
/// </devdoc>
public static readonly int Find = System.Internal.HandleCollector.RegisterType("Find", 0, 1000);

/// <include file='doc\NativeMethods.uex' path='docs/doc[@for="NativeMethods.CommonHandles.GDI"]/*' />
/// <devdoc>
/// Handle type for GDI objects.
/// </devdoc>
public static readonly int GDI = System.Internal.HandleCollector.RegisterType("GDI", 90, 50);

/// <include file='doc\NativeMethods.uex' path='docs/doc[@for="NativeMethods.CommonHandles.HDC"]/*' />
/// <devdoc>
/// Handle type for HDC's that count against the Win98 limit of five DC's. HDC's
/// which are not scarce, such as HDC's for bitmaps, are counted as GDIHANDLE's.
/// </devdoc>
public static readonly int HDC = System.Internal.HandleCollector.RegisterType("HDC", 100, 2); // wait for 2 dc's before collecting

/// <include file='doc\NativeMethods.uex' path='docs/doc[@for="NativeMethods.CommonHandles.Icon"]/*' />
/// <devdoc>
/// Handle type for icons.
/// </devdoc>
public static readonly int Icon = System.Internal.HandleCollector.RegisterType("Icon", 20, 500);

/// <include file='doc\NativeMethods.uex' path='docs/doc[@for="NativeMethods.CommonHandles.Kernel"]/*' />
/// <devdoc>
/// Handle type for kernel objects.
/// </devdoc>
public static readonly int Kernel = System.Internal.HandleCollector.RegisterType("Kernel", 0, 1000);

/// <include file='doc\NativeMethods.uex' path='docs/doc[@for="NativeMethods.CommonHandles.Menu"]/*' />
/// <devdoc>
/// Handle type for files.
/// </devdoc>
public static readonly int Menu = System.Internal.HandleCollector.RegisterType("Menu", 30, 1000);

/// <include file='doc\NativeMethods.uex' path='docs/doc[@for="NativeMethods.CommonHandles.Window"]/*' />
/// <devdoc>
/// Handle type for windows.
/// </devdoc>
Expand Down
Expand Up @@ -8,7 +8,7 @@ namespace System.Resources {
using System.Runtime.Serialization;
using System;
using System.Reflection;
/// <include file='doc\IAliasResolver.uex' path='docs/doc[@for="IAliasResolver"]/*' />

/// <devdoc>
/// Summary of IAliasResolver.
/// </devdoc>
Expand Down
24 changes: 12 additions & 12 deletions src/System.Windows.Forms/src/System/Resources/ResXDataNode.cs
Expand Up @@ -26,7 +26,7 @@ namespace System.Resources {
using System.Globalization;
using System.Runtime.Versioning;

/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode"]/*' />

/// <devdoc>
///
/// </devdoc>
Expand Down Expand Up @@ -86,7 +86,7 @@ public sealed class ResXDataNode : ISerializable {
};
}

/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode.ResXDataNode"]/*' />

/// <devdoc>
///
/// </devdoc>
Expand Down Expand Up @@ -120,7 +120,7 @@ public sealed class ResXDataNode : ISerializable {
this.value = value;
}

/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode.ResXDataNode2"]/*' />

/// <devdoc>
///
/// </devdoc>
Expand Down Expand Up @@ -176,7 +176,7 @@ public sealed class ResXDataNode : ISerializable {
}


/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode.Comment"]/*' />

/// <devdoc>
///
/// </devdoc>
Expand All @@ -193,7 +193,7 @@ public sealed class ResXDataNode : ISerializable {
}
}

/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode.Name"]/*' />

/// <devdoc>
///
/// </devdoc>
Expand All @@ -220,7 +220,7 @@ public sealed class ResXDataNode : ISerializable {
}
}

/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode.FileRef"]/*' />

/// <devdoc>
///
/// </devdoc>
Expand Down Expand Up @@ -482,7 +482,7 @@ public sealed class ResXDataNode : ISerializable {
return nodeInfo;
}

/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode.GetNodePosition"]/*' />

/// <devdoc>
/// Might return the position in the resx file of the current node, if known
/// otherwise, will return Point(0,0) since point is a struct
Expand All @@ -492,7 +492,7 @@ public Point GetNodePosition()
return nodeInfo?.ReaderPosition ?? new Point();
}

/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode.GetValueTypeName"]/*' />

/// <devdoc>
/// Get the FQ type name for this datanode.
/// We return typeof(object) for ResXNullRef
Expand Down Expand Up @@ -556,15 +556,15 @@ public Point GetNodePosition()
return result;
}

/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode.GetValueTypeName1"]/*' />

/// <devdoc>
/// Get the FQ type name for this datanode
/// </devdoc>
public string GetValueTypeName(AssemblyName[] names) {
return GetValueTypeName(new AssemblyNamesTypeResolutionService(names));
}

/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode.GetValue"]/*' />

/// <devdoc>
/// Get the value contained in this datanode
/// </devdoc>
Expand Down Expand Up @@ -602,7 +602,7 @@ public Point GetNodePosition()
return result;
}

/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode.GetValue1"]/*' />

/// <devdoc>
/// Get the value contained in this datanode
/// </devdoc>
Expand Down Expand Up @@ -665,7 +665,7 @@ public Point GetNodePosition()
}


/// <include file='doc\ResXDataNode.uex' path='docs/doc[@for="ResXDataNode.GetObjectData"]/*' />

/// <devdoc>
/// Get the value contained in this datanode
/// </devdoc>
Expand Down
26 changes: 13 additions & 13 deletions src/System.Windows.Forms/src/System/Resources/ResXFileRef.cs
Expand Up @@ -20,7 +20,7 @@ namespace System.Resources {
using System.Runtime.Serialization;
using System.Runtime.Versioning;

/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef"]/*' />

/// <devdoc>
/// ResX File Reference class. This allows the developer to represent
/// a link to an external resource. When the resource manager asks
Expand All @@ -33,7 +33,7 @@ public class ResXFileRef {
[OptionalField(VersionAdded = 2)]
private Encoding textFileEncoding;

/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.ResXFileRef"]/*' />

/// <devdoc>
/// Creates a new ResXFileRef that points to the specified file.
/// The type refered to by typeName must support a constructor
Expand All @@ -55,7 +55,7 @@ public class ResXFileRef {
private void OnDeserialized(StreamingContext ctx) {
}

/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.ResXFileRef"]/*' />

/// <devdoc>
/// Creates a new ResXFileRef that points to the specified file.
/// The type refered to by typeName must support a constructor
Expand All @@ -70,29 +70,29 @@ public class ResXFileRef {
}


/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.FileName"]/*' />

public string FileName {
get {
return fileName;
}
}

/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.TextFileEncoding"]/*' />

public string TypeName {
get {
return typeName;
}
}

/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.TextFileEncoding"]/*' />

public Encoding TextFileEncoding {
get {
return textFileEncoding;
}
}


/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.PathDifference"]/*' />

/// <devdoc>
/// path1+result = path2
/// A string which is the relative path difference between path1 and
Expand Down Expand Up @@ -140,7 +140,7 @@ public class ResXFileRef {
fileName = PathDifference(basePath, fileName, false);
}

/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.ToString"]/*' />

public override string ToString() {
string result = string.Empty;

Expand All @@ -159,9 +159,9 @@ public class ResXFileRef {



/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.Converter"]/*' />

public class Converter : TypeConverter {
/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.Converter.CanConvertFrom"]/*' />

public override bool CanConvertFrom(ITypeDescriptorContext context,
Type sourceType) {
if (sourceType == typeof(string)) {
Expand All @@ -170,14 +170,14 @@ public class Converter : TypeConverter {
return false;
}

/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.Converter.CanConvertTo"]/*' />

public override bool CanConvertTo(ITypeDescriptorContext context,
Type destinationType)
{
return destinationType == typeof(string);
}

/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.Converter.ConvertTo"]/*' />

public override object ConvertTo(ITypeDescriptorContext context,
CultureInfo culture,
object value,
Expand Down Expand Up @@ -226,7 +226,7 @@ public class Converter : TypeConverter {
return result;
}

/// <include file='doc\ResXFileRef.uex' path='docs/doc[@for="ResXFileRef.Converter.ConvertFrom"]/*' />

[ResourceExposure(ResourceScope.Machine)]
[ResourceConsumption(ResourceScope.Machine)]
public override object ConvertFrom(ITypeDescriptorContext context,
Expand Down
Expand Up @@ -16,7 +16,7 @@ namespace System.Resources {
using System.Resources;
using System.Globalization;

/// <include file='doc\ResXNullRef.uex' path='docs/doc[@for="ResXNullRef"]/*' />

/// <devdoc>
/// ResX Null Reference class. This class allows ResX to store null values.
/// It is a placeholder that is written into the file. On read, it is replaced
Expand Down