Skip to content

Features

The Cake.Issues.DocFx addin provides the following features.

Tip: Running DocFx

DocFx can be run with Cake.DocFx addin.

Basic features

  • Reads warnings from DocFx log files.

Supported IIssue properties

  • IIssue.ProviderType
  • IIssue.ProviderName
  • IIssue.Run (1)
  • IIssue.Identifier (2)
  • IIssue.ProjectName
  • IIssue.ProjectFileRelativePath
  • IIssue.AffectedFileRelativePath
  • IIssue.Line
  • IIssue.EndLine
  • IIssue.Column
  • IIssue.EndColumn
  • IIssue.FileLink (3)
  • IIssue.MessageText
  • IIssue.MessageHtml
  • IIssue.MessageMarkdown
  • IIssue.Priority
  • IIssue.PriorityName
  • IIssue.RuleId
  • IIssue.RuleUrl
  1. Can be set while reading issues
  2. Set to IIssue.MessageText
  3. Can be set while reading issues