Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change some type annotation in YARD doc #1175

Merged
merged 1 commit into from Aug 11, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/yard/cli/server.rb
Expand Up @@ -13,7 +13,7 @@ class Server < Command
# @return [Hash] a list of library names and yardoc files to serve
attr_accessor :libraries

# @return [Adapter] the adapter to use for loading the web server
# @return [YARD::Server::Adapter] the adapter to use for loading the web server
attr_accessor :adapter

# @return [Array<String>] a list of scripts to load
Expand Down
2 changes: 1 addition & 1 deletion lib/yard/docstring.rb
Expand Up @@ -67,7 +67,7 @@ def hash_flag=(v) @hash_flag = v.nil? ? false : v end
# when creating the new docstring object.
#
# @param [String] text the textual portion of the docstring
# @param [Array<Tag>] tags the list of tag objects in the docstring
# @param [Array<Tags::Tag>] tags the list of tag objects in the docstring
# @param [CodeObjects::Base, nil] object the object associated with the
# docstring. May be nil.
# @param [String] raw_data the complete docstring, including all
Expand Down
6 changes: 3 additions & 3 deletions lib/yard/docstring_parser.rb
Expand Up @@ -35,11 +35,11 @@ class DocstringParser
# @return [String] the complete input string to the parser.
attr_accessor :raw_text

# @return [Array<Tag>] the list of meta-data tags identified
# @return [Array<Tags::Tag>] the list of meta-data tags identified
# by the parser
attr_accessor :tags

# @return [Array<Directive>] a list of directives identified
# @return [Array<Tags::Directive>] a list of directives identified
# by the parser. This list will not be passed on to the
# Docstring object.
attr_accessor :directives
Expand Down Expand Up @@ -228,7 +228,7 @@ def create_ref_tag(tag_name, name, object_name)
end

# Creates a new directive using the registered {#library}
# @return [Directive] the directive object that is created
# @return [Tags::Directive] the directive object that is created
def create_directive(tag_name, tag_buf)
if library.has_directive?(tag_name)
dir = library.directive_create(tag_name, tag_buf, self)
Expand Down
2 changes: 1 addition & 1 deletion lib/yard/handlers/base.rb
Expand Up @@ -181,7 +181,7 @@ def inherited(subclass)
# the handlers, otherwise the same code will be parsed
# multiple times and slow YARD down.
#
# @param [Parser::RubyToken, Symbol, String, Regexp] matches
# @param [Parser::Ruby::Legacy::RubyToken, Symbol, String, Regexp] matches
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% certain this is the right one, but it's the only RubyToken I could find in this gem.

# statements that match the declaration will be
# processed by this handler. A {String} match is
# equivalent to a +/\Astring/+ regular expression
Expand Down
2 changes: 1 addition & 1 deletion lib/yard/handlers/processor.rb
Expand Up @@ -88,7 +88,7 @@ def namespace_for_handler; @@parser_type_extensions ||= {} end
attr_accessor :extra_state

# Creates a new Processor for a +file+.
# @param [SourceParser] parser the parser used to initialize the processor
# @param [Parser::SourceParser] parser the parser used to initialize the processor
def initialize(parser)
@file = parser.file || "(stdin)"
@namespace = YARD::Registry.root
Expand Down
2 changes: 1 addition & 1 deletion lib/yard/server/commands/base.rb
Expand Up @@ -45,7 +45,7 @@ class Base

# @group Attributes Set Per Request

# @return [Request] request object
# @return [Rack::Request] request object
attr_accessor :request

# @return [String] the path after the command base URI
Expand Down