rubocop

https://github.com/bbatsov/rubocop

Ruby

A Ruby static code analyzer, based on the community Ruby style guide.

RuboCop::Cop::Style::Documentation#nodoc_comment?

First checks if the :nodoc: comment is associated with the
class/module. Unless the element is tagged with :nodoc:, the search
proceeds to check its ancestors for :nodoc: all.
Note: How end-of-line comments are associated with code changed in
parser-2.2.0.4.

Source | Google | Stack overflow

Edit

git clone [email protected]:bbatsov/rubocop.git

cd rubocop

open lib/rubocop/cop/style/documentation.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-RuboCop--Cop--Style--Documentation-nodoc_comment--for-pr

# Commit to git

git add lib/rubocop/cop/style/documentation.rbgit commit -m "better docs for RuboCop::Cop::Style::Documentation#nodoc_comment?"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-RuboCop--Cop--Style--Documentation-nodoc_comment--for-pr

hub pull-request

# Celebrate!