BaseInheritDoc Class
Sandcastle XML Comments Guide
 | BaseInheritDoc Class |
A base class from which to inherit documentation
Inheritance HierarchySystemObject XMLCommentsExamples.DocumentationInheritanceBaseInheritDoc
XMLCommentsExamples.DocumentationInheritanceDerivedClassWithInheritedDocs
XMLCommentsExamples.DocumentationInheritanceDerivedClassWithInheritedDocs
Namespace: XMLCommentsExamples.DocumentationInheritance
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
SyntaxThe BaseInheritDoc type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BaseInheritDoc |
Constructor
|
Methods| Name | Description | |
|---|---|---|
| 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.) |
RemarksThese remarks are for the base class.
This information applies to all classes that derive from BaseInheritDoc:
- Point #1.
- Point #2.
- Point #3.
See Also