Re: Javadoc plugin doesn't report errors
Martin, On Sat, 2004-10-16 at 15:54, Martin Cooper wrote: The Javadoc plugin (I'm using 1.7) doesn't seem to report any errors in the Javadocs, such as missing @param comments, etc. It creates the docs Have you tried the new Javadoc Warning Report (see links below)? http://jira.codehaus.org/browse/MPJAVADOC-35 -- Felipe PS: note that the report does not work correctly on JDK 1.3 PPS: is the new report documented on the site? If it isn't, where should we document it (as it's not exactly just a goal)? - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Javadoc plugin doesn't report errors
The Javadoc plugin (I'm using 1.7) doesn't seem to report any errors in the Javadocs, such as missing @param comments, etc. It creates the docs just fine, but even if I deliberately create errors, the plugin doesn't tell me about them. This gives me a lot less confidence that my Javadocs are accurate... Is this a bug, or am I missing something? TIA. -- Martin Cooper - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Javadoc plugin doesn't report errors
There is an additional report in the menu that should show the javadoc output, as it is hard to catch during the build of site. eg: http://maven.apache.org/javadoc.html Cheers, Brett On Sat, 16 Oct 2004 11:54:35 -0700 (PDT), Martin Cooper [EMAIL PROTECTED] wrote: The Javadoc plugin (I'm using 1.7) doesn't seem to report any errors in the Javadocs, such as missing @param comments, etc. It creates the docs just fine, but even if I deliberately create errors, the plugin doesn't tell me about them. This gives me a lot less confidence that my Javadocs are accurate... Is this a bug, or am I missing something? TIA. -- Martin Cooper - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Javadoc plugin doesn't report errors
Hi Martin, The Javadoc plugin (I'm using 1.7) doesn't seem to report any errors in the Javadocs, such as missing @param comments, etc. It creates the docs just fine, but even if I deliberately create errors, the plugin doesn't tell me about them. This gives me a lot less confidence that my Javadocs are accurate... If you're interested, I've made a DocCheck plugin. http://sylow.no-ip.com/pub/apache/maven/plugins/maven-doccheck-plugin-1.2b2.jar Still under development. Currently, it's just a copy of the Javadoc plugin, using a different Doclet. You'll need to download the DocCheck doclet from Sun, and copy it to your local repository (license issues). Best regards, -- Shinobu Kawai -- Shinobu Kawai [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Javadoc plugin doesn't report errors
Brett Porter [EMAIL PROTECTED] wrote in message news:[EMAIL PROTECTED] There is an additional report in the menu that should show the javadoc output, as it is hard to catch during the build of site. Yes, I'm aware of that report. That's where I looked for errors, but even when I deliberately comment out a @param to test it, no error messages show up there. -- Martin Cooper eg: http://maven.apache.org/javadoc.html Cheers, Brett On Sat, 16 Oct 2004 11:54:35 -0700 (PDT), Martin Cooper [EMAIL PROTECTED] wrote: The Javadoc plugin (I'm using 1.7) doesn't seem to report any errors in the Javadocs, such as missing @param comments, etc. It creates the docs just fine, but even if I deliberately create errors, the plugin doesn't tell me about them. This gives me a lot less confidence that my Javadocs are accurate... Is this a bug, or am I missing something? TIA. -- Martin Cooper - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Javadoc plugin doesn't report errors
ah, right. I've never seen it happen, or a property that would cause that, so it may be a bug - sounds odd though. Anything we can reproduce it on? Thanks, Brett On Sat, 16 Oct 2004 19:46:13 -0700, Martin Cooper [EMAIL PROTECTED] wrote: Brett Porter [EMAIL PROTECTED] wrote in message news:[EMAIL PROTECTED] There is an additional report in the menu that should show the javadoc output, as it is hard to catch during the build of site. Yes, I'm aware of that report. That's where I looked for errors, but even when I deliberately comment out a @param to test it, no error messages show up there. -- Martin Cooper eg: http://maven.apache.org/javadoc.html Cheers, Brett On Sat, 16 Oct 2004 11:54:35 -0700 (PDT), Martin Cooper [EMAIL PROTECTED] wrote: The Javadoc plugin (I'm using 1.7) doesn't seem to report any errors in the Javadocs, such as missing @param comments, etc. It creates the docs just fine, but even if I deliberately create errors, the plugin doesn't tell me about them. This gives me a lot less confidence that my Javadocs are accurate... Is this a bug, or am I missing something? TIA. -- Martin Cooper - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Javadoc plugin doesn't report errors
Brett Porter [EMAIL PROTECTED] wrote in message news:[EMAIL PROTECTED] ah, right. I've never seen it happen, or a property that would cause that, so it may be a bug - sounds odd though. Anything we can reproduce it on? You could try Commons FileUpload. I don't know if there are any errors right now (because of this problem), but you could always add your own. ;-) -- Martin Cooper Thanks, Brett On Sat, 16 Oct 2004 19:46:13 -0700, Martin Cooper [EMAIL PROTECTED] wrote: Brett Porter [EMAIL PROTECTED] wrote in message news:[EMAIL PROTECTED] There is an additional report in the menu that should show the javadoc output, as it is hard to catch during the build of site. Yes, I'm aware of that report. That's where I looked for errors, but even when I deliberately comment out a @param to test it, no error messages show up there. -- Martin Cooper eg: http://maven.apache.org/javadoc.html Cheers, Brett On Sat, 16 Oct 2004 11:54:35 -0700 (PDT), Martin Cooper [EMAIL PROTECTED] wrote: The Javadoc plugin (I'm using 1.7) doesn't seem to report any errors in the Javadocs, such as missing @param comments, etc. It creates the docs just fine, but even if I deliberately create errors, the plugin doesn't tell me about them. This gives me a lot less confidence that my Javadocs are accurate... Is this a bug, or am I missing something? TIA. -- Martin Cooper - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Javadoc plugin doesn't report errors
Shinobu Kawai [EMAIL PROTECTED] wrote in message news:[EMAIL PROTECTED] Hi Brett, I've never seen it happen, or a property that would cause that, so it may be a bug - sounds odd though. Anything we can reproduce it on? It will reproduce anywhere, but this is not a bug. Mere Javadoc behaviour. It doesn't check for missing comments or tags. Just misused ones. Darn it, you're right. I'm sorry. I guess I've been confusing the output from Javadoc and Checkstyle, since the latter does complain about these things. -- Martin Cooper Best regards, -- Shinobu Kawai -- Shinobu Kawai [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
