MemberModel Class

Namespace

Kampute.DocToolkit.Models

Assembly

Kampute.DocToolkit.dll

Definition

Represents the documentation model for a type or type member.

public abstract class MemberModel : IDocumentModel, IEquatable<MemberModel>

Inheritance

object
MemberModel

Implements

Inherited by

MemberModel<T>

Remarks

The MemberModel class provides a lightweight wrapper that associates reflection metadata with documentation context. It serves as a base class for all documentation model elements.

The class provides access to reflection metadata through the Metadata property, and to documentation-specific functionality such as documentation comments and URL.

Constructors

MemberModel(IMember)

Initializes a new instance of the MemberModel class.

Properties

Assembly	Gets the assembly that contains the member.
Context	Gets the documentation context associated with this member.
DeclaringType	Gets the declaring type of the member.
Doc	Gets the documentation comments associated with the member.
HierarchyPath	Gets the hierarchy of parent document models that lead to this member.
MemberNameQualifier	Gets the name qualifier to use for formatting the member's name.
Metadata	Gets the reflection metadata for this member.
ModelType	Gets the type of the documentation model.
Name	Gets the formatted name of the member.
Namespace	Gets the namespace that contains the member.
Url	Gets the URL of the member's documentation page.

Methods

Equals(MemberModel)	Determines whether the specified member definition is equal to the current member definition.
Equals(object)	Determines whether the specified object is equal to the current object.
GetHashCode()	Returns the hash code for this instance.
ToString()	Returns a string that represents the current object.
TryGetDocumentationFile(out string)	Attempts to get the relative path of the documentation file for the member.