https://www.redmine.org/https://www.redmine.org/favicon.ico?16793021292018-06-05T02:34:02ZRedmineRedmine - Patch #28943: Remove RDoc tagshttps://www.redmine.org/issues/28943?journal_id=853902018-06-05T02:34:02ZGo MAEDA
<ul></ul><p>I can not be sure if we should merge the change.</p>
<p>Currently, the codebase does not contain any Yard tags. And the author of Yard wrote that using "@private" tag is <a href="https://github.com/lsegal/yard/issues/34#issuecomment-75793" class="external">not recommended</a>. Also, the patch changes the output of rdoc.</p>
<p>Sho HASHIMOTO, do you think those are OK?</p> Redmine - Patch #28943: Remove RDoc tagshttps://www.redmine.org/issues/28943?journal_id=853912018-06-05T02:46:11ZSho HASHIMOTO
<ul></ul><blockquote>
<p>Currently, the codebase does not contain any Yard tags.</p>
</blockquote>
<p>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, ...</p>
<ul>
<li><a class="external" href="https://github.com/redmine/redmine/blob/3.4.5/lib/redmine/plugin.rb#L140">https://github.com/redmine/redmine/blob/3.4.5/lib/redmine/plugin.rb#L140</a></li>
<li><a class="external" href="https://github.com/redmine/redmine/blob/3.4.5/app/helpers/application_helper.rb#L43-L46">https://github.com/redmine/redmine/blob/3.4.5/app/helpers/application_helper.rb#L43-L46</a></li>
</ul>
<blockquote>
<p>"@private" tag is not recommended.</p>
</blockquote>
<p>I knew. Please remove :nodoc: if yard is taken and <a class="user active" href="https://www.redmine.org/users/22360">private private education loan</a> isn't used. Maybe yard recommends writing all documents.</p> Redmine - Patch #28943: Remove RDoc tagshttps://www.redmine.org/issues/28943?journal_id=853922018-06-05T03:11:58ZSho HASHIMOTO
<ul></ul><p>Redmine is not using important rdoc tag like call-seq, include, ...<br />Maybe, using yard will have only few problems.</p>
<pre>
$ 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:
</pre>
<p>And I want to add <a class="user active" href="https://www.redmine.org/users/393941">Marc Since</a> tag after this ticket. It will be useful for plugin developper.</p> Redmine - Patch #28943: Remove RDoc tagshttps://www.redmine.org/issues/28943?journal_id=853982018-06-05T06:59:48ZGo MAEDA
<ul><li><strong>Target version</strong> set to <i>Candidate for next major release</i></li></ul><p>Sho HASHIMOTO wrote:</p>
<blockquote>
<p>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, ...</p>
<ul>
<li><a class="external" href="https://github.com/redmine/redmine/blob/3.4.5/lib/redmine/plugin.rb#L140">https://github.com/redmine/redmine/blob/3.4.5/lib/redmine/plugin.rb#L140</a></li>
<li><a class="external" href="https://github.com/redmine/redmine/blob/3.4.5/app/helpers/application_helper.rb#L43-L46">https://github.com/redmine/redmine/blob/3.4.5/app/helpers/application_helper.rb#L43-L46</a></li>
</ul>
</blockquote>
<p>I had overlooked that. Thank you for pointing it out.</p>
<p>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.</p> Redmine - Patch #28943: Remove RDoc tagshttps://www.redmine.org/issues/28943?journal_id=854392018-06-07T00:20:45ZGo MAEDA
<ul><li><strong>Target version</strong> changed from <i>Candidate for next major release</i> to <i>4.1.0</i></li></ul><p>Setting target version to 4.1.0.</p> Redmine - Patch #28943: Remove RDoc tagshttps://www.redmine.org/issues/28943?journal_id=854402018-06-07T00:28:36ZGo MAEDA
<ul></ul><p>Maybe we can also remove :doc: tag. Do you think it is OK?<br /><a class="external" href="http://www.redmine.org/projects/redmine/repository/entry/tags/3.4.5/lib/plugins/open_id_authentication/lib/open_id_authentication.rb#L112">http://www.redmine.org/projects/redmine/repository/entry/tags/3.4.5/lib/plugins/open_id_authentication/lib/open_id_authentication.rb#L112</a></p> Redmine - Patch #28943: Remove RDoc tagshttps://www.redmine.org/issues/28943?journal_id=854422018-06-07T01:08:37ZSho HASHIMOTO
<ul></ul><p>It is no problem for me! Thanks!</p> Redmine - Patch #28943: Remove RDoc tagshttps://www.redmine.org/issues/28943?journal_id=854432018-06-07T01:15:48ZGo MAEDA
<ul><li><strong>Subject</strong> changed from <i>Remove :nodoc:</i> to <i>Remove RDoc tags</i></li></ul> Redmine - Patch #28943: Remove RDoc tagshttps://www.redmine.org/issues/28943?journal_id=854622018-06-08T00:56:52ZGo MAEDA
<ul><li><strong>Status</strong> changed from <i>New</i> to <i>Closed</i></li><li><strong>Assignee</strong> set to <i>Go MAEDA</i></li><li><strong>Target version</strong> changed from <i>4.1.0</i> to <i>4.0.0</i></li></ul><p>Committed. Thanks.</p> Redmine - Patch #28943: Remove RDoc tagshttps://www.redmine.org/issues/28943?journal_id=854652018-06-08T02:23:19ZSho HASHIMOTO
<ul></ul><p>Thanks!!</p>