creating new tag and a subtask for ejb doclet
Where do I find information on adding a new tag in a java file(I am calling it ejb:hash-object). The same way ant has predefined ejbdoclet subtask like data-object/ I would like to use hash-object/ for converting the data objects in a hash map..which can then be sent over to the client. Later I will also need to make it include only those attributes which are specified by another tag for attributes I want to be included in the hash map...and so on :-) I have a elementary template for testing and have HashObjectSubTask...to implement the subtask I need. However to test it I should be able to include a new tag and then have a subtask in the ejbdoclet task. Please let me know where to get more info on this. Thanks. -manish
Re: javadoc with custom doclet probs.
http://nagoya.apache.org/bugzilla/show_bug.cgi?id=6433 You are not alone 8-) Stefan -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
RE: javadoc with custom doclet probs.
I guess I'd better fix it then ;-) -Original Message- From: Stefan Bodewig To: [EMAIL PROTECTED] Sent: 2/19/02 2:29 PM Subject: Re: javadoc with custom doclet probs. http://nagoya.apache.org/bugzilla/show_bug.cgi?id=6433 You are not alone 8-) Stefan -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED] -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
Re: javadoc with custom doclet probs.
On Tue, 19 Feb 2002, Les Hughes [EMAIL PROTECTED] wrote: I guess I'd better fix it then ;-) That would be the best option, of course. * make javadoc a real directory based task is around number 25 on my TODO list, I bet you can beat me to it. 8-) Stefan -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
RE: javadoc with custom doclet probs.
Race you - I'm on it right now! -Original Message- From: Stefan Bodewig To: [EMAIL PROTECTED] Sent: 2/19/02 2:51 PM Subject: Re: javadoc with custom doclet probs. On Tue, 19 Feb 2002, Les Hughes [EMAIL PROTECTED] wrote: I guess I'd better fix it then ;-) That would be the best option, of course. * make javadoc a real directory based task is around number 25 on my TODO list, I bet you can beat me to it. 8-) Stefan -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED] -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
Doclet ?
Hello,
Can you send me an example of javadoc task that use a specific doclet.
I have made sevral tries but Ant always tell me that there is a bad
option -d :
[javadoc] Generating Javadoc
[javadoc] Javadoc execution
[javadoc] javadoc: invalid flag: -d
[javadoc] usage: javadoc [options] [packagenames] [sourcefiles]
[classnames] [@files]
[javadoc] -overview file Read overview documentation from
HTML file
[javadoc] -public Show only public classes and members
[javadoc] -protectedShow protected/public classes and
members (default)
[javadoc] -package Show package/protected/public
classes and members
[javadoc] -private Show all classes and members
[javadoc] -help Display command line options
[javadoc] -doclet class Generate output via alternate doclet
[javadoc] -docletpath pathSpecify where to find doclet class
files
[javadoc] -1.1 Generate output using JDK 1.1
emulating doclet
[javadoc] -sourcepath pathlistSpecify where to find source files
[javadoc] -classpath pathlist Specify where to find user class files
[javadoc] -bootclasspath pathlist Override location of class files
loaded
[javadoc] by the bootstrap class loader
[javadoc] -extdirs dirlistOverride location of installed
extensions
[javadoc] -verbose Output messages about what Javadoc
is doing
[javadoc] -locale nameLocale to be used, e.g. en_US or
en_US_WIN
[javadoc] -encoding name Source file encoding name
[javadoc] -Jflag Pass flag directly to the
runtime system
[javadoc]
[javadoc] 1 error
here is my target :
target name=Generation de la documentation
touch
file=${rep.livraison}/${nom.rep.documentation}/package-list/
javadoc
packageList=${rep.livraison}/${nom.rep.documentation}/package-list
packagenames=${env.PAQUETAGE}.*
sourcepath=${rep.livraison}/${nom.rep.src}
destdir=${rep.livraison}/${nom.rep.documentation}
classpathref=path.wt.doc
windowtitle=Documentation des Classes amp; APIs de la
customisation Windchill
doctitle=lt;h1gt;Documentation de ${env.PROJET}
${env.VERSION}lt;/h1gt;lt;BRgt;lt;IMG SRC=logo.jpggt;lt;Pgt;
bottom=${copyright}
doclet name=RTFDoclet
path=${rep.livraison}/RTFDoclet/RTFDoclet.jar
param name=-filename
value=${rep.livraison}/Documentation.rtf/
/doclet
group title=Paquetage de l'application ${env.PROJET}
packages=${env.PAQUETAGE}/
group title=Sous-paquetages de ${env.PROJET}
packages=${env.PAQUETAGE}.*/
link offline=true
href=file:\\${env.ANT_HOME}\build\javadocs
packagelistLoc=${env.ANT_HOME}\build\javadocs /
link offline=true href=${nom.rep.wtdoc}
packagelistLoc=${rep.codes}\wt\clients\library\api/
link offline=true href=${nom.rep.javadoc}
packagelistLoc=${java.home}\docs\api /
/javadoc
/target
Thank you very much...
Cyriaque,
--
Cyriaque Dupoirieux mailto:[EMAIL PROTECTED]
PCO Technologies
Burolines - 2 ter rue Marcel Doret
31700 Blagnac
Tél : 05.34.60.44.13 - Fax : 05.34.60.44.10
Re: Doclet ?
On Wed, 05 Dec 2001, Cyriaque Dupoirieux [EMAIL PROTECTED] wrote: I have made sevral tries but Ant always tell me that there is a bad option -d : remove the destdir attribute from your javadoc task and Ant will not try to pass on the -d switch. Stefan -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
Re: Doclet ?
Stefan Bodewig wrote: On Wed, 05 Dec 2001, Cyriaque Dupoirieux [EMAIL PROTECTED] wrote: I have made sevral tries but Ant always tell me that there is a bad option -d : remove the destdir attribute from your javadoc task and Ant will not try to pass on the -d switch. And if I remove the destdir, where will Ant generate my documentation ??? - Stefan -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED] -- Cyriaque Dupoirieux mailto:[EMAIL PROTECTED] PCO Technologies Burolines - 2 ter rue Marcel Doret 31700 Blagnac Tél : 05.34.60.44.13 - Fax : 05.34.60.44.10
Re: Doclet ?
On Wed, 05 Dec 2001, Cyriaque Dupoirieux [EMAIL PROTECTED] wrote: And if I remove the destdir, where will Ant generate my documentation ??? Whatever you tell your doclet. If your doclet doesn't support the -d switch, it must have some other means to specify that, use the additionalparam attribute for that. Stefan -- To unsubscribe, e-mail: mailto:[EMAIL PROTECTED] For additional commands, e-mail: mailto:[EMAIL PROTECTED]
Re: doclet extension
msew wrote: Does anyone out there have a link to a good tutorial or even just example files of how to easily extend the standard doclet? To the best of my knowledge, extending the standard doclet isn't that easy. Admittedly, I looked at it about two years ago, so they may have refactored it. The biggest problem though isn't the organization of the doclet (although that was an absolute mess), its the fact that you (effectively) never instantiate your doclet - all the methods the javadoc utility calls have to be static. Thus, how do you inherit from the standard doclet to change its capabilities? The standard answer used to be duplicate the code and then change what you want. Not having checked out the standard doclet in a long time, thats going to have to be my answer too. ie you have a @tag and you just want to easily use it in your every day javadocing :-) You think they would have made that easy, wouldn't you. :-) Glenn McAllister SOMA Networks, Inc.
RE: doclet extension
Title: RE: doclet extension If you want to create EJB's look at EJBdoclet. It's open source and is integrated with ANT. -Original Message- From: Glenn McAllister [mailto:[EMAIL PROTECTED]] Sent: Tuesday, July 03, 2001 10:03 AM To: [EMAIL PROTECTED] Subject: Re: doclet extension msew wrote: Does anyone out there have a link to a good tutorial or even just example files of how to easily extend the standard doclet? To the best of my knowledge, extending the standard doclet isn't that easy. Admittedly, I looked at it about two years ago, so they may have refactored it. The biggest problem though isn't the organization of the doclet (although that was an absolute mess), its the fact that you (effectively) never instantiate your doclet - all the methods the javadoc utility calls have to be static. Thus, how do you inherit from the standard doclet to change its capabilities? The standard answer used to be duplicate the code and then change what you want. Not having checked out the standard doclet in a long time, thats going to have to be my answer too. ie you have a @tag and you just want to easily use it in your every day javadocing :-) You think they would have made that easy, wouldn't you. :-) Glenn McAllister SOMA Networks, Inc.
javadoc with custom doclet (extension of ejbdoclet) and classpath (docletpath?)
Hi,
Using ant1.3, linux.
[lengthy post - thanks in advance for reading...]
I've rewritten the ejbdoclet.jar
(http://www.sourceforge.net/projects/ejbdoclet) so that I can extend it and
not have to rebuild the jar for each different extension. What this means is
that I have my doclet in its own jar, which extends another doclet, which is
in another jar.
javadoc -d ejbdoclet/ -doclet com.nuix.util.ejbdoclet.NuixDoclet
bdogen/com/nuix/bdo/AccountEJB.java
This works fine at command line provided I have set my classpath. I
understand that the -classpath flag is part of the standard doclet, and so
doesn't work when you use a custom doclet. What I want to do is build this
using ant. I've tried numerous variations of the build script, the most sane
being
javadoc packagenames="${nuix.packagenames}"
sourcepath
pathelement path="${java.dir}"/
pathelement path="${ejbdoclet.dir}"/
pathelement path="${bdogen.dir}"/
/sourcepath
classpath id="classpath"
fileset dir="${lib.dir}"
include name="**/*.jar"/
/fileset
/classpath
doclet name="com.nuix.util.ejbdoclet.NuixDoclet"
path="${lib.dir}/nuixdoclet.jar,${lib.dir}/ejbdoclet.jar"
param name="-name" value="Extreme Transaction Platform" /
param name="-d" value="${ejbdoclet.dir}" /
/doclet
/javadoc
The key line being the doclet path... I've tried to specify both jars there,
but it appears to be not picking them up:
javadoc: Cannot find doclet class com.nuix.util.ejbdoclet.NuixDoclet
1 error
Now the two jar files are:
[dim@host63 lib]$ jar -tf ejbdoclet.jar
META-INF/
META-INF/MANIFEST.MF
ejbdoclet/
ejbdoclet/EJBDoclet.class
ejbdoclet/TemplateDoclet.class
ejbdoclet/JBossDoclet.class
ejbdoclet/entitybmp.j
ejbdoclet/dataobject.j
ejbdoclet/entitypk.j
ejbdoclet/remote.j
ejbdoclet/entitycmp.j
ejbdoclet/home.j
[dim@host63 lib]$ jar -tf nuixdoclet.jar
META-INF/
META-INF/MANIFEST.MF
com/
com/nuix/
com/nuix/util/
com/nuix/util/ejbdoclet/
ejbdoclet/
com/nuix/util/ejbdoclet/NuixDoclet.class
ejbdoclet/nuixcmp.j
The only way I have been able to make this work is to have one jar, and place
everything in the one file. This works fine, apart from the fact that it is
exactly what I'm trying to avoid.
My question then: has anyone else been able to make something like this work?
- setting a classpath for the javadoc, using a custom doclet. In the docs,
there are docletpath and docletpathref attributes documented, but when I try
to use them with doclet I get error messages
cheers, and tia for any suggestions.
dim.
Re: javadoc with custom doclet (extension of ejbdoclet) and classpath (docletpath?)
Conor,
Thanks - yep that fixed. A little too obvious really (o: ta.
cheers
dim
On Mon, 9 Apr 2001 11:56, you wrote:
Dmitri,
Since the docletpath is a path, you need to use a path separator. Try this
path="${lib.dir}/nuixdoclet.jar:${lib.dir}/ejbdoclet.jar"
We could perhaps introduce a nested path element for the doclet but the
above should work for you for now.
If that doesn't work, please run ant with the -debug flag and let us know
what is the generated javadoc command line.
Conor
-Original Message-
From: Dmitri Colebatch [mailto:[EMAIL PROTECTED]]
Sent: Monday, 9 April 2001 11:53 AM
To: [EMAIL PROTECTED]
Subject: javadoc with custom doclet (extension of ejbdoclet) and
classpath (docletpath?)
Hi,
Using ant1.3, linux.
[lengthy post - thanks in advance for reading...]
I've rewritten the ejbdoclet.jar
(http://www.sourceforge.net/projects/ejbdoclet) so that I can
extend it and
not have to rebuild the jar for each different extension. What
this means is
that I have my doclet in its own jar, which extends another
doclet, which is
in another jar.
javadoc -d ejbdoclet/ -doclet com.nuix.util.ejbdoclet.NuixDoclet
bdogen/com/nuix/bdo/AccountEJB.java
This works fine at command line provided I have set my classpath. I
understand that the -classpath flag is part of the standard
doclet, and so
doesn't work when you use a custom doclet. What I want to do is
build this
using ant. I've tried numerous variations of the build script,
the most sane
being
javadoc packagenames="${nuix.packagenames}"
sourcepath
pathelement path="${java.dir}"/
pathelement path="${ejbdoclet.dir}"/
pathelement path="${bdogen.dir}"/
/sourcepath
classpath id="classpath"
fileset dir="${lib.dir}"
include name="**/*.jar"/
/fileset
/classpath
doclet name="com.nuix.util.ejbdoclet.NuixDoclet"
path="${lib.dir}/nuixdoclet.jar,${lib.dir}/ejbdoclet.jar"
param name="-name" value="Extreme Transaction Platform" /
param name="-d" value="${ejbdoclet.dir}" /
/doclet
/javadoc
The key line being the doclet path... I've tried to specify both
jars there,
but it appears to be not picking them up:
javadoc: Cannot find doclet class com.nuix.util.ejbdoclet.NuixDoclet
1 error
Now the two jar files are:
[dim@host63 lib]$ jar -tf ejbdoclet.jar
META-INF/
META-INF/MANIFEST.MF
ejbdoclet/
ejbdoclet/EJBDoclet.class
ejbdoclet/TemplateDoclet.class
ejbdoclet/JBossDoclet.class
ejbdoclet/entitybmp.j
ejbdoclet/dataobject.j
ejbdoclet/entitypk.j
ejbdoclet/remote.j
ejbdoclet/entitycmp.j
ejbdoclet/home.j
[dim@host63 lib]$ jar -tf nuixdoclet.jar
META-INF/
META-INF/MANIFEST.MF
com/
com/nuix/
com/nuix/util/
com/nuix/util/ejbdoclet/
ejbdoclet/
com/nuix/util/ejbdoclet/NuixDoclet.class
ejbdoclet/nuixcmp.j
The only way I have been able to make this work is to have one
jar, and place
everything in the one file. This works fine, apart from the fact
that it is
exactly what I'm trying to avoid.
My question then: has anyone else been able to make something
like this work?
- setting a classpath for the javadoc, using a custom doclet.
In the docs,
there are docletpath and docletpathref attributes documented, but
when I try
to use them with doclet I get error messages
cheers, and tia for any suggestions.
dim.
