# YARD CHEATSHEET http://yardoc.org ## May 2020 - updated fork: https://gist.github.com/phansch/db18a595d2f5f1ef16646af72fe1fb0e cribbed from http://pastebin.com/xgzeAmBn Templates to remind you of the options and formatting for the different types of objects you might want to document using YARD. ## Modules # Namespace for classes and modules that handle serving documentation over HTTP # @since 0.6.0 ## Classes # Abstract base class for CLI utilities. Provides some helper methods for # the option parser # # @author Full Name # @abstract # @since 0.6.0 # @attr [Types] attribute_name a full description of the attribute # @attr_reader [Types] name description of a readonly attribute # @attr_writer [Types] name description of writeonly attribute # @deprecated Describe the reason or provide alt. references here ## Methods # An alias to {Parser::SourceParser}'s parsing method # # @author Donovan Bray # # @see http://example.com Description of URL # @see SomeOtherClass#method # # @deprecated Use {#my_new_method} instead of this method because # it uses a library that is no longer supported in Ruby 1.9. # The new method accepts the same parameters. # # @abstract # @private # # @param opts [Hash] the options to create a message with. # @option opts [String] :subject The subject # @option opts [String] :from ('nobody') From address # @option opts [String] :to Recipient email # @option opts [String] :body ('') The email's body # # @param (see User#initialize) # @param [OptionParser] opts the option parser object # @param [Array<String>] args the arguments passed from input. This # array will be modified. # @param [Array<String, Symbol>] list the list of strings and symbols. # # The options parsed out of the commandline. # Default options are: # :format => :dot # # @example Reverse a string # "mystring.reverse" #=> "gnirtsym" # # @example Parse a glob of files # YARD.parse('lib/**/*.rb') # # @raise [ExceptionClass] description # # @return [optional, types, ...] description # @return [true] always returns true # @return [void] # @return [String, nil] the contents of our object or nil # if the object has not been filled with data. # # We don't care about the "type" here: # @return the object # # @return [String, #read] a string or object that responds to #read # @return description here with no types ## Anywhere # @todo Add support for Jabberwocky service # There is an open source Jabberwocky library available # at http://somesite.com that can be integrated easily # into the project. ## Blocks # for block {|a, b, c| ... } # @yield [a, b, c] Description of block # # @yieldparam [optional, types, ...] argname description # @yieldreturn [optional, types, ...] description