This documentation is also published as Markdown for efficient machine reading: the whole site is indexed at /llms.txt, and every page has a clean Markdown copy under /_llms/. These are generated from the same source and cost far fewer tokens to read than this rendered HTML.

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

#
public 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.
    
public ParsedXmlDoc Parse(string xmlDocumentation)

;
}