class Ameba::Rule::Documentation::Documentation

Overview

A rule that enforces documentation for public types: modules, classes, enums, methods and macros.

YAML configuration example:

Documentation/Documentation:
  Enabled: true
  IgnoreClasses: false
  IgnoreModules: true
  IgnoreEnums: false
  IgnoreDefs: true
  IgnoreMacros: false
  IgnoreMacroHooks: true

Included Modules

Defined in:

ameba/rule/documentation/documentation.cr

Constant Summary

MACRO_HOOK_NAMES = ["inherited", "included", "extended", "method_missing", "method_added", "finished"] of ::String
MSG = "Missing documentation"

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Ameba::Rule::Base

==(other) ==, catch(source : Source) catch, excluded?(source) excluded?, group group, hash hash, name name, special? special?, test(source : Source, node : Crystal::ASTNode, *opts)
test(source : Source) test

Class methods inherited from class Ameba::Rule::Base

default_severity : Ameba::Severity default_severity

Macros inherited from class Ameba::Rule::Base

issue_for(*args, **kwargs, &block) issue_for

Macros inherited from module Ameba::Config::RuleConfig

properties(&block) properties

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(config = nil) #

A rule that enforces documentation for public types: modules, classes, enums, methods and macros.

YAML configuration example:

Documentation/Documentation:
  Enabled: true
  IgnoreClasses: false
  IgnoreModules: true
  IgnoreEnums: false
  IgnoreDefs: true
  IgnoreMacros: false
  IgnoreMacroHooks: true

[View source]

Class Method Detail

def self.parsed_doc : String | Nil #

Returns documentation for this rule, if there is any.

module Ameba
  # This is a test rule.
  # Does nothing.
  class MyRule < Ameba::Rule::Base
    def test(source)
    end
  end
end

MyRule.parsed_doc # => "This is a test rule.\nDoes nothing."

Instance Method Detail

def description : String #

def description=(description : String) #

def enabled=(enabled : Bool) #

def enabled? : Bool #

def excluded : Array(String) | Nil #

def excluded=(excluded : Array(String) | Nil) #

def ignore_classes=(ignore_classes : Bool) #

def ignore_classes? : Bool #

def ignore_defs=(ignore_defs : Bool) #

def ignore_defs? : Bool #

def ignore_enums=(ignore_enums : Bool) #

def ignore_enums? : Bool #

def ignore_macro_hooks=(ignore_macro_hooks : Bool) #

def ignore_macro_hooks? : Bool #

def ignore_macros=(ignore_macros : Bool) #

def ignore_macros? : Bool #

def ignore_modules=(ignore_modules : Bool) #

def ignore_modules? : Bool #

def severity : Ameba::Severity #

def severity=(severity : Ameba::Severity) #

def test(source, node : Crystal::ClassDef, scope : AST::Scope) #

[View source]
def test(source, node : Crystal::ModuleDef, scope : AST::Scope) #

[View source]
def test(source, node : Crystal::EnumDef, scope : AST::Scope) #

[View source]
def test(source, node : Crystal::Def, scope : AST::Scope) #

[View source]
def test(source, node : Crystal::Macro, scope : AST::Scope) #

[View source]
def test(source) #

[View source]