struct_handler_methods.rb in yard-0.8.0

- old
+ new

@@ -1,7 +1,9 @@
 # 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
 module YARD::Handlers::Ruby::StructHandlerMethods
   include YARD::CodeObjects
 
   # Extracts the user's defined @member tag for a given class and its member. Returns
@@ -40,11 +42,10 @@
   end
 
   # Gets the return type for the member in a nicely formatted string. Used
   # to be injected into auto-generated docstrings.
   #
-  # @param [ClassObject] klass the class whose tags we're searching
-  # @param [String] member the name of the struct member whose return type we need
+  # @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.
   def return_type_from_tag(member_tag)
     (member_tag && member_tag.types) ? member_tag.types : "Object"
   end
\ No newline at end of file