Sandcastle XML Comments Guide
Base
A base class from which to inherit documentation
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 class BaseInheritDocVB
Public Class BaseInheritDocC++
public ref class BaseInheritDocF#
type BaseInheritDoc = class end- Inheritance
- Object BaseInheritDoc
- Derived
Remarks
These remarks are for the base class.
This information applies to all classes that derive from BaseInheritDoc:
- Point #1.
- Point #2.
- Point #3.
Constructors
| BaseInheritDoc | Constructor |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| 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 the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MethodWithExample | Summary for the method with an example |
| MethodWithLotsOfComments | The method in the base class has lots of comments. |
| MethodWithTwoExamples | A method with two examples |
| ToString |
The ToString implementation for BaseInheritDoc
(Overrides ObjectToString) |