SampleClass Class

This class is used to demonstrate the various XML comments elements. It serves no useful purpose.

Definition

Namespace: XMLCommentsExamples
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
C#View SourceRequest Example
public class SampleClass
Inheritance
Object    SampleClass

Properties

SampleNumber This is used to get or set the sample number

Methods

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
BibliographyCiteExample This demonstrates the cite element used to produce a bibliography section in the topic.
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.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FilterPriorityExample Filter priority example
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetRandomNumber This returns a random number
GetTypeGets 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
MemberwiseCloneCreates 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.
Preliminary
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
Preliminary
TokenExample The help file was built on September 14, 2024 using Sandcastle v2024.9.12.0.
ToStringReturns 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.

Events

SomethingHappened This event is raised when something interesting happens.

Operators

Addition(SampleClass, SampleClass) Addition operator overload

Thread Safety

Any 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