No release in over 3 years
Low commit activity in last 3 years
YARD documentation helper for ClassMethods-style modules.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 2.0.0
>= 0
~> 3.2
~> 1.2

Runtime

>= 0
 Project Readme

Yard-classmethods

Build Status Gem Version Code Climate Gemnasium License

Yard-classmethods is a YARD plugin to help with embedding class methods defined in a module ClassMethods style.

Installation

Install the gem:

$ gem install yard-classmethods

You can either enable the plugin on the command line:

$ yard doc --plugin classmethods

or add it your .yardopts file to enable it permanently:

$ echo '--plugin classmethods' >> .yardopts

Usage

The plugin exposes a @!classmethods directive:

module FixtureModule
  # A normal method
  def my_normal_method
  end

  # @!classmethods
  module ClassMethods
    # A class method via a shim module
    def my_class_method
    end

    def included(klass)
      super
      klass.extend ClassMethods
    end
  end

  extend ClassMethods
end

License

Copyright 2015, Noah Kantrowitz

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.