[kepler-dev] [Bug 2390] New: - Documentation problem with derived actors

[bugzilla-daemon@ecoinformatics.org]

http://bugzilla.ecoinformatics.org/show_bug.cgi?id=2390

           Summary: Documentation problem with derived actors
           Product: Kepler
           Version: 1.0.0beta2
          Platform: Other
        OS/Version: other
            Status: NEW
          Severity: minor
          Priority: P2
         Component: documentation
        AssignedTo: altintas at sdsc.edu
        ReportedBy: higgins at nceas.ucsb.edu
         QAContact: kepler-dev at ecoinformatics.org


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.