 | SampleClass Class |
This class is used to demonstrate the various XML comments elements. It serves no useful purpose.
Inheritance HierarchyNamespace: XMLCommentsExamples
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
SyntaxThe SampleClass type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AverageValues(IEnumerableDouble) |
This is used to average an enumerable list of values
|
| AverageValues(IEnumerableDouble, IEnumerableDouble) |
This is used to get the average of two enumerable list of values
|
| CallStoredProcedure |
Executes a SqlCommand with the specified
storedProcName as a stored procedure initialized
for updating the values of the specified row.
|
| ConceptualLinkExample |
See the conceptualLink topic
for more information.
|
| DoSomething |
This version of the method takes no parameters.
|
| DoSomething(Int32) |
This version of the method takes an integer parameter.
|
| DoSomething(String) |
This version of the method takes a string parameter.
|
| DoSomething(Int32, String) |
This version of the method takes both an integer and a string parameter.
|
| Equals | (Inherited from Object.) |
| FilterPriorityExample |
Filter priority example
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetRandomNumber |
This returns a random number
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IncludeAllExample |
This summary came from an external XML file.
|
| IncludeSectionsExample |
In this example, the include element is used to pull in sections of
the comments.
|
| Increment |
The Increment method increments the stored number by one
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MethodRequiringSpecificPermissions |
The permission element is used to document the types of permissions that
a caller must be granted to access this method.
|
| OnSomethingHappened |
This is a protected virtual method used to raise the
SomethingHappened event.
|
| ParagraphExample |
A simple demonstration of the para element.
|
| PerformAnAction |
This performs an action
|
| PreliminaryExample |
This method may go away or its signature may change in a later release.
|
| ProcessText |
This method processes text
|
| SeeElementExternalExample |
This is used to demonstrate the external reference type of see
and seealso elements.
|
 | SeeLangWordExamples |
This demonstrates the see element's langword form
|
| SummaryRemarksExample |
The summary is a brief description of the type or type member and will
be displayed in IntelliSense and the Object Browser.
|
| SumValues(IEnumerableInt32) |
This is used to sum an enumerable list of values
|
| SumValues(IEnumerableInt32, IEnumerableInt32) |
This is used to sum two enumerable list of values
|
| TemporaryMethod |
A temporary method
|
| TokenExample |
The help file was built on November 24, 2014 using Sandcastle
v2014.11.22.0.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| VariousListExamples |
This method shows various examples of the list XML comments element.
|
| VariousNoteExamples |
This shows the result of the various note types.
|
Operators
Properties| Name | Description | |
|---|---|---|
 | SampleNumber |
This is used to get or set the sample number
|
Events| Name | Description | |
|---|---|---|
 | SomethingHappened |
This event is raised when something interesting happens.
|
Thread SafetyAny public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also