Question on javadoc generation?

Hi,

I am sorry for posting my question there, but i am sure that most of us is developing applications using JCOP tools (or without that plug-in) and then come to the API javadoc generation.

The problem is, that i am trying to generate my on-card package Javadoc. Everything is fine, but it doesn't find eclipse javadoc for jc221, even when i generate javadoc like that:

C:\Documents and Settings\Ieva\workspace>javadoc -link file://c:/eclipse3.1.2/eclipse/plugins/com.ibm.bluez.jcop.eclipse_3.1.2/guide/reference/jdocs/jc221 jcpackage -d docs

It replies, that it doesn't find javacard.framework package. So I have no links to the Applet and other classes options in my javadoc.

Could anyone please help me?

Best regards,

Eve

[807 byte] By [Ievaa] at [2007-11-27 11:12:54]
# 1

Anyone?

Ievaa at 2007-7-29 13:57:33 > top of Java-index,Java Mobility Forums,Consumer and Commerce...
# 2

I do not know why command line javadoc tool does not include the jc221 documentation. I always use Eclipse to generate the documentation (Project... --> Generate JavaDoc...).

lexdabeara at 2007-7-29 13:57:33 > top of Java-index,Java Mobility Forums,Consumer and Commerce...
# 3

Hi,

Thanks a lot lexdabear for your help! Yes i am using the same Project options in Eclipse as you do.

The problem is that javadoc seems to find only Objest class of java.lang package in JCOP tools, because it generated links to the Object class. But all the classes from javacard.framework

haven't been linked.

Could you please try to generate javadoc for any of the java card applets (e.g. a simple HelloWorld applet), which would use link to the JC2.2.1 documentation, please? May be i am using a wrong path in the link option (but i read that for all OS slash must be "/" I am building javadoc on Windows)? If you could do that, may be you could post all the options (i.e. -link

or -linkoffline

) that you used to make a successful javadoc generation?

Another question would be: I am using 1.4.JRE. May be JCOP tools documnetation had been vuild using newer JRE? Are there any differences between different versions of documentation?

Thanks a lot!

Best regards,

Eve

Message was edited by:

Ieva

Ievaa at 2007-7-29 13:57:33 > top of Java-index,Java Mobility Forums,Consumer and Commerce...
# 4

I cannot include the external javadoc JCOP on-card API neither. Hopefully they can help you in the javadoc tool forum.

lexdabeara at 2007-7-29 13:57:33 > top of Java-index,Java Mobility Forums,Consumer and Commerce...
# 5

so, you mean you've got the same result using -link option? I have already posted tis problem in javaoc forum, but that forum seems to be not very lively.

But in case you try to include external javadoc for jre 1.4 API (using http:) everything works fine. Try -link http://java.sun.com/j2se/1.4.2/docs/api/.

Does it work? For me it does.

May be there is some problem with file: and http:?

Do you know any online URL, where i can find jc 2.2.1 api specification?

Thanks for a help.

Best regards,

Eve

Ievaa at 2007-7-29 13:57:33 > top of Java-index,Java Mobility Forums,Consumer and Commerce...
# 6

The JC 2.2.1 API spec is included in the 2.2.1 development kit. Just grab that, unzip the API and address it locally. If you need to use an URL, use file://...

Lillesanda at 2007-7-29 13:57:33 > top of Java-index,Java Mobility Forums,Consumer and Commerce...
# 7

@Lillesand

I tried to do that.

Did you manage to generate javadoc that references this API yourself?

If yes, please, post the options of link or link offline that you have used.

Thanks,

Best regards,

eve

Ievaa at 2007-7-29 13:57:33 > top of Java-index,Java Mobility Forums,Consumer and Commerce...
# 8

@Lillesand

did javadoc work out for you?

Ievaa at 2007-7-29 13:57:33 > top of Java-index,Java Mobility Forums,Consumer and Commerce...
# 9

Hi leva,

You could try to generate javadoc pages by using small Ant script (build.xml):

<project name="foo">

<target name="build-javadoc">

<javadoc

sourcepath="./src"

destdir="./doc"

packagenames="com.foo.hellojcop">

<!-- This is the trick -->

<classpath>

<pathelement location="<your-jcop-plugin-path>\apis\jc221\jc221.jar"/>

</classpath>

</javadoc>

</target>

</project>

Hope this helps

paulizista at 2007-7-29 13:57:33 > top of Java-index,Java Mobility Forums,Consumer and Commerce...