Patch #28943

Remove RDoc tags

Added by Sho HASHIMOTO 19 days ago. Updated 16 days ago.

Status:ClosedStart date:
Priority:LowDue date:
Assignee:Go MAEDA% Done:

0%

Category:Documentation
Target version:4.0.0

Description

I was removed :nodoc: from *.rb because yard doesn't support :nodoc: and :nodoc: shows in generated html.

remove_nodoc.patch Magnifier (4.9 KB) Sho HASHIMOTO, 2018-06-04 17:52

Associated revisions

Revision 17370
Added by Go MAEDA 16 days ago

Remove RDoc tags (#28943).

Patch by Sho HASHIMOTO.

History

#1 Updated by Go MAEDA 19 days ago

I can not be sure if we should merge the change.

Currently, the codebase does not contain any Yard tags. And the author of Yard wrote that using "@private" tag is not recommended. Also, the patch changes the output of rdoc.

Sho HASHIMOTO, do you think those are OK?

#2 Updated by Sho HASHIMOTO 19 days ago

Currently, the codebase does not contain any Yard tags.

umm... Redmine is already using Yard tags like these. rdoc can't parse normaly. I think supporting both(rdoc and yard) is unhappy. We can't use all of on one side only tag like :nodoc:, @param, ...

"@private" tag is not recommended.

I knew. Please remove :nodoc: if yard is taken and @private isn't used. Maybe yard recommends writing all documents.

#3 Updated by Sho HASHIMOTO 19 days ago

Redmine is not using important rdoc tag like call-seq, include, ...
Maybe, using yard will have only few problems.

$ egrep '#\s*:[a-zA-Z]+:' **/*.rb
lib/plugins/open_id_authentication/lib/open_id_authentication.rb:    def using_open_id?(identifier = nil) #:doc:
lib/plugins/open_id_authentication/lib/open_id_authentication.rb:    def authenticate_with_open_id(identifier = nil, options = {}, &block) #:doc:
lib/redmine/core_ext/string.rb:class String #:nodoc:
lib/redmine/core_ext/string/conversions.rb:module Redmine #:nodoc:
lib/redmine/core_ext/string/conversions.rb:  module CoreExtensions #:nodoc:
lib/redmine/core_ext/string/conversions.rb:    module String #:nodoc:
lib/redmine/core_ext/string/inflections.rb:module Redmine #:nodoc:
lib/redmine/core_ext/string/inflections.rb:  module CoreExtensions #:nodoc:
lib/redmine/core_ext/string/inflections.rb:    module String #:nodoc:
lib/redmine/helpers/gantt.rb:      # :nodoc:
lib/redmine/menu_manager.rb:    class MenuError < StandardError #:nodoc:
lib/redmine/plugin.rb:module Redmine #:nodoc:
lib/redmine/scm/adapters/abstract_adapter.rb:      class AbstractAdapter #:nodoc:
lib/redmine/scm/adapters/command_failed.rb:      class CommandFailed < StandardError #:nodoc:
lib/redmine/scm/adapters/cvs_adapter.rb:        # :pserver:anonymous@foo.bar:/path => /path
lib/redmine/scm/adapters/cvs_adapter.rb:        # :ext:cvsservername:/path => /path
lib/redmine/version.rb:  module VERSION #:nodoc:
test/mocks/open_id_authentication_mock.rb:    def authenticate_with_open_id(identity_url = params[:openid_url], options = {}) #:doc:

And I want to add @since tag after this ticket. It will be useful for plugin developper.

#4 Updated by Go MAEDA 18 days ago

  • Target version set to Candidate for next major release

Sho HASHIMOTO wrote:

umm... Redmine is already using Yard tags like these. rdoc can't parse normaly. I think supporting both(rdoc and yard) is unhappy. We can't use all of on one side only tag like :nodoc:, @param, ...

I had overlooked that. Thank you for pointing it out.

As Sho HASHIMOTO wrote, it is obvious that the document of Redmine is supposed to be generated with Yard because Redmine has a rake task "rake yard" and uses some Yard tags.

#5 Updated by Go MAEDA 17 days ago

  • Target version changed from Candidate for next major release to 4.1.0

Setting target version to 4.1.0.

#7 Updated by Sho HASHIMOTO 17 days ago

It is no problem for me! Thanks!

#8 Updated by Go MAEDA 17 days ago

  • Subject changed from Remove :nodoc: to Remove RDoc tags

#9 Updated by Go MAEDA 16 days ago

  • Status changed from New to Closed
  • Assignee set to Go MAEDA
  • Target version changed from 4.1.0 to 4.0.0

Committed. Thanks.

#10 Updated by Sho HASHIMOTO 16 days ago

Thanks!!

Also available in: Atom PDF