API Browser

Method

Load

static func Load(documentation: DocumentationComment?) -> RavenDocumentation

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

Loads a documentation comment into Raven's format-neutral representation.

Parameters

Name Type Description
documentation DocumentationComment? The Markdown or XML documentation comment to load.

Return value

RavenDocumentation

A Raven documentation value, or an empty value when documentation is null.