Patch #28996

Update Redmine::Plugin documentation

Added by Sho HASHIMOTO 6 months ago. Updated 4 days ago.

Status:ClosedStart date:
Priority:NormalDue date:
Assignee:Jean-Philippe Lang% Done:

0%

Category:Documentation
Target version:4.0.0

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

Associated revisions

Revision 17661
Added by Jean-Philippe Lang 11 days ago

Update Redmine::Plugin documentation (#28996).

History

#1 Updated by Mizuki ISHIKAWA 6 months ago

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

#2 Updated by Go MAEDA 5 months ago

  • Assignee set to Jean-Philippe Lang
  • Target version set to 4.0.0

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.

#3 Updated by Sho HASHIMOTO 5 months ago

Please remove @since tags from patch if it is difficult to maintain version info. I'll publish unofficial document.

#4 Updated by Sho HASHIMOTO 3 months ago

I'll publish unofficial document.

Like below. This is auto generated table by using yard diff version1 version2 under redmine repository.

#5 Updated by Jean-Philippe Lang 11 days ago

  • Subject changed from Update Redmine::Plugin document to Update Redmine::Plugin documentation
  • Status changed from New to Closed

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.

#6 Updated by Sho HASHIMOTO 4 days ago

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.

application_helper.rb has yardoc tag because rdoc has no @<tagname>. See below.

Also available in: Atom PDF