Class

DocumentationAssociation

class DocumentationAssociation

Namespace: Raven.CodeAnalysis.Documentation
Assembly: Raven.CodeAnalysis.dll
Source file: RavenDocumentation.cs

Inheritance: Object → DocumentationAssociation
Implements: IEquatable<DocumentationAssociation>

Associates documentation with a name or symbol reference.

Parameters

Name	Description
`Kind`	The semantic role of the association.
`Name`	The associated source-level name, when applicable.
`Reference`	The associated symbol or resource reference, when applicable.
`Content`	The authored description of the association.

Constructors

1 item

DocumentationAssociation(Kind: DocumentationAssociationKind, Name: string?, Reference: string?, Content: string) Associates documentation with a name or symbol reference.

Properties

4 items

Content: string The authored description of the association.

Kind: DocumentationAssociationKind The semantic role of the association.

Name: string? The associated source-level name, when applicable.

Reference: string? The associated symbol or resource reference, when applicable.

Methods

8 items

<Clone>$() -> DocumentationAssociation No summary available.

Deconstruct(Kind: out DocumentationAssociationKind, Name: out string?, Reference: out string?, Content: out string) -> () No summary available.

Equals(other: DocumentationAssociation) -> bool Indicates whether the current object is equal to another object of the same type. Required implementation (no default). Defined by IEquatable<DocumentationAssociation>.Equals · Defined by IEquatable<DocumentationAssociation>.Equals

Equals(other: DocumentationAssociation?) -> bool No summary available.

Equals(obj: object?) -> bool No summary available. Overrides Object.Equals

GetHashCode() -> int No summary available. Overrides Object.GetHashCode

GetType() -> Type Gets the System.Type of the current instance. Inherited from Object.GetType

ToString() -> string No summary available. Overrides Object.ToString

Operators

2 items

operator ==(left: DocumentationAssociation?, right: DocumentationAssociation?) -> bool No summary available.

operator !=(left: DocumentationAssociation?, right: DocumentationAssociation?) -> bool No summary available.