class SarifRule

Declaration

class SarifRule { /* full declaration omitted */ };

Description

A SARIF rule (\c reportingDescriptor object) contains information that describes a reporting item generated by a tool. A reporting item is either a result of analysis or notification of a condition encountered by the tool. Rules are arbitrary but are identifiable by a hierarchical rule-id. This builder provides an interface to create SARIF \c reportingDescriptor objects via the \ref SarifRule::create static method. Reference: 1. reportingDescriptor object

Declared at: clang/include/clang/Basic/Sarif.h:197

Member Variables

private std::string Name
private std::string Id
private std::string Description
private std::string HelpURI

Method Overview

  • private SarifRule()
  • public static clang::SarifRule create()
  • public clang::SarifRule setDescription(llvm::StringRef RuleDesc)
  • public clang::SarifRule setHelpURI(llvm::StringRef RuleHelpURI)
  • public clang::SarifRule setName(llvm::StringRef RuleName)
  • public clang::SarifRule setRuleId(llvm::StringRef RuleId)

Methods

SarifRule()

Declared at: clang/include/clang/Basic/Sarif.h:205

static clang::SarifRule create()

Declared at: clang/include/clang/Basic/Sarif.h:208

clang::SarifRule setDescription(
    llvm::StringRef RuleDesc)

Declared at: clang/include/clang/Basic/Sarif.h:220

Parameters

llvm::StringRef RuleDesc

clang::SarifRule setHelpURI(
    llvm::StringRef RuleHelpURI)

Declared at: clang/include/clang/Basic/Sarif.h:225

Parameters

llvm::StringRef RuleHelpURI

clang::SarifRule setName(llvm::StringRef RuleName)

Declared at: clang/include/clang/Basic/Sarif.h:210

Parameters

llvm::StringRef RuleName

clang::SarifRule setRuleId(llvm::StringRef RuleId)

Declared at: clang/include/clang/Basic/Sarif.h:215

Parameters

llvm::StringRef RuleId