[kepler-dev] A documentation difficulty

[Edward A. Lee]

Actually, I'm pretty sure there is a workaround here...
We should make it easier to do this, but something like the
following should work in the constructor of the actor
extending, say, Source:

    DocAttribute doc = new DocAttribute(this, "doc");
    StringAttribute portDescription = new StringAttribute(doc, 
"output (port)");
    portDescription.setExpression("This port produces ... blah blah");

I would suggest that we add syntactic sugar to DocAttribute to make
it easier to do this...

Edward

At 04:20 PM 3/23/2006, Dan Higgins wrote:
>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
>
>_______________________________________________
>Kepler-dev mailing list
>Kepler-dev at ecoinformatics.org
>http://mercury.nceas.ucsb.edu/ecoinformatics/mailman/listinfo/kepler-dev

------------
Edward A. Lee
Professor, Chair of the EE Division, Associate Chair of EECS
231 Cory Hall, UC Berkeley, Berkeley, CA 94720
phone: 510-642-0253 or 510-642-0455, fax: 510-642-2845
eal at eecs.Berkeley.EDU, http://ptolemy.eecs.berkeley.edu/~eal