Yard-classmethods is a YARD plugin to help with embedding
class methods defined in a
module ClassMethods style.
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
The plugin exposes a
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
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
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.