Pennington.ApiMetadata.ParsedXmlDoc

namespace Pennington.ApiMetadata;

/// Structured representation of a parsed xmldoc comment split into its standard sections.
public record ParsedXmlDoc
{
    /// Shared empty instance used when no xmldoc is available.
    
public static ParsedXmlDoc Empty { get; }


    /// Nodes from the <example> element.
    
public ImmutableArray<XmlDocNode> Example { get; set; }


    /// True when Example contains any nodes.
    
public bool HasExample { get; }


    /// True when Remarks contains any nodes.
    
public bool HasRemarks { get; }


    /// True when Returns contains any nodes.
    
public bool HasReturns { get; }


    /// True when Summary contains any nodes.
    
public bool HasSummary { get; }


    /// Per-parameter nodes keyed by parameter name, from <param> elements.
    
public ImmutableDictionary<string, ImmutableArray<XmlDocNode>> Params { get; set; }


    /// Structured representation of a parsed xmldoc comment split into its standard sections.
    
public ParsedXmlDoc(ImmutableArray<XmlDocNode> Summary, ImmutableArray<XmlDocNode> Remarks, ImmutableDictionary<string, ImmutableArray<XmlDocNode>> Params, ImmutableDictionary<string, ImmutableArray<XmlDocNode>> TypeParams, ImmutableArray<XmlDocNode> Returns, ImmutableArray<XmlDocNode> Example, ImmutableArray<string> SeeAlso)
;

    /// Nodes from the <remarks> element.
    
public ImmutableArray<XmlDocNode> Remarks { get; set; }


    /// Nodes from the <returns> element.
    
public ImmutableArray<XmlDocNode> Returns { get; set; }


    /// Cref values collected from <seealso> elements.
    
public ImmutableArray<string> SeeAlso { get; set; }


    /// Nodes from the <summary> element.
    
public ImmutableArray<XmlDocNode> Summary { get; set; }


    /// Per-type-parameter nodes keyed by name, from <typeparam> elements.
    
public ImmutableDictionary<string, ImmutableArray<XmlDocNode>> TypeParams { get; set; }

}