Sandcastle XML Comments Guide
DerivedClassWithInheritedDocs Class |
This is a derived class with inherited documentation.
Inheritance Hierarchy
SystemObject XMLCommentsExamples.DocumentationInheritanceBaseInheritDoc
XMLCommentsExamples.DocumentationInheritanceDerivedClassWithInheritedDocs
XMLCommentsExamples.DocumentationInheritanceDerivedClassWithInheritedDocs
Namespace: XMLCommentsExamples.DocumentationInheritance
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
Syntax
The DerivedClassWithInheritedDocs type exposes the following members.
Constructors
Name | Description | |
---|---|---|
DerivedClassWithInheritedDocs | Initializes a new instance of the DerivedClassWithInheritedDocs class |
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.) | |
MethodUsingSharedExample |
This uses a shared example from a base member that is not
public and this doesn't override.
| |
MethodWithExample |
An override of the method with an example
(Overrides BaseInheritDocMethodWithExample.) | |
MethodWithLotsOfComments |
The method in the base class has lots of comments.
(Overrides BaseInheritDocMethodWithLotsOfComments(Int32).) | |
MethodWithTwoExamples |
This only includes one of the examples
(Overrides BaseInheritDocMethodWithTwoExamples.) | |
OverloadedMethod(String) |
This overloaded method does something
| |
OverloadedMethod(String, Int32) | There are three overloads for this method. | |
OverloadedMethod(String, String) |
This overloaded method does something
| |
ToString | Returns a string that represents the current object. (Overrides BaseInheritDocToString.) |
Remarks
This will inherit just the last <para> tag from
the base class's <remarks> tag:
This information applies to all classes that derive from BaseInheritDoc:
- Point #1.
- Point #2.
- Point #3.
See Also