C# Class Microsoft.DocAsCode.Metadata.ManagedReference.TripleSlashCommentModel

Show file Open project: dotnet/docfx Class Usage Examples

Public Methods

Method	Description
CreateModel ( string xml, SyntaxLanguage language, ITripleSlashCommentParserContext context ) : TripleSlashCommentModel
GetParameter ( string name ) : string
GetTypeParameter ( string name ) : string

Private Methods

Method	Description
GetExamples ( XPathNavigator nav, ITripleSlashCommentParserContext context ) : List	To get `example` tags out
GetExceptions ( XPathNavigator nav, ITripleSlashCommentParserContext context ) : List	Get exceptions nodes out from triple slash comments
GetListContent ( XPathNavigator navigator, string xpath, string contentType, ITripleSlashCommentParserContext context ) : string>.Dictionary
GetMulitpleCrefInfo ( XPathNavigator navigator, string selector ) : IEnumerable
GetMultipleExampleNodes ( XPathNavigator navigator, string selector ) : IEnumerable
GetMultipleLinkInfo ( XPathNavigator navigator, string selector ) : IEnumerable
GetParameters ( XPathNavigator navigator, ITripleSlashCommentParserContext context ) : string>.Dictionary
GetRemarks ( XPathNavigator nav, ITripleSlashCommentParserContext context ) : string	Get remarks node out from triple slash comments This is a sample of exception node
GetReturns ( XPathNavigator nav, ITripleSlashCommentParserContext context ) : string
GetSeeAlsos ( XPathNavigator nav, ITripleSlashCommentParserContext context ) : List	To get `seealso` tags out
GetSees ( XPathNavigator nav, ITripleSlashCommentParserContext context ) : List	To get `see` tags out
GetSingleNodeValue ( XPathNavigator nav, string selector ) : string
GetSummary ( XPathNavigator nav, ITripleSlashCommentParserContext context ) : string	Get summary node out from triple slash comments
GetTypeParameters ( XPathNavigator navigator, ITripleSlashCommentParserContext context ) : string>.Dictionary
GetValue ( string name, string>.Dictionary dictionary ) : string
GetXmlValue ( XPathNavigator node ) : string
NormalizeXml ( string xml, int parentIndex ) : string	Split xml into lines. Trim meaningless whitespaces. if a line starts with xml node, all leading whitespaces would be trimmed otherwise text node start position always aligns with the start position of its parent line(the last previous line that starts with xml node) Trim newline character for code element.
RemoveLeadingSpaces ( string xml ) : string	Remove least common whitespces in each line of xml
ResolveCrefLink ( XNode node, string nodeSelector, string>.Action addReference ) : void
ResolveSeeAlsoCref ( XNode node, string>.Action addReference ) : void
ResolveSeeCref ( XNode node, string>.Action addReference ) : void
TripleSlashCommentModel ( string xml, SyntaxLanguage language, ITripleSlashCommentParserContext context ) : System

Method Details

CreateModel() public static method

public static CreateModel ( string xml, SyntaxLanguage language, ITripleSlashCommentParserContext context ) : TripleSlashCommentModel
xml	string
language	SyntaxLanguage
context	ITripleSlashCommentParserContext
return	TripleSlashCommentModel

GetParameter() public method

public GetParameter ( string name ) : string
name	string
return	string

GetTypeParameter() public method

public GetTypeParameter ( string name ) : string
name	string
return	string