Ticket #32 (closed feature: moved)
Opened 2010-02-19T15:55:45-06:00
Last modified 2012-03-05T14:39:08-06:00
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
Change History
Changed 2010-02-19T15:56:09-06:00 by curtis
- attachment bf-importer.png added
comment:4 Changed 2014-05-01T06:09:18-05:00 by curtis
- Status changed from new to closed
- Resolution set to moved
Inline documentation for the Bio-Formats Importer plugin