BaseInheritDoc Class

Sandcastle XML Comments

previous page next page
Sandcastle XML Comments GuideBaseInheritDoc Class
A base class from which to inherit documentation
Inheritance Hierarchy
SystemObject  XMLCommentsExamples.DocumentationInheritanceBaseInheritDoc
    XMLCommentsExamples.DocumentationInheritanceDerivedClassWithInheritedDocs

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

The BaseInheritDoc type exposes the following members.

Constructors
  NameDescription
Public methodBaseInheritDoc
Constructor
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 exampleMethodWithExample
Summary for the method with an example
Public methodCode exampleMethodWithLotsOfComments
The method in the base class has lots of comments.
Protected methodCode exampleMethodWithTwoExamples
A method with two examples
Public methodToString
The ToString implementation for BaseInheritDoc
(Overrides ObjectToString.)
Top
Remarks

These remarks are for the base class.

This information applies to all classes that derive from BaseInheritDoc:

  • Point #1.
  • Point #2.
  • Point #3.

See Also
previous page start next page