Project

General

Profile

Bug #2390

Documentation problem with derived actors

Added by Dan Higgins about 13 years ago. Updated over 11 years ago.

Status:
Resolved
Priority:
Normal
Category:
documentation
Target version:
Start date:
03/23/2006
Due date:
% Done:

0%

Estimated time:
Bugzilla-Id:
2390

Description

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.

History

#1 Updated by Chad Berkley over 11 years ago

documentation is now always defined for ports in the moml whether it's a java port or not.

#2 Updated by Redmine Admin about 6 years ago

Original Bugzilla ID was 2390

Also available in: Atom PDF