[kepler-dev] A documentation difficulty

[Matt Jones]

Hmmmm.  During the Davis meeting I thought we agreed that incorporating 
the docs into java code itself (as opposed to javadoc in the code) 
wasn't necessarily good.  At a minimum it takes us yet one step further 
away from the ability to localize the application using resource 
bundles, which is also somewhat problematic with the javadoc approach 
too.  Is there a way to localize javadocs in multiple languages?

Matt

Edward A. Lee wrote:
> 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  
> 
> _______________________________________________
> Kepler-dev mailing list
> Kepler-dev at ecoinformatics.org
> http://mercury.nceas.ucsb.edu/ecoinformatics/mailman/listinfo/kepler-dev

-- 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Matt Jones                                   Ph: 907-789-0496
jones at nceas.ucsb.edu                    SIP #: 1-747-626-7082
National Center for Ecological Analysis and Synthesis (NCEAS)
UC Santa Barbara     http://www.nceas.ucsb.edu/ecoinformatics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~