Re: an interface to encourage self-documentation of plug-ins

Posted by Prodanov Dimiter on Apr 27, 2009; 11:38am
URL: http://imagej.273.s1.nabble.com/an-interface-to-encourage-self-documentation-of-plug-ins-tp3692779p3692781.html

It will be nice if Wayne reaches understanding about the importance of help/documentation.

I see some glitches in the presented idea. In all my years with ImageJ I haven't used showAbout. Because there is no way to get interactive help from a plugin and showAbout does not substitute for it.

What we absolutely need is a consistent help/doc pattern. The format is not so important at the moment.

Obviously there can be place for some diversity like TXT/JAVADOC/HTML or PDF/PS.

If the resources are stored somewhere in the IJ folder tree that can be easy. Another idea is to place them in the src_jar or make a special doc_jar.

So If we insist on developing such a system then an interface coupled with some standard handling methods on the level of IJ will be fine.

Best regards,

Dimiter