Documenting Custom Rules

[MissaelAnda]

• I've read the documentation and I can't find details on how to achieve this.

It would be cool if custom rules could be documented with description and example.

This:

/**
 * @description This rule validates something
 * @example "This:Is:An:Example"
 */
class CustomRule implements Rule
{
    //
}

Produces:

[shalvah]

Good idea. PRs welcome.

I'd prefer a static docs method, though. It's simpler to implement and avoids us having to parse the annotation text, which can get tricky.