SampleClass Methods

Sandcastle XML Comments

Sandcastle XML Comments Guide SampleClass Methods

The SampleClass type exposes the following members.

Methods
  Name Description
Public method Code example AverageValues(IEnumerableDouble)
This is used to average an enumerable list of values
Public method AverageValues(IEnumerableDouble, IEnumerableDouble)
This is used to get the average of two enumerable list of values
Public method CallStoredProcedure
Executes a SqlCommand with the specified storedProcName as a stored procedure initialized for updating the values of the specified row.
Public method ConceptualLinkExample
See the conceptualLink topic for more information.
Public method DoSomething
This version of the method takes no parameters.
Public method DoSomething(Int32)
This version of the method takes an integer parameter.
Public method DoSomething(String)
This version of the method takes a string parameter.
Public method DoSomething(Int32, String)
This version of the method takes both an integer and a string parameter.
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method FilterPriorityExample
Filter priority example
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method Code example GetRandomNumber
This returns a random number
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method IncludeAllExample
This summary came from an external XML file.
Public method IncludeSectionsExample
In this example, the include element is used to pull in sections of the comments.
Public method Increment
The Increment method increments the stored number by one
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method MethodRequiringSpecificPermissions
The permission element is used to document the types of permissions that a caller must be granted to access this method.
Protected method OnSomethingHappened
This is a protected virtual method used to raise the SomethingHappened event.
Public method ParagraphExample
A simple demonstration of the para element.
Public method PerformAnAction
This performs an action
Public method PreliminaryExample
This method may go away or its signature may change in a later release.
Public method ProcessText
This method processes text
Public method SeeElementExternalExample
This is used to demonstrate the external reference type of see and seealso elements.
Public method Static member SeeLangWordExamples
This demonstrates the see element's langword form
Public method SummaryRemarksExample
The summary is a brief description of the type or type member and will be displayed in IntelliSense and the Object Browser.
Public method SumValues(IEnumerableInt32)
This is used to sum an enumerable list of values
Public method SumValues(IEnumerableInt32, IEnumerableInt32)
This is used to sum two enumerable list of values
Public method TemporaryMethod
A temporary method
Public method TokenExample
The help file was built on October 10, 2015 using Sandcastle v2015.10.10.0.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public method VariousListExamples
This method shows various examples of the list XML comments element.
Public method VariousNoteExamples
This shows the result of the various note types.
Top
See Also