https://www.redmine.org/https://www.redmine.org/favicon.ico?16793021292018-06-14T02:21:16ZRedmineRedmine - Patch #28996: Update Redmine::Plugin documentationhttps://www.redmine.org/issues/28996?journal_id=855402018-06-14T02:21:16ZMizuki ISHIKAWA
<ul></ul><p>+1<br />I think this is necessary information for plugin developers.</p> Redmine - Patch #28996: Update Redmine::Plugin documentationhttps://www.redmine.org/issues/28996?journal_id=861312018-07-09T06:02:02ZGo MAEDA
<ul><li><strong>Assignee</strong> set to <i>Jean-Philippe Lang</i></li><li><strong>Target version</strong> set to <i>4.0.0</i></li></ul><p>I think the comment suggested by Sho is useful. However, I wonder if we can continuously update the comments in the future versions.</p>
<p>I would like Jean-Philippe to decide whether we can commit this change.</p> Redmine - Patch #28996: Update Redmine::Plugin documentationhttps://www.redmine.org/issues/28996?journal_id=862152018-07-16T01:46:19ZSho HASHIMOTO
<ul></ul><p>Please remove <a class="user active" href="https://www.redmine.org/users/393941">Marc Since</a> tags from patch if it is difficult to maintain version info. I'll publish unofficial document.</p> Redmine - Patch #28996: Update Redmine::Plugin documentationhttps://www.redmine.org/issues/28996?journal_id=875692018-09-25T12:29:09ZSho HASHIMOTO
<ul></ul><blockquote>
<p>I'll publish unofficial document.</p>
</blockquote>
<p>Like below. This is auto generated table by using yard diff version1 version2 under redmine repository.</p>
<ul>
<li><a class="external" href="https://gist.github.com/sho-h/15553f13b36e4acbd961086ced2f0a38">https://gist.github.com/sho-h/15553f13b36e4acbd961086ced2f0a38</a></li>
</ul> Redmine - Patch #28996: Update Redmine::Plugin documentationhttps://www.redmine.org/issues/28996?journal_id=886142018-11-29T17:20:05ZJean-Philippe Langjp_lang@yahoo.fr
<ul><li><strong>Subject</strong> changed from <i>Update Redmine::Plugin document</i> to <i>Update Redmine::Plugin documentation</i></li><li><strong>Status</strong> changed from <i>New</i> to <i>Closed</i></li></ul><p>It's perfectly right to improve the documentation. I've committed the proposed additions with slight changes, thanks. But the yard tags are not used anywhere in the code, it doesn't sound so good to me to introduce them in a single class.</p> Redmine - Patch #28996: Update Redmine::Plugin documentationhttps://www.redmine.org/issues/28996?journal_id=887832018-12-06T04:25:04ZSho HASHIMOTO
<ul></ul><p>Thanks to merge documentation!!</p>
<blockquote>
<p>But the yard tags are not used anywhere in the code, it doesn't sound so good to me to introduce them in a single class.</p>
</blockquote>
<p>No. Redmine already has yard tags.</p>
<ul>
<li>Gemfile: <a class="external" href="https://github.com/redmine/redmine/blob/3.4.6/Gemfile#L89-L92">https://github.com/redmine/redmine/blob/3.4.6/Gemfile#L89-L92</a></li>
<li>application_helper.rb: <a class="external" href="https://github.com/redmine/redmine/blob/3.4.6/app/helpers/application_helper.rb#L43-L46">https://github.com/redmine/redmine/blob/3.4.6/app/helpers/application_helper.rb#L43-L46</a></li>
</ul>
<p>application_helper.rb has yardoc tag because rdoc has no @<tagname>. See below.</p>
<ul>
<li><a class="external" href="https://github.com/ruby/rdoc/blob/master/ExampleRDoc.rdoc">https://github.com/ruby/rdoc/blob/master/ExampleRDoc.rdoc</a></li>
</ul>