Raven Programming language for .NET

API Browser
Class

DocumentationStructure

class DocumentationStructure

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

Inheritance: Object → DocumentationStructure
Implements: IEquatable<DocumentationStructure>

Constructors

1 item
DocumentationStructure(SourceFormat: DocumentationFormat, Summary: string, Body: string, AdditionalBody: string, Returns: string?, Value: string?, Remarks: string?, Example: string?, InheritDocReference: string?, TypeParameters: ImmutableArray<DocumentationEntry>, Parameters: ImmutableArray<DocumentationEntry>, Exceptions: ImmutableArray<DocumentationEntry>, See: ImmutableArray<DocumentationEntry>, SeeAlso: ImmutableArray<DocumentationEntry>) No summary available.

Properties

14 items
AdditionalBody: string No summary available.
Body: string No summary available.
Example: string? No summary available.
Exceptions: ImmutableArray<DocumentationEntry> No summary available.
InheritDocReference: string? No summary available.
Parameters: ImmutableArray<DocumentationEntry> No summary available.
Remarks: string? No summary available.
Returns: string? No summary available.
See: ImmutableArray<DocumentationEntry> No summary available.
SeeAlso: ImmutableArray<DocumentationEntry> No summary available.
SourceFormat: DocumentationFormat No summary available.
Summary: string No summary available.
TypeParameters: ImmutableArray<DocumentationEntry> No summary available.
Value: string? No summary available.

Methods

8 items
<Clone>$() -> DocumentationStructure No summary available.
Deconstruct(SourceFormat: out DocumentationFormat, Summary: out string, Body: out string, AdditionalBody: out string, Returns: out string?, Value: out string?, Remarks: out string?, Example: out string?, InheritDocReference: out string?, TypeParameters: out ImmutableArray<DocumentationEntry>, Parameters: out ImmutableArray<DocumentationEntry>, Exceptions: out ImmutableArray<DocumentationEntry>, See: out ImmutableArray<DocumentationEntry>, SeeAlso: out ImmutableArray<DocumentationEntry>) -> () No summary available.
Equals(other: DocumentationStructure) -> bool Indicates whether the current object is equal to another object of the same type. Required implementation (no default). Defined by IEquatable<DocumentationStructure>.Equals · Defined by IEquatable<DocumentationStructure>.Equals
Equals(other: DocumentationStructure?) -> 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: DocumentationStructure?, right: DocumentationStructure?) -> bool No summary available.
operator !=(left: DocumentationStructure?, right: DocumentationStructure?) -> bool No summary available.