This site provides a machine-readable index at /llms.txt.

Skip to main content Skip to navigation

IXmlDocParser Pennington.ApiMetadata

Parses raw xmldoc XML (the string returned by ISymbol.GetDocumentationCommentXml() or the summary/remarks text in DocFx ManagedReference YAML) into a structured ParsedXmlDoc tree.

Methods

Parse

#
ParsedXmlDoc Parse(string? xmlDocumentation);

Parses the given xmldoc XML string and returns a structured tree, or Empty when the input is null, empty, or malformed.

Parameters

xmlDocumentation string?

Returns

ParsedXmlDoc

Pennington.ApiMetadata.IXmlDocParser

namespace Pennington.ApiMetadata;

/// Parses raw xmldoc XML (the string returned by ISymbol.GetDocumentationCommentXml() or the summary/remarks text in DocFx ManagedReference YAML) into a structured ParsedXmlDoc tree.
public interface IXmlDocParser
{
    /// Parses the given xmldoc XML string and returns a structured tree, or Empty when the input is null, empty, or malformed.
    
ParsedXmlDoc Parse(string? xmlDocumentation);
}