NDepend.API Documentation
TryGetDescription Method
NDepend.Issue Namespace > IRule Interface : TryGetDescription Method
The formatting of the returned description.
The rule description formatted.
Try get the rule description if available, formatted according to stringFormattingKind.
Syntax
bool TryGetDescription( 
   StringFormattingKind stringFormattingKind,
   out string ruleDescription
)

Parameters

stringFormattingKind
The formatting of the returned description.
ruleDescription
The rule description formatted.

Return Value

true if the rule description is available.
Requirements

Target Platforms: Windows 11, 10, 8, 7 and Linux, MacOS with net8.0, net7.0 or net6.0 installed

See Also

Reference

IRule Interface
IRule Members

Send Feedback