Still not getting it to generate any info...
Yes, files (9 of them, 4 html, 4 gif and 1 css) are generated, and
all-classes.html is one of them. But still no sign of references to the
@todo tags I've placed in the code.
During execution I do get a "WARNING: Some classes refer to other classes
that were not found among the sources or on the classpath.
Perhaps the referred class doesn't exist? Hasn't been generated yet?)
The referring classes do not import any fully qualified classes matching
these classes.
Since at least one package is imported, it is impossible for xjavadoc to
figure out
But it seems to be resolved by itself, atleast it is followed by a lot of
"c:\build\com\temporary}servlet\gcc\GCCMonitor.java --> GCCVSUtils qualified
to com.temporary.servlet.gcc.GCCVSUtils"
Which would indicate to me that it resolves the paths itself. Anyway, the
execution doesn't produce any errors, just warnings of the type above.
What do you mean by " The code in the ${source.dir} has to have at least one
@todo tag in the javadoc, have you verified this?"
I've got the following as a header for one of my methods:
/**
* ticketInit bla bla bla...
*
* @param userId The indentification for this particular user
* @return Name values pairs sent to the client.
* @modelguid {2E99BCAB-C5AF-41BB-A7A3-2459D7B7C0DD}
* @todo linus testar
*/
public String ticketInit(String userId) {
...
...
}
And the .java file this is in is part of the source I'm scanning. Is that
what you mean that my source must contain atleast one @todo tag ? Btw is
there any way to get a list of all in-code @todo tags too ? would be really
helpful. I find @todo comments are best placed exactly at the point which
needs attention, not in the method-header.
//Linus
> -----Original Message-----
> From: [EMAIL PROTECTED] [mailto:xdoclet-user-
> [EMAIL PROTECTED] On Behalf Of Ben Sommerville
> Sent: den 13 augusti 2003 10:19
> To: [EMAIL PROTECTED]
> Subject: RE: [Xdoclet-user] Xdoclet To-do list generation example ?
>
> The build.force.docs is just a true/false property that we set at a higher
> level to say whether the doc generation should be forced
> (I think that docs won't be generated if their creation time is later than
> the
> files modification time)
>
> Do you get any files generated at all?
> (eg a all-class.html file)
>
> The code in the ${source.dir} has to have at least one @todo tag in the
> javadoc, have you verified this?
>
> Note - the @todo _has_ to be in valid javadoc (eg method javadoc), it
> can't be
> embedded in a normal comment or part of /** */ comment that is in a
> invalid
> location (eg inside a method).
>
> eg the below @todo turns up in the generated html
> /**
> * Abstract base exception that implenment localization & nested exceptions
> (for jdk 1.3).
> * @todo Investigate extending NestableDelagate to understand localized
> messages
> */
> public abstract class BaseException extends Exception
> implements LocalizedException, Nestable {
> }
>
> hope that helps
> Ben
>
> > -----Original Message-----
> > From: Linus Nikander [mailto:[EMAIL PROTECTED]
> > Sent: Wednesday, 13 August 2003 5:15 PM
> > To: [EMAIL PROTECTED]
> > Subject: RE: [Xdoclet-user] Xdoclet To-do list generation example ?
> >
> >
> > Thank you for the reply.
> >
> > The below runs just fine, but the generated HTML is empty, no
> > todo-tags to
> > be seen anywhere. Any clues as to why ? What does the
> > "force="${build.force.docs}" parameter do ? Where is that
> > supposed to point
> > to ?
> >
> > And could you give me an example of a comment which you know
> > turns up when
> > you run the task please ?
> >
> >
> >
> > //Linus
> >
> >
> >
> > > -----Original Message-----
> > > From: [EMAIL PROTECTED] [mailto:xdoclet-user-
> > > [EMAIL PROTECTED] On Behalf Of Ben Sommerville
> > > Sent: den 13 augusti 2003 01:34
> > > To: [EMAIL PROTECTED]
> > > Subject: RE: [Xdoclet-user] Xdoclet To-do list generation example ?
> > >
> > >
> > > This works for me
> > >
> > > <target name="todo-doclet">
> > > <taskdef name="todo-doclet"
> > > classname="xdoclet.modules.doc.DocumentDocletTask">
> > > </taskdef>
> > >
> > > <todo-doclet destdir="${build.docs.todo.dir}"
> > > force="${build.force.docs}"
> > > verbose="true">
> > > <fileset dir="${source.dir}">
> > > <include name="**/*.java" />
> > > </fileset>
> > >
> > > <info/>
> > > </todo-doclet>
> > > </target>
> > >
> > > You may need to add a classpath to the taskdef if xdoclet
> > is not already
> > > in the ant classapath
> > >
> > > I believe the <info> task defaults to looking for "todo".
> > You can change
> > > this by setting the "tag" attribute (the other settable
> > attributes appear
> > > to be "header" and "projectname")
> > >
> > > cheers
> > > Ben Sommerville
> > >
> ######################################################################
> Attention:
>
> The information in this electronic mail is privileged and
> confidential, intended only for use of the individual or entity named.
> If you are not the intended recipient, any dissemination, copying or
> use of the information is strictly prohibited. If you have received
> this transmission in error, please delete it immediately from your
> system and inform us via mailto [EMAIL PROTECTED]
>
> This e-mail has been scanned and cleared by MailMarshal
> ######################################################################
>
>
> -------------------------------------------------------
> This SF.Net email sponsored by: Free pre-built ASP.NET sites including
> Data Reports, E-commerce, Portals, and Forums are available now.
> Download today and enter to win an XBOX or Visual Studio .NET.
> http://aspnet.click-
> url.com/go/psa00100003ave/direct;at.aspnet_072303_01/01
> _______________________________________________
> xdoclet-user mailing list
> [EMAIL PROTECTED]
> https://lists.sourceforge.net/lists/listinfo/xdoclet-user
-------------------------------------------------------
This SF.Net email sponsored by: Free pre-built ASP.NET sites including
Data Reports, E-commerce, Portals, and Forums are available now.
Download today and enter to win an XBOX or Visual Studio .NET.
http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet_072303_01/01
_______________________________________________
xdoclet-user mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-user