From bff0fbce8baeddb3bba4d04131f1368763078e36 Mon Sep 17 00:00:00 2001 From: Go MAEDA Date: Fri, 8 Jun 2018 00:55:41 +0000 Subject: [PATCH] Remove RDoc tags (#28943). Patch by Sho HASHIMOTO. git-svn-id: http://svn.redmine.org/redmine/trunk@17370 e93f8b46-1217-0410-a6f0-8f06a7374b81 --- .../open_id_authentication/lib/open_id_authentication.rb | 4 ++-- lib/redmine/core_ext/string.rb | 3 ++- lib/redmine/core_ext/string/conversions.rb | 9 ++++++--- lib/redmine/core_ext/string/inflections.rb | 9 ++++++--- lib/redmine/helpers/gantt.rb | 2 +- lib/redmine/menu_manager.rb | 3 ++- lib/redmine/plugin.rb | 2 +- lib/redmine/scm/adapters/abstract_adapter.rb | 3 ++- lib/redmine/scm/adapters/command_failed.rb | 3 ++- lib/redmine/version.rb | 3 ++- lib/tasks/yardoc.rake | 2 +- test/mocks/open_id_authentication_mock.rb | 2 +- 12 files changed, 28 insertions(+), 17 deletions(-) diff --git a/lib/plugins/open_id_authentication/lib/open_id_authentication.rb b/lib/plugins/open_id_authentication/lib/open_id_authentication.rb index 48be8ddba..7afe6fdeb 100644 --- a/lib/plugins/open_id_authentication/lib/open_id_authentication.rb +++ b/lib/plugins/open_id_authentication/lib/open_id_authentication.rb @@ -109,12 +109,12 @@ module OpenIdAuthentication # the Rails convention "open_id_identifier" because that's what # the specification dictates in order to get browser auto-complete # working across sites - def using_open_id?(identifier = nil) #:doc: + def using_open_id?(identifier = nil) identifier ||= open_id_identifier !identifier.blank? || request.env[Rack::OpenID::RESPONSE] end - def authenticate_with_open_id(identifier = nil, options = {}, &block) #:doc: + def authenticate_with_open_id(identifier = nil, options = {}, &block) identifier ||= open_id_identifier if request.env[Rack::OpenID::RESPONSE] diff --git a/lib/redmine/core_ext/string.rb b/lib/redmine/core_ext/string.rb index 2da5ffef9..5d03b9b5c 100644 --- a/lib/redmine/core_ext/string.rb +++ b/lib/redmine/core_ext/string.rb @@ -1,7 +1,8 @@ require File.dirname(__FILE__) + '/string/conversions' require File.dirname(__FILE__) + '/string/inflections' -class String #:nodoc: +# @private +class String include Redmine::CoreExtensions::String::Conversions include Redmine::CoreExtensions::String::Inflections end diff --git a/lib/redmine/core_ext/string/conversions.rb b/lib/redmine/core_ext/string/conversions.rb index fbac0de7b..4fc571167 100644 --- a/lib/redmine/core_ext/string/conversions.rb +++ b/lib/redmine/core_ext/string/conversions.rb @@ -15,10 +15,13 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -module Redmine #:nodoc: - module CoreExtensions #:nodoc: - module String #:nodoc: +module Redmine + # @private + module CoreExtensions + # @private + module String # Custom string conversions + # @private module Conversions # Parses hours format and returns a float def to_hours diff --git a/lib/redmine/core_ext/string/inflections.rb b/lib/redmine/core_ext/string/inflections.rb index 2dd5a1fe5..efb62ee8e 100644 --- a/lib/redmine/core_ext/string/inflections.rb +++ b/lib/redmine/core_ext/string/inflections.rb @@ -15,10 +15,13 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -module Redmine #:nodoc: - module CoreExtensions #:nodoc: - module String #:nodoc: +module Redmine + # @private + module CoreExtensions + # @private + module String # Custom string inflections + # @private module Inflections def with_leading_slash starts_with?('/') ? self : "/#{ self }" diff --git a/lib/redmine/helpers/gantt.rb b/lib/redmine/helpers/gantt.rb index 294303209..756dc6e93 100644 --- a/lib/redmine/helpers/gantt.rb +++ b/lib/redmine/helpers/gantt.rb @@ -32,8 +32,8 @@ module Redmine IssueRelation::TYPE_PRECEDES => { :landscape_margin => 20, :color => '#628FEA' } }.freeze - # :nodoc: # Some utility methods for the PDF export + # @private class PDF MaxCharactorsForSubject = 45 TotalWidth = 280 diff --git a/lib/redmine/menu_manager.rb b/lib/redmine/menu_manager.rb index fb34e70c5..dcdd0fa23 100644 --- a/lib/redmine/menu_manager.rb +++ b/lib/redmine/menu_manager.rb @@ -17,7 +17,8 @@ module Redmine module MenuManager - class MenuError < StandardError #:nodoc: + # @private + class MenuError < StandardError end module MenuController diff --git a/lib/redmine/plugin.rb b/lib/redmine/plugin.rb index ad42980e1..203c50881 100644 --- a/lib/redmine/plugin.rb +++ b/lib/redmine/plugin.rb @@ -15,7 +15,7 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -module Redmine #:nodoc: +module Redmine class PluginNotFound < StandardError; end class PluginRequirementError < StandardError; end diff --git a/lib/redmine/scm/adapters/abstract_adapter.rb b/lib/redmine/scm/adapters/abstract_adapter.rb index 437ba92a8..7f3b8093f 100644 --- a/lib/redmine/scm/adapters/abstract_adapter.rb +++ b/lib/redmine/scm/adapters/abstract_adapter.rb @@ -21,7 +21,8 @@ require 'redmine/scm/adapters' module Redmine module Scm module Adapters - class AbstractAdapter #:nodoc: + # @private + class AbstractAdapter include Redmine::Utils::Shell # raised if scm command exited with error, e.g. unknown revision. diff --git a/lib/redmine/scm/adapters/command_failed.rb b/lib/redmine/scm/adapters/command_failed.rb index 562b00658..0d9571f8c 100644 --- a/lib/redmine/scm/adapters/command_failed.rb +++ b/lib/redmine/scm/adapters/command_failed.rb @@ -18,7 +18,8 @@ module Redmine module Scm module Adapters - class CommandFailed < StandardError #:nodoc: + # @private + class CommandFailed < StandardError end end end diff --git a/lib/redmine/version.rb b/lib/redmine/version.rb index 5d3caff14..fb8a73718 100644 --- a/lib/redmine/version.rb +++ b/lib/redmine/version.rb @@ -1,7 +1,8 @@ require 'rexml/document' module Redmine - module VERSION #:nodoc: + # @private + module VERSION MAJOR = 3 MINOR = 4 TINY = 5 diff --git a/lib/tasks/yardoc.rake b/lib/tasks/yardoc.rake index eab0d8606..60d3a644a 100644 --- a/lib/tasks/yardoc.rake +++ b/lib/tasks/yardoc.rake @@ -12,7 +12,7 @@ begin 'doc/RUNNING_TESTS', 'doc/UPGRADING'].join(',') - t.options += ['--output-dir', './doc/app', '--files', static_files] + t.options += ['--no-private', '--output-dir', './doc/app', '--files', static_files] end rescue LoadError diff --git a/test/mocks/open_id_authentication_mock.rb b/test/mocks/open_id_authentication_mock.rb index a7376e4ba..7cb78c7c7 100644 --- a/test/mocks/open_id_authentication_mock.rb +++ b/test/mocks/open_id_authentication_mock.rb @@ -14,7 +14,7 @@ module OpenIdAuthentication protected - def authenticate_with_open_id(identity_url = params[:openid_url], options = {}) #:doc: + def authenticate_with_open_id(identity_url = params[:openid_url], options = {}) if User.find_by_identity_url(identity_url) || identity_url.include?('good') extension_response_fields = {} -- 2.39.5