DerivedClassWithInheritedDocs Class

Sandcastle XML Comments

Sandcastle XML Comments GuideDerivedClassWithInheritedDocs Class
This is a derived class with inherited documentation.
Inheritance Hierarchy
SystemObject  XMLCommentsExamples.DocumentationInheritanceBaseInheritDoc
    XMLCommentsExamples.DocumentationInheritanceDerivedClassWithInheritedDocs

Namespace: XMLCommentsExamples.DocumentationInheritance
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
Syntax
public class DerivedClassWithInheritedDocs : BaseInheritDoc
Public Class DerivedClassWithInheritedDocs
	Inherits BaseInheritDoc
public ref class DerivedClassWithInheritedDocs : public BaseInheritDoc
type DerivedClassWithInheritedDocs =  
    class
        inherit BaseInheritDoc
    end

The DerivedClassWithInheritedDocs type exposes the following members.

Constructors
  NameDescription
Public methodDerivedClassWithInheritedDocs
Initializes a new instance of the DerivedClassWithInheritedDocs class
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodCode exampleMethodUsingSharedExample
This uses a shared example from a base member that is not public and this doesn't override.
Public methodCode exampleMethodWithExample
An override of the method with an example
(Overrides BaseInheritDocMethodWithExample.)
Public methodMethodWithLotsOfComments
The method in the base class has lots of comments.
(Overrides BaseInheritDocMethodWithLotsOfComments(Int32).)
Protected methodCode exampleMethodWithTwoExamples
This only includes one of the examples
(Overrides BaseInheritDocMethodWithTwoExamples.)
Public methodOverloadedMethod(String)
This overloaded method does something
Public methodOverloadedMethod(String, Int32)
There are three overloads for this method.
Public methodOverloadedMethod(String, String)
This overloaded method does something
Public methodToString
Returns a string that represents the current object.
(Overrides BaseInheritDocToString.)
Top
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