documentationRules top-level constant

Set<String> const documentationRules

Documentation standard: public-API dartdoc completeness and correctness.

Pack id: documentation. A strict bar most useful for published packages and shared libraries; suggested for Flutter projects.

Implementation

const Set<String> documentationRules = <String>{
  'require_public_api_documentation',
  'require_parameter_documentation',
  'require_return_documentation',
  'require_exception_documentation',
  'require_example_in_documentation',
  'require_complex_logic_comments',
  'require_deprecation_message',
  'prefer_correct_throws',
  'avoid_misleading_documentation',
  'verify_documented_parameters_exist',
  'deprecated_new_in_comment_reference',
  'missing_code_block_language_in_doc_comment',
  'unintended_html_in_doc_comment',
  'uri_does_not_exist_in_doc_import',
};