Ticket #32 (closed feature: moved)

Opened 9 years ago

Last modified 7 years ago

Plugin self-documentation mechanism

Reported by: curtis Owned by: curtis
Priority: major Milestone: imagej-2.0.0
Component: Plugin Framework Version:
Severity: non-issue Keywords:
Cc: Blocked By:
Blocking: #1053

Description

To complement an improved plugins infrastructure, it would be nice to have a way for plugin authors to document what their plugin does from an end-user perspective, including the meaning of various parameters.

The idea would be to use Java annotations, Javadoc or something similar, possibly embedded in the source code itself, or possibly in a standard format in some external text file, to document the plugin.

We have attempted this sort of documentation informally with the  Bio-Formats Importer plugin (see attachment) but it would be better to have an official, more structured solution, encouraging plugin authors to document plugin parameters and features by making it very easy to do so.

Attachments

bf-importer.png Download (88.3 KB) - added by curtis 9 years ago.
Inline documentation for the Bio-Formats Importer plugin

Change History

Changed 9 years ago by curtis

Inline documentation for the Bio-Formats Importer plugin

comment:1 Changed 7 years ago by curtis

  • Type changed from task to feature

comment:2 Changed 7 years ago by curtis

  • Blocking 11 added

comment:3 Changed 7 years ago by curtis

  • Blocking 1053 added; 11 removed

comment:4 Changed 5 years ago by curtis

  • Status changed from new to closed
  • Resolution set to moved
Note: See TracTickets for help on using tickets.