Ruby yard options
The typical convention is to indent subsequent lines by 2 spaces. To re-use a macro in another docstring after it is defined, simply use! This directive is useful if a class has dynamic meta-programmed behaviour that cannot be recognized by Ruby yard options.
Use the more powerful! Tags Overview Tags represent meta-data as well as behavioural data that can be added to documentation through the tag style syntax. In other words, it specifies that this ruby yard options should be ruby yard options private but cannot due to Ruby's visibility restrictions. Custom meta-data tags can be added either programmatically or via the YARD command-line. YARD has tools to check your documentation quality and coveragerun inline RSpec tests, test your documentation example codeadd " git blame " support to your source listings, graphs to your documentation, even one to document Perl code!
A list of built-in directives are found below in the Directive List. Custom meta-data tags can be added either programmatically or via the YARD command-line. A full list can be found here. YARD has tools to check your documentation quality and coveragerun ruby yard options RSpec tests, test your documentation example codeadd " git blame " support to your source listings, ruby yard options to your documentation, even one to document Perl code!
Ruby yard options or Module Types Any Ruby type is allowed as a class or module type. In this case, they can not be re-used in future docstrings, but they will expand in the first definition. Although the options class allows for Hash-like access opts[: YARD is a documentation generation tool ruby yard options the Ruby programming language. Since the options class is more than just a basic Hash, the subclass can provide aliasing and convenience methods to simplify option property access, and, if needed, support backward-compatibility for deprecated key names.
To end a group listing use! For example, the following return tag lists a set of types returned by a method: Class or Module Types Any Ruby type is allowed as a class or module type. Instead, register the attribute before using ruby yard options. In some cases, version of specific modules, classes, methods or generalized components might change independently between releases.
All keys will be symbolized. AddressableAmpCRM Note that the type specifier list is always an optional field and can be omitted when present in a tag signature. Ruby yard options project is at RubyDoc.