Sandcastle XML Comments Guide
Set
A structure with a generic base class that has inherited documentation on its members
Definition
Namespace: XMLCommentsExamples.DocumentationInheritance
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
C#
public struct SetDocumentation : ISet<int>,
ICollection<int>, IEnumerable<int>, IEnumerableVB
Public Structure SetDocumentation
Implements ISet(Of Integer), ICollection(Of Integer),
IEnumerable(Of Integer), IEnumerableC++
public value class SetDocumentation : ISet<int>,
ICollection<int>, IEnumerable<int>, IEnumerableF#
[<SealedAttribute>]
type SetDocumentation =
struct
inherit ValueType
interface ISet<int>
interface ICollection<int>
interface IEnumerable<int>
interface IEnumerable
end- Implements
- ICollectionInt32, IEnumerableInt32, ISetInt32, IEnumerable
Properties
| Count | Gets the number of elements contained in the ICollectionT. |
| IsReadOnly | Gets a value indicating whether the ICollectionT is read-only. |
Methods
| Add | Adds an element to the current set and returns a value to indicate if the element was successfully added. |
| Clear | Removes all items from the ICollectionT. |
| Contains | Determines whether the ICollectionT contains a specific value. |
| CopyTo | Copies the elements of the ICollectionT to an Array, starting at a particular Array index. |
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType) |
| ExceptWith | Removes all elements in the specified collection from the current set. |
| GetEnumerator | Returns an enumerator that iterates through the collection. |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IntersectWith | Modifies the current set so that it contains only elements that are also in a specified collection. |
| IsProperSubsetOf | Determines whether the current set is a proper (strict) subset of a specified collection. |
| IsProperSupersetOf | Determines whether the current set is a proper (strict) superset of a specified collection. |
| IsSubsetOf | Determines whether a set is a subset of a specified collection. |
| IsSupersetOf | Determines whether the current set is a superset of a specified collection. |
| Overlaps | Determines whether the current set overlaps with the specified collection. |
| Remove | Removes the first occurrence of a specific object from the ICollectionT. |
| SetEquals | Determines whether the current set and the specified collection contain the same elements. |
| SymmetricExceptWith | Modifies the current set so that it contains only elements that are present either in the current set or in the specified collection, but not both. |
| ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType) |
| UnionWith | Modifies the current set so that it contains all elements that are present in the current set, in the specified collection, or in both. |
Explicit Interface Implementations
| ICollectionInt32Add | Adds an item to the ICollectionT. |
| IEnumerableGetEnumerator | Returns an enumerator that iterates through a collection. |