Vote #79364
完了Update Redmine::Plugin documentation
0%
説明
I want to more information to Redmine methods for plugin development.
As a trial, I created a patch to add below information to Redmine::Plugin.
- Add @since to each Redmine::Plugin methods
- Add reference to Plugin_Tutorial wiki and Redmine::Plugin#requires_redmine
- Add description to a few methods
I checked @since info with using yard diff(the result pasted below).
I will create patches to add @since information to Redmine methods after this tickets was closed.
journals
+1
I think this is necessary information for plugin developers.
--------------------------------------------------------------------------------
I think the comment suggested by Sho is useful. However, I wonder if we can continuously update the comments in the future versions.
I would like Jean-Philippe to decide whether we can commit this change.
--------------------------------------------------------------------------------
Please remove @since tags from patch if it is difficult to maintain version info. I'll publish unofficial document.
--------------------------------------------------------------------------------
> I'll publish unofficial document.
Like below. This is auto generated table by using yard diff version1 version2 under redmine repository.
* https://gist.github.com/sho-h/15553f13b36e4acbd961086ced2f0a38
--------------------------------------------------------------------------------
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.
--------------------------------------------------------------------------------
Thanks to merge documentation!!
> 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.
No. Redmine already has yard tags.
* Gemfile: https://github.com/redmine/redmine/blob/3.4.6/Gemfile#L89-L92
* application_helper.rb: https://github.com/redmine/redmine/blob/3.4.6/app/helpers/application_helper.rb#L43-L46
application_helper.rb has yardoc tag because rdoc has no @<tagname>. See below.
* https://github.com/ruby/rdoc/blob/master/ExampleRDoc.rdoc
--------------------------------------------------------------------------------