[kepler-dev] A documentation difficulty

Dan Higgins higgins at nceas.ucsb.edu
Thu Mar 23 16:20:42 PST 2006


HI All,
JUST A NOTE OF INTEREST:

There is a problem that comes up when trying to document certain actors 
that extend other actor classes like Source, Sink, or Transform. These 
examples define ports called "input", "output", or both. It is useful to 
build new actors by extending these base actor, but when one does so, 
the inherited ports do not appear in the new class source files. Since 
they do not appear, a more specialized use cannot be documented in 
JavaDoc comments in the new actor extending these more basic actors.

One can, of course, get around this by extending TypedAtomicActor and 
defining all ports of interest.

Dan Higgins
NCEAS



More information about the Kepler-dev mailing list