ant-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Conor MacNeill" <co...@m64.com>
Subject RE: problems specifing a javadoc doclet
Date Tue, 03 Oct 2000 13:12:28 GMT
Paul,

The fact that destdir was mandatory has been removed from the javadoc task
after release 1.1. I would suggest you try a recent nightly build of ant.

Also, although it is not currently documented, it is possible to use doclets
with a nested element syntax which seems clearer to me.

<javadoc ...>
   <doclet name="blah"
           path="path/to/blah">
      <param name="-foo" value="blah"/>
      <param name="-bar" value="blahblah"/>
   </doclet>
</javadoc>

I'll try to add that to the documentation in the near future.

Conor


> -----Original Message-----
> From: Paul Arzul [mailto:patricka@exinet.co.za]
> Sent: Tuesday, 3 October 2000 19:25
> To: ant-user@jakarta.apache.org
> Subject: Re: problems specifing a javadoc doclet
>
>
> On Mon, 2 Oct 2000, Glenn McAllister wrote:
>
> : The problem you are running into is that the destdir attribute
> translates
> : to the -d javadoc command line options.  Unfortunately, -d is _standard
> : doclet specific_, not common to javadoc itself.  In all
> likelyhood (having
> : never used JavaDox) they have a different flag for the output directory.
> : If the doclet wasn't being found you would see that error before the -d
> : problem.
> :
> : Could you show us your command line that works?
>
> sure thing:
>
> ---8<---
> /jdk1.2.2/bin/javadoc -docletpath jdox/javadox.jar -doclet
> com.componentregistry.javadox.JavaDox -sourcepath . @filelist.txt
> --->8---
>
> from the documentation[1]:
> ---8<---
> It will generate a file... in the current directory.
> --->8---
>
> as i understand it then, it is the unsupported destdir
> attribute of the _doclet_ that's fubar-ing it. you say that
> -d is standard doclet specific. the documentation[2] does
> say it's optional though:
>
> ---8<---
> Options Provided by the Standard Doclet
>
> -d  directory
>
> Specifies the destination directory where javadoc saves the
> generated HTML files. (The "d" means
> "destination.") _Omitting_ this option causes the files to
> be saved to the _current directory_.
> --->8---
>
> if destdir wasn't mandatory, i think i wouldn't be having
> this problem.
>
> any workarounds, or should i patch the doclet?
>
> - p
>
> [1] http://www.componentregistry.com/jdox/entrypage.jsp
> [2]
> http://java.sun.com/products/jdk/1.2/docs/tooldocs/win32/javadoc.h
> tml#standard
>
> * * *
>
> : i cannot get javadoc doclets to work with ant
> : 1.1. variations on the sample below all produce a javadoc
> : invalid flag -d error. from the command line (outside ant),
> : it works dandy.
> :
> : sample project:
> :
> : ---8<---
> : <?xml version="1.0"?>
> :
> : <project name="Doclet Test" default="jdox" basedir=".">
> :
> :   <target name="jdox">
> :     <javadoc
> :       sourcepath="."
> :       destdir="."
> :       packagenames="*"
> :       doclet="com.componentregistry.javadox.JavaDox"
> :       docletpath="javadox.jar"
> :       failonerror="yes" />
> :   </target>
> :
> : </project>
> : --->8---
> :
> :
> : typical error:
> :
> : ---8<---
> : Buildfile: test.xml
> :
> : jdox:
> :   [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] -protected                Show 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 <path>        Specify where to find doclet class
> : files
> :   [javadoc] -1.1                      Generate output using JDK 1.1
> : emulating doclet
> :   [javadoc] -sourcepath <pathlist>    Specify 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 <dirlist>        Override location of installed
> : extensions
> :   [javadoc] -verbose                  Output messages about
> what Javadoc is
> : doing
> :   [javadoc] -locale <name>            Locale to be used, e.g. en_US or
> : en_US_WIN
> :   [javadoc] -encoding <name>          Source file encoding name
> :   [javadoc] -J<flag>                  Pass <flag> directly to
> the runtime
> : system
> :   [javadoc]
> :   [javadoc] 1 error
> :
> : BUILD FAILED
> :
> : test.xml:12: Exec returned: 1
> :
> : Total time: 6 seconds
> : --->8---
> :
> : suggestions appreciated,
> : tia,
> :
> : - p
>
>


Mime
View raw message