Module | YARD::Handlers::Ruby::StructHandlerMethods |
In: |
lib/yard/handlers/ruby/struct_handler_methods.rb
|
Helper methods to parse @attr_* tags on a class.
@deprecated The use of +@attr+ tags are deprecated since 0.8.0 in favour of
the +@!attribute+ directive. This module should not be relied on.
@since 0.5.6
Creates the auto-generated docstring for the getter method of a struct‘s member. This is used so the generated documentation will look just like that of an attribute defined using attr_accessor.
@param [ClassObject] klass the class whose members we‘re working with @param [String] member the name of the member we‘re generating documentation for @return [String] a docstring to be attached to the getter method for this member
Creates the auto-generated docstring for the setter method of a struct‘s member. This is used so the generated documentation will look just like that of an attribute defined using attr_accessor.
@param [ClassObject] klass the class whose members we‘re working with @param [String] member the name of the member we‘re generating documentation for @return [String] a docstring to be attached to the setter method for this member
Determines whether to create an attribute method based on the class‘s tags.
@param [ClassObject] klass the class whose tags we‘re searching @param [String] member the name of the struct member we need @param [Symbol] type (:read) reader method, or writer method? @return [Boolean] should the attribute be created?
Creates the getter (reader) method and attaches it to the class as an attribute. Also sets up the docstring to prettify the documentation output.
@param [ClassObject] klass the class to attach the method to @param [String] member the name of the member we‘re generating a method for
Creates the setter (writer) method and attaches it to the class as an attribute. Also sets up the docstring to prettify the documentation output.
@param [ClassObject] klass the class to attach the method to @param [String] member the name of the member we‘re generating a method for
Extracts the user‘s defined @member tag for a given class and its member. Returns nil if the user did not define a @member tag for this struct entry.
@param [ClassObject] klass the class whose tags we‘re searching @param [String] member the name of the struct member we need @param [Symbol] type reader method, or writer method? @return [Tags::Tag, nil] the tag matching the request, or nil if not found
Gets the return type for the member in a nicely formatted string. Used to be injected into auto-generated docstrings.
@param [Tags::Tag] member_tag the tag object to check for types @return [String] the user-declared type of the struct member, or [Object] if
the user did not define a type for this member.