[kepler-dev] actor documentation not working

[Dan Higgins]

Hi Haiyan,
    In Ptolemy and the current release of Kepler, the 'documentation' 
item in the popup menu is supposed to display the JavaDoc for the actor. 
On my system (using the installer version), this works for 'older' 
Ptolemy actors, but not for newer actors created just for kepler. The 
problem (I think) is with the configuration of the JavaDoc for the 
Kepler actors (It is not in the right place or maybe hasn't been 
generated.) The suggestion to 'try running make' is a reminant of 
ptolemy and will NOT work for kepler.
    Until we get this fixed (and plans for more extensive documentation 
are under way), I suggest that you try the 'Look Inside' menu item. This 
should display the actual Java source code which should have some 
documentation in the form of comments.

Dan Higgins - NCEAS

Haiyan Yang wrote:

>Dear all,
>
>After I drag an actor into the canvas, I want to read the documentation by
>right clicking on the actor and choose the "documentation" item.  By it
>never worked and always gave me the error message:
>
>"Cannot find documentation for org.srb.SRBReader
>Try Running "make" in ptii/doc,
>or installing the documentation compponet."
>
>I tried Running "make" etc, but it didn't work either.  Error message looks
>as follows:
>
>
>making all in doc/coding
>make[1]: Entering directory
>`/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/codi ng'
>Nothing to be done in this directory
>make[1]: Leaving directory
>`/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/codin g'
>making all in doc/design
>make[1]: Entering directory
>`/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/desi gn'
>(cd ../..; "/usr/local/j2sdk1.4.2_01/bin/jar" -cvf doc/design/hyvisual.jar
>doc/d esign/hyvisual.pdf)
>/bin/sh: line 1: /usr/local/j2sdk1.4.2_01/bin/jar: No such file or directory
>make[1]: *** [hyvisual.jar] Error 127
>make[1]: Leaving directory
>`/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/desig n'
>making all in doc/img
>make[1]: Entering directory
>`/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/img'
>Nothing to be done in this directory
>make[1]: Leaving directory `/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/img'
>making all in doc/tour
>make[1]: Entering directory
>`/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/tour '
>Nothing to be done in this directory
>make[1]: Leaving directory
>`/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/tour'
>making all in doc/tutorial
>make[1]: Entering directory
>`/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/tuto rial'
>rm -f `basename TutorialApplet1.java .java`.class
>CLASSPATH="../..:/lib/diva.jar" "/usr/local/j2sdk1.4.2_01/bin/javac" -g -O
>Tutor ialApplet1.java
>/bin/sh: line 1: /usr/local/j2sdk1.4.2_01/bin/javac: No such file or directory
>make[1]: *** [TutorialApplet1.class] Error 127
>make[1]: Leaving directory
>`/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/tutor ial'
>making all in doc/ui
>make[1]: Entering directory `/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/ui'
>Nothing to be done in this directory
>make[1]: Leaving directory `/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/ui'
>making all in doc/doclets
>make[1]: Entering directory
>`/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/docl ets'
>rm -f `basename RatingTaglet.java .java`.class
>CLASSPATH="../..:/usr/local/j2sdk1.4.2_01/jre/../lib/tools.jar"
>"/usr/local/j2sd k1.4.2_01/bin/javac" -g -O RatingTaglet.java
>/bin/sh: line 1: /usr/local/j2sdk1.4.2_01/bin/javac: No such file or directory
>make[1]: *** [RatingTaglet.class] Error 127
>make[1]: Leaving directory
>`/home/haiyan/289F/Proj/CVSkepler/ptII4.0.1/doc/docle ts'
>make: *** [suball] Error 2
>
>
>
>How can I fix this problem?  Or if I can't, where can I find actor
>documentations?  Thanks.
>
>Haiyan
>
> 
>_______________________________________________
>kepler-dev mailing list
>kepler-dev at ecoinformatics.org
>http://www.ecoinformatics.org/mailman/listinfo/kepler-dev
>  
>


-- 
*******************************************************************
Dan Higgins                                  higgins at nceas.ucsb.edu
http://www.nceas.ucsb.edu/    Ph: 805-893-5127
National Center for Ecological Analysis and Synthesis (NCEAS) 
Marine Science Building - Room 3405
Santa Barbara, CA 93195
*******************************************************************