Sha256: 75b082b4bc59df0282eb7ee6ecec543d2145028e9a50ff80338582dc1f63ba8e

Contents?: true

Size: 605 Bytes

Versions: 1

Compression:

Stored size: 605 Bytes

Contents

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

<blockquote>Warn about undocumented symbols.
  <pre>
jazzy.warn_of_undocumented</pre>
</blockquote>

<blockquote>Write a custom message for undocumented symbols.
  <pre>
jazzy.undocumented do |file,line|
    message("You forgot to document this", file:file, line:line)
end</pre>
</blockquote>


#### 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.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
danger-jazzy-0.1.1 README.md