API Browser

Method

Deconstruct

func Deconstruct(out SourceFormat: DocumentationFormat, out Summary: string, out Body: string, out AdditionalBody: string, out Returns: string?, out Value: string?, out Remarks: string?, out Example: string?, out InheritDocReference: string?, out TypeParameters: ImmutableArray<DocumentationEntry>, out Parameters: ImmutableArray<DocumentationEntry>, out Exceptions: ImmutableArray<DocumentationEntry>, out See: ImmutableArray<DocumentationEntry>, out SeeAlso: ImmutableArray<DocumentationEntry>) -> ()

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

Parameters

Name Type Description
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>

Return value

()