SetDocumentation Structure

Sandcastle XML Comments

Sandcastle XML Comments GuideSetDocumentation Structure
A structure with a generic base class that has inherited documentation on its members

Namespace: XMLCommentsExamples.DocumentationInheritance
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
Syntax
public struct SetDocumentation : ISet<int>, 
	ICollection<int>, IEnumerable<int>, IEnumerable
Public Structure SetDocumentation
	Implements ISet(Of Integer), ICollection(Of Integer), 
	IEnumerable(Of Integer), IEnumerable
public value class SetDocumentation : ISet<int>, 
	ICollection<int>, IEnumerable<int>, IEnumerable
[<SealedAttribute>]
type SetDocumentation =  
    struct
        interface ISet<int>
        interface ICollection<int>
        interface IEnumerable<int>
        interface IEnumerable
    end

The SetDocumentation type exposes the following members.

Properties
  NameDescription
Public propertyCount
Gets the number of elements contained in the ICollectionT.
Public propertyIsReadOnly
Gets a value indicating whether the ICollectionT is read-only.
Top
Methods
  NameDescription
Public methodAdd
Adds an element to the current set and returns a value to indicate if the element was successfully added.
Public methodClear
Removes all items from the ICollectionT.
Public methodContains
Determines whether the ICollectionT contains a specific value.
Public methodCopyTo
Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
Public methodEquals
Indicates whether this instance and a specified object are equal.
(Inherited from ValueType.)
Public methodExceptWith
Removes all elements in the specified collection from the current set.
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
Public methodGetHashCode
Returns the hash code for this instance.
(Inherited from ValueType.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIntersectWith
Modifies the current set so that it contains only elements that are also in a specified collection.
Public methodIsProperSubsetOf
Determines whether the current set is a proper (strict) subset of a specified collection.
Public methodIsProperSupersetOf
Determines whether the current set is a proper (strict) superset of a specified collection.
Public methodIsSubsetOf
Determines whether a set is a subset of a specified collection.
Public methodIsSupersetOf
Determines whether the current set is a superset of a specified collection.
Public methodOverlaps
Determines whether the current set overlaps with the specified collection.
Public methodRemove
Removes the first occurrence of a specific object from the ICollectionT.
Public methodSetEquals
Determines whether the current set and the specified collection contain the same elements.
Public methodSymmetricExceptWith
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.
Public methodToString
Returns the fully qualified type name of this instance.
(Inherited from ValueType.)
Public methodUnionWith
Modifies the current set so that it contains all elements that are present in the current set, in the specified collection, or in both.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodICollectionInt32Add
Adds an item to the ICollectionT.
Explicit interface implementationPrivate methodIEnumerableGetEnumerator
Returns an enumerator that iterates through a collection.
Top
See Also