Module Values.RuleMetadataSource

Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.

Sourcetype nonrec t = {
  1. ruleId : RuleId.t option;
    (*

    The ID of the rule.

    *)
  2. ruleName : RuleName.t option;
    (*

    The name of the rule.

    *)
  3. shortDescription : ShortDescription.t option;
    (*

    A short description of the rule.

    *)
  4. longDescription : LongDescription.t option;
    (*

    A long description of the rule.

    *)
  5. ruleTags : RuleTags.t option;
    (*

    Tags that are associated with the rule.

    *)
}
Sourceval make : ?ruleId:RuleId.t -> ?ruleName:RuleName.t -> ?shortDescription:ShortDescription.t -> ?longDescription:LongDescription.t -> ?ruleTags:RuleTags.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `String of RuleTag.t ] list | `String of RuleId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t