Patch #28996

Update Redmine::Plugin document

Added by Sho HASHIMOTO 12 days ago. Updated 6 days ago.

Status:NewStart date:
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:Documentation
Target version:-

Description

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.

update_redmine_plugin.patch Magnifier (12.3 KB) Sho HASHIMOTO, 2018-06-08 16:51

History

#1 Updated by Mizuki ISHIKAWA 6 days ago

+1
I think this is necessary information for plugin developers.

Also available in: Atom PDF