Class MemberDocumentation

Describes documentation about a member.

Inheritance

object

MemberDocumentation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SpiceSharp.Documentation

Assembly: SpiceSharp.dll

Syntax

public class MemberDocumentation

Constructors

MemberDocumentation(MemberInfo)

Initializes a new instance of the MemberDocumentation class.

Declaration

public MemberDocumentation(MemberInfo member)

Parameters

Type	Name	Description
MemberInfo	member	The member info.

Properties

BaseType

Gets the base member type of the parameter and/or property.

Declaration

public Type BaseType { get; }

Property Value

Type	Description
Type	The base type.

Description

Gets the description of the property and/or parameter.

Declaration

public string Description { get; }

Property Value

Type	Description
string	The description.

Interesting

Gets a value indicating whether this member is interesting.

Declaration

public bool Interesting { get; }

Property Value

Type	Description
bool	true if this instance is interesting; otherwise, false.

IsParameter

Determines whether the member describes a parameter (can set a value).

Declaration

public bool IsParameter { get; }

Property Value

Type	Description
bool	true if the member describes a parameter; otherwise, false.

IsPrincipal

Gets a value indicating whether this instance is principal.

Declaration

public bool IsPrincipal { get; }

Property Value

Type	Description
bool	true if this instance is principal; otherwise, false.

IsProperty

Determines whether the member describes a property (can return a value).

Declaration

public bool IsProperty { get; }

Property Value

Type	Description
bool	true if the member describes a property; otherwise, false.

IsStatic

Gets a value indicating whether the member is static.

Declaration

public bool IsStatic { get; }

Property Value

Type	Description
bool	true if this member is static; otherwise, false.

Member

Gets the member.

Declaration

public MemberInfo Member { get; }

Property Value

Type	Description
MemberInfo	The member.

MemberType

Gets the type of the parameter and/or property.

Declaration

public Type MemberType { get; }

Property Value

Type	Description
Type	The type.

Names

Gets the names of the member.

Declaration

public IReadOnlyList<string> Names { get; }

Property Value

Type	Description
IReadOnlyList<string>	The names of the member.

Units

Gets the units of the member.

Declaration

public string Units { get; }

Property Value

Type	Description
string	The units.

Extension Methods

Utility.ThrowIfNull<T>(T, string)