jazzy

This is a danger plugin to check for undocumented symbols via Jazzy.

Warn about undocumented symbols.

jazzy.warn_of_undocumented

Write a custom message for undocumented symbols.

jazzy.undocumented do |file,line|
    message("You forgot to document this", file:file, line:line)
end

Attributes

path_to_docs - Path to the docs folder, defaults to 'docs/'.

Methods

warn_of_undocumented - Warns about undocumented symbols.

undocumented - Finds and yields information about undocumented symbols.