Skip to content
This repository was archived by the owner on Jan 23, 2023. It is now read-only.

Removing obselute uex file reference comments in code #11336

Merged
merged 1 commit into from
Sep 1, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/Common/src/System/Xml/XmlCharType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@

namespace System.Xml
{
/// <include file='doc\XmlCharType.uex' path='docs/doc[@for="XmlCharType"]/*' />
/// <internalonly/>
/// <devdoc>
/// The XmlCharType class is used for quick character type recognition
Expand Down
24 changes: 0 additions & 24 deletions src/System.Collections/src/System/Collections/Generic/Queue.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,13 @@ public class Queue<T> : IEnumerable<T>,

// Creates a queue with room for capacity objects. The default initial
// capacity and grow factor are used.
/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.Queue"]/*' />
public Queue()
{
_array = Array.Empty<T>();
}

// Creates a queue with room for capacity objects. The default grow factor
// is used.
//
/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.Queue1"]/*' />
public Queue(int capacity)
{
if (capacity < 0)
Expand All @@ -54,8 +51,6 @@ public Queue(int capacity)

// Fills a Queue with the elements of an ICollection. Uses the enumerator
// to get each of the elements.
//
/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.Queue3"]/*' />
public Queue(IEnumerable<T> collection)
{
if (collection == null)
Expand All @@ -65,13 +60,11 @@ public Queue(IEnumerable<T> collection)
if (_size != _array.Length) _tail = _size;
}

/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.Count"]/*' />
public int Count
{
get { return _size; }
}

/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.IsSynchronized"]/*' />
bool ICollection.IsSynchronized
{
get { return false; }
Expand All @@ -90,7 +83,6 @@ object ICollection.SyncRoot
}

// Removes all Objects from the queue.
/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.Clear"]/*' />
public void Clear()
{
if (_size != 0)
Expand All @@ -113,8 +105,6 @@ public void Clear()

// CopyTo copies a collection into an Array, starting at a particular
// index into the array.
//
/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.CopyTo"]/*' />
public void CopyTo(T[] array, int arrayIndex)
{
if (array == null)
Expand Down Expand Up @@ -194,8 +184,6 @@ void ICollection.CopyTo(Array array, int index)
}

// Adds item to the tail of the queue.
//
/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.Enqueue"]/*' />
public void Enqueue(T item)
{
if (_size == _array.Length)
Expand All @@ -216,14 +204,11 @@ public void Enqueue(T item)

// GetEnumerator returns an IEnumerator over this Queue. This
// Enumerator will support removing.
//
/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.GetEnumerator"]/*' />
public Enumerator GetEnumerator()
{
return new Enumerator(this);
}

/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.IEnumerable.GetEnumerator"]/*' />
/// <internalonly/>
IEnumerator<T> IEnumerable<T>.GetEnumerator()
{
Expand All @@ -238,7 +223,6 @@ IEnumerator IEnumerable.GetEnumerator()
// Removes the object at the head of the queue and returns it. If the queue
// is empty, this method throws an
// InvalidOperationException.
/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.Dequeue"]/*' />
public T Dequeue()
{
if (_size == 0)
Expand All @@ -255,7 +239,6 @@ public T Dequeue()
// Returns the object at the head of the queue. The object remains in the
// queue. If the queue is empty, this method throws an
// InvalidOperationException.
/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.Peek"]/*' />
public T Peek()
{
if (_size == 0)
Expand All @@ -266,8 +249,6 @@ public T Peek()

// Returns true if the queue contains at least one object equal to item.
// Equality is determined using item.Equals().
//
/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.Contains"]/*' />
public bool Contains(T item)
{
int index = _head;
Expand All @@ -290,7 +271,6 @@ public bool Contains(T item)
// objects in the Queue, or an empty array if the queue is empty.
// The order of elements in the array is first in to last in, the same
// order produced by successive calls to Dequeue.
/// <include file='doc\Queue.uex' path='docs/doc[@for="Queue.ToArray"]/*' />
public T[] ToArray()
{
if (_size == 0)
Expand Down Expand Up @@ -358,7 +338,6 @@ public void TrimExcess()
// Implements an enumerator for a Queue. The enumerator uses the
// internal version number of the list to ensure that no modifications are
// made to the list while an enumeration is in progress.
/// <include file='doc\Queue.uex' path='docs/doc[@for="QueueEnumerator"]/*' />
[SuppressMessage("Microsoft.Performance", "CA1815:OverrideEqualsAndOperatorEqualsOnValueTypes", Justification = "not an expected scenario")]
public struct Enumerator : IEnumerator<T>,
System.Collections.IEnumerator
Expand All @@ -376,14 +355,12 @@ internal Enumerator(Queue<T> q)
_currentElement = default(T);
}

/// <include file='doc\Queue.uex' path='docs/doc[@for="QueueEnumerator.Dispose"]/*' />
public void Dispose()
{
_index = -2;
_currentElement = default(T);
}

/// <include file='doc\Queue.uex' path='docs/doc[@for="QueueEnumerator.MoveNext"]/*' />
public bool MoveNext()
{
if (_version != _q._version) throw new InvalidOperationException(SR.InvalidOperation_EnumFailedVersion);
Expand Down Expand Up @@ -424,7 +401,6 @@ public bool MoveNext()
return true;
}

/// <include file='doc\Queue.uex' path='docs/doc[@for="QueueEnumerator.Current"]/*' />
public T Current
{
get
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -756,7 +756,6 @@ private static bool IsCompatibleKey(object key)
return (key is TKey);
}

/// <include file='doc\SortedList.uex' path='docs/doc[@for="SortedListEnumerator"]/*' />
private struct Enumerator : IEnumerator<KeyValuePair<TKey, TValue>>, IDictionaryEnumerator
{
private SortedList<TKey, TValue> _sortedList;
Expand Down
20 changes: 0 additions & 20 deletions src/System.Collections/src/System/Collections/Generic/Stack.cs
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,13 @@ public class Stack<T> : IEnumerable<T>,

private const int DefaultCapacity = 4;

/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.Stack"]/*' />
public Stack()
{
_array = Array.Empty<T>();
}

// Create a stack with a specific initial capacity. The initial capacity
// must be a non-negative number.
/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.Stack1"]/*' />
public Stack(int capacity)
{
if (capacity < 0)
Expand All @@ -49,28 +47,23 @@ public Stack(int capacity)

// Fills a Stack with the contents of a particular collection. The items are
// pushed onto the stack in the same order they are read by the enumerator.
//
/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.Stack2"]/*' />
public Stack(IEnumerable<T> collection)
{
if (collection == null)
throw new ArgumentNullException(nameof(collection));
_array = EnumerableHelpers.ToArray(collection, out _size);
}

/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.Count"]/*' />
public int Count
{
get { return _size; }
}

/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.IsSynchronized"]/*' />
bool ICollection.IsSynchronized
{
get { return false; }
}

/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.SyncRoot"]/*' />
object ICollection.SyncRoot
{
get
Expand All @@ -84,15 +77,13 @@ object ICollection.SyncRoot
}

// Removes all Objects from the Stack.
/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.Clear"]/*' />
public void Clear()
{
Array.Clear(_array, 0, _size); // Don't need to doc this but we clear the elements so that the gc can reclaim the references.
_size = 0;
_version++;
}

/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.Contains"]/*' />
public bool Contains(T item)
{
int count = _size;
Expand All @@ -109,7 +100,6 @@ public bool Contains(T item)
}

// Copies the stack into an array.
/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.CopyTo"]/*' />
public void CopyTo(T[] array, int arrayIndex)
{
if (array == null)
Expand Down Expand Up @@ -173,13 +163,11 @@ void ICollection.CopyTo(Array array, int arrayIndex)
}

// Returns an IEnumerator for this Stack.
/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.GetEnumerator"]/*' />
public Enumerator GetEnumerator()
{
return new Enumerator(this);
}

/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.IEnumerable.GetEnumerator"]/*' />
/// <internalonly/>
IEnumerator<T> IEnumerable<T>.GetEnumerator()
{
Expand All @@ -203,7 +191,6 @@ public void TrimExcess()

// Returns the top object on the stack without removing it. If the stack
// is empty, Peek throws an InvalidOperationException.
/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.Peek"]/*' />
public T Peek()
{
if (_size == 0)
Expand All @@ -213,7 +200,6 @@ public T Peek()

// Pops an item from the top of the stack. If the stack is empty, Pop
// throws an InvalidOperationException.
/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.Pop"]/*' />
public T Pop()
{
if (_size == 0)
Expand All @@ -225,8 +211,6 @@ public T Pop()
}

// Pushes an item to the top of the stack.
//
/// <include file='doc\Stack.uex' path='docs/doc[@for="Stack.Push"]/*' />
public void Push(T item)
{
if (_size == _array.Length)
Expand All @@ -253,7 +237,6 @@ public T[] ToArray()
return objArray;
}

/// <include file='doc\Stack.uex' path='docs/doc[@for="StackEnumerator"]/*' />
[SuppressMessage("Microsoft.Performance", "CA1815:OverrideEqualsAndOperatorEqualsOnValueTypes", Justification = "not an expected scenario")]
public struct Enumerator : IEnumerator<T>,
System.Collections.IEnumerator
Expand All @@ -271,13 +254,11 @@ internal Enumerator(Stack<T> stack)
_currentElement = default(T);
}

/// <include file='doc\Stack.uex' path='docs/doc[@for="StackEnumerator.Dispose"]/*' />
public void Dispose()
{
_index = -1;
}

/// <include file='doc\Stack.uex' path='docs/doc[@for="StackEnumerator.MoveNext"]/*' />
public bool MoveNext()
{
bool retval;
Expand All @@ -303,7 +284,6 @@ public bool MoveNext()
return retval;
}

/// <include file='doc\Stack.uex' path='docs/doc[@for="StackEnumerator.Current"]/*' />
public T Current
{
get
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ public object UserSuppliedState
}
}

/// <include file='doc\AsyncOperation.uex' path='docs/doc[@for="AsyncOperation.SynchronizationContext"]/*' />
public SynchronizationContext SynchronizationContext
{
get
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

namespace System.ComponentModel
{
/// <include file='doc\AttributeProviderAttribute.uex' path='docs/doc[@for="AttributeProviderAttribute"]/*' />
/// <summary>
/// </summary>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1813:AvoidUnsealedAttributes")]
Expand All @@ -14,7 +13,6 @@ public class AttributeProviderAttribute : Attribute
private readonly string _typeName;
private readonly string _propertyName;

/// <include file='doc\AttributeProviderAttribute.uex' path='docs/doc[@for="AttributeProviderAttribute.AttributeProviderAttribute"]/*' />
/// <summary>
/// Creates a new AttributeProviderAttribute object.
/// </summary>
Expand All @@ -28,7 +26,6 @@ public AttributeProviderAttribute(string typeName)
_typeName = typeName;
}

/// <include file='doc\AttributeProviderAttribute.uex' path='docs/doc[@for="AttributeProviderAttribute.AttributeProviderAttribute"]/*' />
/// <summary>
/// Creates a new AttributeProviderAttribute object.
/// </summary>
Expand All @@ -47,7 +44,6 @@ public AttributeProviderAttribute(string typeName, string propertyName)
_propertyName = propertyName;
}

/// <include file='doc\AttributeProviderAttribute.uex' path='docs/doc[@for="AttributeProviderAttribute.AttributeProviderAttribute1"]/*' />
/// <summary>
/// Creates a new AttributeProviderAttribute object.
/// </summary>
Expand All @@ -61,7 +57,6 @@ public AttributeProviderAttribute(Type type)
_typeName = type.AssemblyQualifiedName;
}

/// <include file='doc\AttributeProviderAttribute.uex' path='docs/doc[@for="AttributeProviderAttribute.TypeName"]/*' />
/// <summary>
/// The TypeName property returns the assembly qualified type name
/// passed into the constructor.
Expand All @@ -74,7 +69,6 @@ public string TypeName
}
}

/// <include file='doc\AttributeProviderAttribute.uex' path='docs/doc[@for="AttributeProviderAttribute.TypeName"]/*' />
/// <summary>
/// The TypeName property returns the property name that will be used to query attributes from.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,6 @@ private void CheckAttributesValid()
}
}

/// <include file='doc\MemberDescriptor.uex' path='docs/doc[@for="MemberDescriptor.CreateAttributeCollection"]/*' />
/// <summary>
/// <para>
/// Creates a collection of attributes using the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,6 @@ public override object ConvertTo(ITypeDescriptorContext context, System.Globaliz
return base.ConvertTo(context, culture, value, destinationType);
}

/// <include file='doc\NullableConverter.uex' path='docs/doc[@for="NullableConverter.CreateInstance"]/*' />
/// <summary>
/// </summary>
public override object CreateInstance(ITypeDescriptorContext context, IDictionary propertyValues)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,6 @@ protected override void FillAttributes(IList attributeList)
base.FillAttributes(attributeList);
}

/// <include file='doc\PropertyDescriptor.uex' path='docs/doc[@for="PropertyDescriptor.GetChildProperties"]/*' />
/// <summary>
/// <para>[To be supplied.]</para>
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@ internal static int MetadataVersion
}
}

/// <include file='doc\TypeDescriptor.uex' path='docs/doc[@for="TypeDescriptor.Refreshed"]/*' />
/// <summary>
/// Occurs when Refreshed is raised for a component.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ public virtual void CopyTo(IPAddressInformation[] array, int offset)
_addresses.CopyTo(array, offset);
}

/// <include file='doc\HttpListenerPrefixCollection.uex' path='docs/doc[@for="HttpListenerPrefixCollection.Count"]/*' />
public virtual int Count
{
get
Expand Down
Loading