XmlDocumentation¶

Parsed XML documentation from a symbol.

See also: Projections Overview | ValidSymbol

Creating¶

var doc = symbol.XmlDocumentation;      // from OptionalSymbol/ValidSymbol
var doc = XmlDocumentation.FromSymbol(symbol);

Checking Presence¶

doc.HasValue                // bool
doc.IsEmpty                 // bool

Content¶

doc.Summary                 // string?
doc.Remarks                 // string?
doc.Returns                 // string?
doc.Value                   // string?
doc.Example                 // string?
doc.RawXml                  // string?

Parameters¶

doc.Params                  // ImmutableDictionary<string, string>
doc.GetParam("name")        // string?

Type Parameters¶

doc.TypeParams              // ImmutableDictionary<string, string>
doc.GetTypeParam("T")       // string?

Exceptions and References¶

doc.Exceptions              // ImmutableArray<(string Type, string Description)>
doc.SeeAlso                 // ImmutableArray<string>