5 instantiations of DocumentationComment
Microsoft.CodeAnalysis.Workspaces (5)
Shared\Utilities\DocumentationComment.cs (5)
140return new DocumentationComment(xml) { HadXmlParseError = true }; 145=> _comment = new DocumentationComment(xml); 334return new DocumentationComment(text) { SummaryText = text }; 351return new DocumentationComment(text) { SummaryText = text }; 374public static readonly DocumentationComment Empty = new(string.Empty);
88 references to DocumentationComment
Microsoft.CodeAnalysis.CSharp.Features (4)
Completion\CompletionProviders\EnumAndCompletionListTagCompletionProvider.cs (2)
327var documentation = CodeAnalysis.Shared.Utilities.DocumentationComment.FromXmlFragment(xmlText);
DocumentationComments\DocCommentConverter.cs (2)
83var docComment = DocumentationComment.FromXmlFragment(xmlFragment);
Microsoft.CodeAnalysis.EditorFeatures.UnitTests (2)
MetadataAsSource\DocCommentFormatterTests.cs (2)
28var docComment = DocumentationComment.FromXmlFragment(docCommentXmlFragment);
Microsoft.CodeAnalysis.Features (21)
LanguageServices\SymbolDisplayService\AbstractSymbolDisplayService.AbstractSymbolDescriptionBuilder.cs (13)
161var firstSymbolDocumentationComment = GetAppropriateDocumentationComment(firstSymbol, Compilation, CancellationToken); 173private DocumentationComment GetAppropriateDocumentationComment(ISymbol firstSymbol, Compilation compilation, CancellationToken cancellationToken) 181private DocumentationComment SynthesizeDocumentationCommentForLocal( 185return DocumentationComment.Empty; 192return DocumentationComment.Empty; 217return DocumentationComment.Empty; 229var docComment = DocumentationComment.FromXmlFragment(text); 234docComment = DocumentationComment.FromXmlFragment($"<summary>{text}</summary>"); 239docComment = DocumentationComment.FromXmlFragment($"<summary>{text.Replace("<", "&lt;").Replace(">", "&gt;")}</summary>"); 243return DocumentationComment.Empty; 249private void AddDocumentationContent(ISymbol symbol, DocumentationComment documentationComment) 287private void AddExceptions(DocumentationComment documentationComment)
MetadataAsSource\AbstractMetadataAsSourceService.DocCommentFormatter.cs (1)
34internal static ImmutableArray<string> Format(IDocumentationCommentFormattingService docCommentFormattingService, DocumentationComment docComment)
Shared\Extensions\ISymbolExtensions_2.cs (7)
188/// Returns the <see cref="DocumentationComment"/> for a symbol, even if it involves going to other symbols to find it. 190public static DocumentationComment GetAppropriateDocumentationComment(this ISymbol symbol, Compilation compilation, CancellationToken cancellationToken) 196IParameterSymbol parameter => GetParameterDocumentation(parameter, compilation, cancellationToken) ?? DocumentationComment.Empty, 197ITypeParameterSymbol typeParam => typeParam.ContainingSymbol.GetDocumentationComment(compilation, expandIncludes: true, expandInheritdoc: true, cancellationToken: cancellationToken)?.GetTypeParameter(typeParam.Name) ?? DocumentationComment.Empty, 204private static DocumentationComment? GetParameterDocumentation(IParameterSymbol parameter, Compilation compilation, CancellationToken cancellationToken) 249private static DocumentationComment GetMethodDocumentation(this IMethodSymbol method, Compilation compilation, CancellationToken cancellationToken) 258return method.AssociatedSymbol?.GetDocumentationComment(compilation, expandIncludes: true, expandInheritdoc: true, cancellationToken: cancellationToken) ?? DocumentationComment.Empty;
Microsoft.CodeAnalysis.Workspaces (20)
ExternalAccess\VSTypeScript\Api\VSTypeScriptDocumentationCommentWrapper.cs (2)
9internal readonly struct VSTypeScriptDocumentationCommentWrapper(DocumentationComment underlyingObject) 12=> new(DocumentationComment.FromXmlFragment(xml));
Shared\Extensions\ISymbolExtensions.cs (7)
221public static DocumentationComment GetDocumentationComment(this ISymbol symbol, Compilation compilation, CultureInfo? preferredCulture = null, bool expandIncludes = false, bool expandInheritdoc = false, CancellationToken cancellationToken = default) 224private static DocumentationComment GetDocumentationComment(ISymbol symbol, HashSet<ISymbol>? visitedSymbols, Compilation compilation, CultureInfo? preferredCulture, bool expandIncludes, bool expandInheritdoc, CancellationToken cancellationToken) 237return DocumentationComment.Empty; 258return RoslynString.IsNullOrEmpty(xmlText) ? DocumentationComment.Empty : DocumentationComment.FromXmlFragment(xmlText); 385var inheritedDocumentation = GetDocumentationComment(symbol, visitedSymbols, compilation, preferredCulture: null, expandIncludes: true, expandInheritdoc: true, cancellationToken); 386if (inheritedDocumentation == DocumentationComment.Empty)
Shared\Utilities\DocumentationComment.cs (11)
93private static volatile DocumentationComment? s_cacheLastXmlFragmentParse; 96/// Parses and constructs a <see cref="DocumentationComment" /> from the given fragment of XML. 100public static DocumentationComment FromXmlFragment(string xml) 102var result = s_cacheLastXmlFragmentParse; 118private readonly DocumentationComment _comment; 125/// Parse and construct a <see cref="DocumentationComment" /> from the given fragment of XML. 129public static DocumentationComment Parse(string xml) 147private DocumentationComment ParseInternal(string xml) 329public DocumentationComment? GetParameter(string parameterName) 346public DocumentationComment? GetTypeParameter(string parameterName) 374public static readonly DocumentationComment Empty = new(string.Empty);
Microsoft.CodeAnalysis.Workspaces.UnitTests (40)
UtilityTest\DocumentationCommentTests.cs (40)
16var document = DocumentationComment.FromXmlFragment(""); 27var comment = DocumentationComment.FromXmlFragment( 55var comment = DocumentationComment.FromXmlFragment( 83var comment = DocumentationComment.FromXmlFragment("<summary>Summary 1</summary><summary>Summary 2</summary>"); 92var comment = DocumentationComment.FromXmlFragment(""" 105var comment = DocumentationComment.FromXmlFragment("<summary>goo"); 114var comment = DocumentationComment.FromXmlFragment( 129var comment = DocumentationComment.FromXmlFragment( 144var comment = DocumentationComment.FromXmlFragment( 159var comment = DocumentationComment.FromXmlFragment( 174var comment = DocumentationComment.FromXmlFragment( 189var comment = DocumentationComment.FromXmlFragment( 206var comment = DocumentationComment.FromXmlFragment( 220var comment = DocumentationComment.FromXmlFragment( 234var comment = DocumentationComment.FromXmlFragment( 256var comment = DocumentationComment.FromXmlFragment(@"<summary>This is a summary</summary>"); 264var comment = DocumentationComment.FromXmlFragment(@"<param/><typeparam/><exception/>"); 276var comments = DocumentationComment.FromXmlFragment(fragment); 322var comment = DocumentationComment.FromXmlFragment(fullXml); 375var comment = DocumentationComment.FromXmlFragment(fullXml);
Microsoft.VisualStudio.LanguageServices (1)
Library\ObjectBrowser\AbstractDescriptionBuilder.cs (1)
285var documentationComment = symbol.GetDocumentationComment(compilation, expandIncludes: true, expandInheritdoc: true, cancellationToken: CancellationToken.None);