Example #1
0
        public override void Initialize(AnalysisContext context)
        {
            if (context == null)
            {
                throw new ArgumentNullException(nameof(context));
            }

            base.Initialize(context);

            context.RegisterSyntaxNodeAction(
                f => FormatSummaryOnSingleLineRefactoring.AnalyzeSingleLineDocumentationCommentTrivia(f),
                SyntaxKind.SingleLineDocumentationCommentTrivia);
        }
        public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
        {
            SyntaxNode root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);

            DocumentationCommentTriviaSyntax documentationComment = root
                                                                    .FindNode(context.Span, findInsideTrivia: true)?
                                                                    .FirstAncestorOrSelf <DocumentationCommentTriviaSyntax>();

            Debug.Assert(documentationComment != null, $"{nameof(documentationComment)} is null");

            if (documentationComment == null)
            {
                return;
            }

            foreach (Diagnostic diagnostic in context.Diagnostics)
            {
                switch (diagnostic.Id)
                {
                case DiagnosticIdentifiers.FormatDocumentationSummaryOnSingleLine:
                {
                    CodeAction codeAction = CodeAction.Create(
                        "Format summary on a single line",
                        cancellationToken => FormatSummaryOnSingleLineRefactoring.RefactorAsync(context.Document, documentationComment, cancellationToken),
                        diagnostic.Id + EquivalenceKeySuffix);

                    context.RegisterCodeFix(codeAction, diagnostic);
                    break;
                }

                case DiagnosticIdentifiers.FormatDocumentationSummaryOnMultipleLines:
                {
                    CodeAction codeAction = CodeAction.Create(
                        "Format summary on multiple lines",
                        cancellationToken => FormatSummaryOnMultipleLinesRefactoring.RefactorAsync(context.Document, documentationComment, cancellationToken),
                        diagnostic.Id + EquivalenceKeySuffix);

                    context.RegisterCodeFix(codeAction, diagnostic);
                    break;
                }
                }
            }
        }
Example #3
0
        public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
        {
            SyntaxNode root = await context.GetSyntaxRootAsync().ConfigureAwait(false);

            if (!TryFindFirstAncestorOrSelf(root, context.Span, out DocumentationCommentTriviaSyntax documentationComment, findInsideTrivia: true, getInnermostNodeForTie: false))
            {
                return;
            }

            foreach (Diagnostic diagnostic in context.Diagnostics)
            {
                switch (diagnostic.Id)
                {
                case DiagnosticIdentifiers.FormatDocumentationSummaryOnSingleLine:
                {
                    CodeAction codeAction = CodeAction.Create(
                        "Format summary on a single line",
                        cancellationToken => FormatSummaryOnSingleLineRefactoring.RefactorAsync(context.Document, documentationComment, cancellationToken),
                        GetEquivalenceKey(diagnostic));

                    context.RegisterCodeFix(codeAction, diagnostic);
                    break;
                }

                case DiagnosticIdentifiers.FormatDocumentationSummaryOnMultipleLines:
                {
                    CodeAction codeAction = CodeAction.Create(
                        "Format summary on multiple lines",
                        cancellationToken => FormatSummaryOnMultipleLinesRefactoring.RefactorAsync(context.Document, documentationComment, cancellationToken),
                        GetEquivalenceKey(diagnostic));

                    context.RegisterCodeFix(codeAction, diagnostic);
                    break;
                }
                }
            }
        }
        private void AnalyzeDocumentationComment(SyntaxNodeAnalysisContext context)
        {
            var documentationComment = (DocumentationCommentTriviaSyntax)context.Node;

            FormatSummaryOnSingleLineRefactoring.Analyze(context, documentationComment);
        }