Use `@see` tag of YARD instead of plain text "see"

Current doc: <http://www.rubydoc.info/gems/capybara/3.26.0/Capybara/Minitest/Assertions>

About `@see` tag: <https://www.rubydoc.info/gems/yard/file/docs/Tags.md#see>

[skip ci]
This commit is contained in:
Masafumi Koba 2019-07-18 11:47:23 +09:00
parent 1cfbfea150
commit 6dfe0e473e
No known key found for this signature in database
GPG Key ID: 60F83A73EFECA4BD
1 changed files with 29 additions and 29 deletions

View File

@ -9,38 +9,38 @@ module Capybara
## Assert text exists ## Assert text exists
# #
# @!method assert_text # @!method assert_text
# see {Capybara::Node::Matchers#assert_text} # @see Capybara::Node::Matchers#assert_text
## Assert text does not exist ## Assert text does not exist
# #
# @!method assert_no_text # @!method assert_no_text
# see {Capybara::Node::Matchers#assert_no_text} # @see Capybara::Node::Matchers#assert_no_text
## ##
# Assertion that page title does match # Assertion that page title does match
# #
# @!method assert_title # @!method assert_title
# see {Capybara::Node::DocumentMatchers#assert_title} # @see Capybara::Node::DocumentMatchers#assert_title
## ##
# Assertion that page title does not match # Assertion that page title does not match
# #
# @!method refute_title # @!method refute_title
# @!method assert_no_title # @!method assert_no_title
# see {Capybara::Node::DocumentMatchers#assert_no_title} # @see Capybara::Node::DocumentMatchers#assert_no_title
## ##
# Assertion that current path matches # Assertion that current path matches
# #
# @!method assert_current_path # @!method assert_current_path
# see {Capybara::SessionMatchers#assert_current_path} # @see Capybara::SessionMatchers#assert_current_path
## ##
# Assertion that current page does not match # Assertion that current page does not match
# #
# @!method refute_current_path # @!method refute_current_path
# @!method assert_no_current_path # @!method assert_no_current_path
# see {Capybara::SessionMatchers#assert_no_current_path} # @see Capybara::SessionMatchers#assert_no_current_path
%w[text no_text title no_title current_path no_current_path].each do |assertion_name| %w[text no_text title no_title current_path no_current_path].each do |assertion_name|
class_eval <<-ASSERTION, __FILE__, __LINE__ + 1 class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
@ -64,37 +64,37 @@ module Capybara
## Assert selector exists on page ## Assert selector exists on page
# #
# @!method assert_selector # @!method assert_selector
# see {Capybara::Node::Matchers#assert_selector} # @see Capybara::Node::Matchers#assert_selector
## Assert selector does not exist on page ## Assert selector does not exist on page
# #
# @!method assert_no_selector # @!method assert_no_selector
# see {Capybara::Node::Matchers#assert_no_selector} # @see Capybara::Node::Matchers#assert_no_selector
## Assert element matches selector ## Assert element matches selector
# #
# @!method assert_matches_selector # @!method assert_matches_selector
# see {Capybara::Node::Matchers#assert_matches_selector} # @see Capybara::Node::Matchers#assert_matches_selector
## Assert element does not match selector ## Assert element does not match selector
# #
# @!method assert_xpath # @!method assert_xpath
# see {Capybara::Node::Matchers#assert_not_matches_selector} # @see Capybara::Node::Matchers#assert_not_matches_selector
## Assert element has the provided CSS styles ## Assert element has the provided CSS styles
# #
# @!method assert_matches_style # @!method assert_matches_style
# see {Capybara::Node::Matchers#assert_matches_style} # @see Capybara::Node::Matchers#assert_matches_style
## Assert element has a matching sibling ## Assert element has a matching sibling
# #
# @!method assert_sibling # @!method assert_sibling
# see {Capybara::Node::Matchers#assert_sibling} # @see Capybara::Node::Matchers#assert_sibling
## Assert element has a matching ancestor ## Assert element has a matching ancestor
# #
# @!method assert_ancestor # @!method assert_ancestor
# see {Capybara::Node::Matchers#assert_ancestor} # @see Capybara::Node::Matchers#assert_ancestor
%w[selector no_selector matches_style %w[selector no_selector matches_style
all_of_selectors none_of_selectors any_of_selectors all_of_selectors none_of_selectors any_of_selectors
@ -163,72 +163,72 @@ module Capybara
# Assertion that there is xpath # Assertion that there is xpath
# #
# @!method assert_xpath # @!method assert_xpath
# see {Capybara::Node::Matchers#has_xpath?} # @see Capybara::Node::Matchers#has_xpath?
## ##
# Assertion that there is no xpath # Assertion that there is no xpath
# #
# @!method refute_xpath # @!method refute_xpath
# @!method assert_no_xpath # @!method assert_no_xpath
# see {Capybara::Node::Matchers#has_no_xpath?} # @see Capybara::Node::Matchers#has_no_xpath?
## ##
# Assertion that there is css # Assertion that there is css
# #
# @!method assert_css # @!method assert_css
# see {Capybara::Node::Matchers#has_css?} # @see Capybara::Node::Matchers#has_css?
## ##
# Assertion that there is no css # Assertion that there is no css
# #
# @!method refute_css # @!method refute_css
# @!method assert_no_css # @!method assert_no_css
# see {Capybara::Node::Matchers#has_no_css?} # @see Capybara::Node::Matchers#has_no_css?
## ##
# Assertion that there is link # Assertion that there is link
# #
# @!method assert_link # @!method assert_link
# see {Capybara::Node::Matchers#has_link?} # @see Capybara::Node::Matchers#has_link?
## ##
# Assertion that there is no link # Assertion that there is no link
# #
# @!method assert_no_link # @!method assert_no_link
# @!method refute_link # @!method refute_link
# see {Capybara::Node::Matchers#has_no_link?} # @see Capybara::Node::Matchers#has_no_link?
## ##
# Assertion that there is button # Assertion that there is button
# #
# @!method assert_button # @!method assert_button
# see {Capybara::Node::Matchers#has_button?} # @see Capybara::Node::Matchers#has_button?
## ##
# Assertion that there is no button # Assertion that there is no button
# #
# @!method refute_button # @!method refute_button
# @!method assert_no_button # @!method assert_no_button
# see {Capybara::Node::Matchers#has_no_button?} # @see Capybara::Node::Matchers#has_no_button?
## ##
# Assertion that there is field # Assertion that there is field
# #
# @!method assert_field # @!method assert_field
# see {Capybara::Node::Matchers#has_field?} # @see Capybara::Node::Matchers#has_field?
## ##
# Assertion that there is no field # Assertion that there is no field
# #
# @!method refute_field # @!method refute_field
# @!method assert_no_field # @!method assert_no_field
# see {Capybara::Node::Matchers#has_no_field?} # @see Capybara::Node::Matchers#has_no_field?
## ##
# Assertion that there is checked_field # Assertion that there is checked_field
# #
# @!method assert_checked_field # @!method assert_checked_field
# see {Capybara::Node::Matchers#has_checked_field?} # @see Capybara::Node::Matchers#has_checked_field?
## ##
# Assertion that there is no checked_field # Assertion that there is no checked_field
@ -240,7 +240,7 @@ module Capybara
# Assertion that there is unchecked_field # Assertion that there is unchecked_field
# #
# @!method assert_unchecked_field # @!method assert_unchecked_field
# see {Capybara::Node::Matchers#has_unchecked_field?} # @see Capybara::Node::Matchers#has_unchecked_field?
## ##
# Assertion that there is no unchecked_field # Assertion that there is no unchecked_field
@ -252,27 +252,27 @@ module Capybara
# Assertion that there is select # Assertion that there is select
# #
# @!method assert_select # @!method assert_select
# see {Capybara::Node::Matchers#has_select?} # @see Capybara::Node::Matchers#has_select?
## ##
# Assertion that there is no select # Assertion that there is no select
# #
# @!method refute_select # @!method refute_select
# @!method assert_no_select # @!method assert_no_select
# see {Capybara::Node::Matchers#has_no_select?} # @see Capybara::Node::Matchers#has_no_select?
## ##
# Assertion that there is table # Assertion that there is table
# #
# @!method assert_table # @!method assert_table
# see {Capybara::Node::Matchers#has_table?} # @see Capybara::Node::Matchers#has_table?
## ##
# Assertion that there is no table # Assertion that there is no table
# #
# @!method refute_table # @!method refute_table
# @!method assert_no_table # @!method assert_no_table
# see {Capybara::Node::Matchers#has_no_table?} # @see Capybara::Node::Matchers#has_no_table?
private private