Class

RavenDocumentation

class RavenDocumentation

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

Inheritance: Object → RavenDocumentation

Represents documentation independently of its authored or projected format.

Properties

5 items

Associations: ImmutableArray<DocumentationAssociation> Gets documentation associated with named or referenced subjects.

InheritedFrom: string? Gets the optional symbol reference from which documentation is inherited.

Sections: ImmutableArray<DocumentationSection> Gets the ordered narrative sections.

SourceFormat: DocumentationFormat Gets the format from which the documentation was loaded.

SourceText: string Gets the original authored or loaded content.

6 items

Equals(obj: object?) -> bool Determines whether the specified object is equal to the current object. Inherited from Object.Equals

GetAssociations(kind: DocumentationAssociationKind) -> ImmutableArray<DocumentationAssociation> Gets all subject associations with the specified kind.

GetHashCode() -> int Serves as the default hash function. Inherited from Object.GetHashCode

GetSection(kind: DocumentationSectionKind) -> string? Gets the content for the first section with the specified kind.

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

ToString() -> string? Returns a string that represents the current object. Inherited from Object.ToString