CxXmlDocItemParamref

Description

sealed class Tinman.Core.Cx.XmlDoc.CxXmlDocItemParamref

Derived from: CxXmlDocItem ^abstract
ICxIdContainer
ICxReference

A paragraph content item that represents a reference to a method parameter or a generic type parameter:

<paramref name="name"/>
<typeparamref name="name"/>

The ICxReference.Resolved property may return the following values:

A CxParameter of a ICxParametersContainer, which is either a constructor, delegate or method parameter.
A CxMemberProperty of a CxDeclarationType, when referring to the implicit 'value' parameter.
null iff unresolved

Public / Constructors

CxXmlDocItemParamref

public constructor CxXmlDocItemParamref → (3)

name ⁱⁿ : CxId: See ICxIdContainer.Name.
typeParameter ^opt : bool = false: See IsTypeParameter.
flags ^opt : WhitespaceFlags = WhitespaceFlags.None: See CxXmlDocItem.Flags.

Creates a new instance of CxXmlDocItemParamref.

Public / Attributes

IsTypeParameter

[Constant]
public attribute IsTypeParameter → (get)

value : bool: true if this is a reference to a generic type parameter,
false if this is a reference to a method parameter.

Returns whether this node references a generic type parameter or method parameter.