Re: [Xdoclet-user] The most basic example

[Erik Hatcher]

Well, you got me there, I suppose. :)

What that meant was (and this is mentioned earlier in Chapter 11) that
xjavadoc is replacing the dependency XDoclet 1.1.2 had on
Ant's <javadoc> task which uses Sun's javadoc command-line tool under
the covers. It used javadoc with a custom doclet to gather the data
from the source code parsing, and now it uses xjavadoc to accomplish
that same goal. It doesn't replace it in terms of actually generating HTML documentation.

I apologize for the confusion my quote caused.

XDoclet is fully capable of generating this type of documentation - it would require some custom templates and a subtask (maybe a tag handler too, but probably not) to be developed and would likely take a bit of time to get it just right, although it wouldn't take too much time to get close.

My recommendation based on what I see you want:
Using the <template> subtask you could write a custom template that would generate an XML file with all of the information you want to document for your customers (class comments, public method signatures, public method comments, etc). Then use that XML file to transform into documentation to deliver to your customers.

Erik


Dustin Hunter wrote:
> Erik,
>
> Thanks for the information. However, I believe it was in you book
> that I read "XJavaDoc is designed to be a replacement for Sun's
> javadoc command-line tool". I may have taken that too far in assuming
> that the output would be similiar. But I do not require the output to
> be in HTML by any means.
>
> - Dustin
>
> -----Original Message----- From: Erik Hatcher
> [mailto:[EMAIL PROTECTED]] Sent: Friday, December 13, 2002
> 3:57 PM To: Dustin Hunter Cc: [EMAIL PROTECTED]
> Subject: Re: [Xdoclet-user] The most basic example
>
>
> XDoclet is not a replacement for Javadoc. It (currently, nor is in
> the plans that I know of) does not generate Javadoc-like output. If
> you were so inclined, that could be built though.
>
> The example you provided below is not telling XDoclet to do anything.
> You must use a sub-task within the <xdoclet> tags for it to actually
> generate something. I encourage you to research XDoclet's
> capabilities a bit more so you get a better feel for what its all
> about - and generating Javadoc HTML output is *not* of of the zillion
> things XDoclet is good for :)
>
> Erik
>
>
> Dustin Hunter wrote:
>
>> I am attempting to get xdoclets up and running to replace our
>> javadocs. We add @customer tags to all public api classes that
>> should be made available to our customers. I need a doclet that
>> generates just the docs for these classes.
>>
>> So as a first step I want to use the xdoclets to generate javadocs
>> with no fancy business. The following lines do not have any errors,
>> but also do not generate a single doc file. What's wrong? I can
>> create javadocs using the JavaDoc task for the same packages fine.
>>
>> <path id="xdoclet.classpath"> <pathelement
>> location="${log4j.jar}"/> <pathelement
>> location="${commons-logging.jar}"/> <fileset dir="${xdoclet.dir}"
>> includes="*.jar"/> </path> <taskdef name="xdoclet"
>> classname="xdoclet.DocletTask"> <classpath> <path
>> refid="xdoclet.classpath"/> </classpath> </taskdef>
>>
>> ... <target name="xdoc" > <xdoclet destdir="${basedir}/xdoc"
>>>
>> <fileset dir="${common.dir}/src/java"/> </xdoclet> </target>
>>
>> Any help would be appreciated. - Dustin
>>
>>
>> ------------------------------------------------------- This sf.net
>> email is sponsored by: With Great Power, Comes Great Responsibility
>> Learn to use your power at OSDN's High Performance Computing
>> Channel http://hpc.devchannel.org/
>> _______________________________________________ Xdoclet-user
>> mailing list [EMAIL PROTECTED]
>> https://lists.sourceforge.net/lists/listinfo/xdoclet-user
>>
>>
>
>
>



-------------------------------------------------------
This sf.net email is sponsored by:
With Great Power, Comes Great Responsibility Learn to use your power at OSDN's High Performance Computing Channel
http://hpc.devchannel.org/
_______________________________________________
Xdoclet-user mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-user