Re: using javadoc overview and maven plugin
This was a known problem on the 2.0 beta 3 and was fixed in the 2.0version.
thanks for all the help.
Robbie
On 8/17/06, franz see <[EMAIL PROTECTED]> wrote:
On 8/17/06, Robbie Minshall <[EMAIL PROTECTED]> wrote:
>
> My current conclusion:
> Definately want to use a relative path or else this will obviously break
> builds left and right. Using the ${basedir} looks like it will work
> nicely. However, right now it seems that the javadoc plugin is not
> replacing backslashes with slashes.
>
> I have put various configurations and the error below demonstrating
this.
> It may be that I am doing something stupid here which would be great, or
> it
> > may be that the back slashes are not currently being replaced
> appropiately
> for platform independence.
>
> thanks guys for taking the time to have a peek at this . . .
>
>
> * * * WHAT WORKS * * *
> * full path double back slashes
>
>
>
> org.apache.maven.plugins
> maven-javadoc-plugin
>
>
>
c:\\working\\tuscany07252006\\java\\samples\\sdo\\src\\main\\java\\overview.html
>
>
>
>
> * full path forward slashes
>
>
>
> org.apache.maven.plugins
> maven-javadoc-plugin
>
>
>
c:/working/tuscany07252006/java/samples/sdo/src/main/java/overview.html
>
>
>
>
>
>
> * * * FULL PATH - SINGLE BACK SLASHES * * *
>
>
>
> org.apache.maven.plugins
> maven-javadoc-plugin
>
>
>
c:\working\tuscany07252006\java\samples\sdo\src\main\java\overview.html
>
>
>
>
>
> --> javadoc: error - Error while reading file c:working
> uscany07252006javasamplessdosrcmainjavaoverview.html
>
> * * * RELATIVE PATH USING BASEDIR VARIABLE * * *
>
>
>
> org.apache.maven.plugins
> maven-javadoc-plugin
>
> ${basedir}/src/main/java/overview.html
>
>
>
>
>
> --> javadoc: error - Error while reading file C:working
> uscany07252006javasamplessdo/src/main/java/overview.html
>
> Robbie John.
Good day to you, Robbie,
Curious, what maven-javadoc-plugin are you using? I'm using 2.1-SNAPSHOTand
I don't think I've encountered your problem.
Cheers,
Franz
--
View this message in context:
http://www.nabble.com/using-javadoc-overview-and-maven-plugin-tf2110480.html#a5860779
Sent from the Maven - Users forum at Nabble.com.
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
--
* * * Charlie * * *
Check out some pics of little Charlie at
http://www.flickr.com/photos/[EMAIL PROTECTED]/sets/
* * * Addresss * * *
1914 Overland Drive
Chapel Hill
NC 27517
* * * Number * * *
919-225-1553
Re: using javadoc overview and maven plugin
On 8/17/06, Robbie Minshall <[EMAIL PROTECTED]> wrote:
>
> My current conclusion:
> Definately want to use a relative path or else this will obviously break
> builds left and right. Using the ${basedir} looks like it will work
> nicely. However, right now it seems that the javadoc plugin is not
> replacing backslashes with slashes.
>
> I have put various configurations and the error below demonstrating this.
> It may be that I am doing something stupid here which would be great, or
> it
> > may be that the back slashes are not currently being replaced
> appropiately
> for platform independence.
>
> thanks guys for taking the time to have a peek at this . . .
>
>
> * * * WHAT WORKS * * *
> * full path double back slashes
>
>
>
> org.apache.maven.plugins
> maven-javadoc-plugin
>
>
> c:\\working\\tuscany07252006\\java\\samples\\sdo\\src\\main\\java\\overview.html
>
>
>
>
> * full path forward slashes
>
>
>
> org.apache.maven.plugins
> maven-javadoc-plugin
>
>
> c:/working/tuscany07252006/java/samples/sdo/src/main/java/overview.html
>
>
>
>
>
>
> * * * FULL PATH - SINGLE BACK SLASHES * * *
>
>
>
> org.apache.maven.plugins
> maven-javadoc-plugin
>
>
> c:\working\tuscany07252006\java\samples\sdo\src\main\java\overview.html
>
>
>
>
>
> --> javadoc: error - Error while reading file c:working
> uscany07252006javasamplessdosrcmainjavaoverview.html
>
> * * * RELATIVE PATH USING BASEDIR VARIABLE * * *
>
>
>
> org.apache.maven.plugins
> maven-javadoc-plugin
>
> ${basedir}/src/main/java/overview.html
>
>
>
>
>
> --> javadoc: error - Error while reading file C:working
> uscany07252006javasamplessdo/src/main/java/overview.html
>
> Robbie John.
Good day to you, Robbie,
Curious, what maven-javadoc-plugin are you using? I'm using 2.1-SNAPSHOT and
I don't think I've encountered your problem.
Cheers,
Franz
--
View this message in context:
http://www.nabble.com/using-javadoc-overview-and-maven-plugin-tf2110480.html#a5860779
Sent from the Maven - Users forum at Nabble.com.
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
Re: using javadoc overview and maven plugin
That sure sounds like a bug to me, if any of those should work it'd be
the basedir one. I'd file it.
On 8/17/06, Robbie Minshall <[EMAIL PROTECTED]> wrote:
My current conclusion:
Definately want to use a relative path or else this will obviously break
builds left and right. Using the ${basedir} looks like it will work
nicely. However, right now it seems that the javadoc plugin is not
replacing backslashes with slashes.
I have put various configurations and the error below demonstrating this.
It may be that I am doing something stupid here which would be great, or it
may be that the back slashes are not currently being replaced appropiately
for platform independence.
thanks guys for taking the time to have a peek at this . . .
* * * WHAT WORKS * * *
* full path double back slashes
org.apache.maven.plugins
maven-javadoc-plugin
c:\\working\\tuscany07252006\\java\\samples\\sdo\\src\\main\\java\\overview.html
* full path forward slashes
org.apache.maven.plugins
maven-javadoc-plugin
c:/working/tuscany07252006/java/samples/sdo/src/main/java/overview.html
* * * FULL PATH - SINGLE BACK SLASHES * * *
org.apache.maven.plugins
maven-javadoc-plugin
c:\working\tuscany07252006\java\samples\sdo\src\main\java\overview.html
--> javadoc: error - Error while reading file c:working
uscany07252006javasamplessdosrcmainjavaoverview.html
* * * RELATIVE PATH USING BASEDIR VARIABLE * * *
org.apache.maven.plugins
maven-javadoc-plugin
${basedir}/src/main/java/overview.html
--> javadoc: error - Error while reading file C:working
uscany07252006javasamplessdo/src/main/java/overview.html
Robbie John.
On 8/16/06, Nick Veys <[EMAIL PROTECTED]> wrote:
>
> On 8/16/06, Robbie Minshall <[EMAIL PROTECTED]> wrote:
> > Attempting to set the overview page for javadoc relative to the working
> > directory :
> >
> > Using the ${basedir} almost works and probably would on a unix
> environment
> > but on windows I get :
> > C:working
> > uscany07252006javasamplessdo/src/main/java/overview.html
> >
> > So it looks as it the javadoc plugin is picking up on the directory
> slashes
> > as escape charactors.
> >
> > Any thoughts ?
>
> Could you post the javadoc plugin section of your POM? I assume by
> saying "using the basedir" you have
> ${basedir}/src/main/java/overview.html?
>
> -
> To unsubscribe, e-mail: [EMAIL PROTECTED]
> For additional commands, e-mail: [EMAIL PROTECTED]
>
>
--
* * * Charlie * * *
Check out some pics of little Charlie at
http://www.flickr.com/photos/[EMAIL PROTECTED]/sets/
* * * Addresss * * *
1914 Overland Drive
Chapel Hill
NC 27517
* * * Number * * *
919-225-1553
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
Re: using javadoc overview and maven plugin
My current conclusion:
Definately want to use a relative path or else this will obviously break
builds left and right. Using the ${basedir} looks like it will work
nicely. However, right now it seems that the javadoc plugin is not
replacing backslashes with slashes.
I have put various configurations and the error below demonstrating this.
It may be that I am doing something stupid here which would be great, or it
may be that the back slashes are not currently being replaced appropiately
for platform independence.
thanks guys for taking the time to have a peek at this . . .
* * * WHAT WORKS * * *
* full path double back slashes
org.apache.maven.plugins
maven-javadoc-plugin
c:\\working\\tuscany07252006\\java\\samples\\sdo\\src\\main\\java\\overview.html
* full path forward slashes
org.apache.maven.plugins
maven-javadoc-plugin
c:/working/tuscany07252006/java/samples/sdo/src/main/java/overview.html
* * * FULL PATH - SINGLE BACK SLASHES * * *
org.apache.maven.plugins
maven-javadoc-plugin
c:\working\tuscany07252006\java\samples\sdo\src\main\java\overview.html
--> javadoc: error - Error while reading file c:working
uscany07252006javasamplessdosrcmainjavaoverview.html
* * * RELATIVE PATH USING BASEDIR VARIABLE * * *
org.apache.maven.plugins
maven-javadoc-plugin
${basedir}/src/main/java/overview.html
--> javadoc: error - Error while reading file C:working
uscany07252006javasamplessdo/src/main/java/overview.html
Robbie John.
On 8/16/06, Nick Veys <[EMAIL PROTECTED]> wrote:
On 8/16/06, Robbie Minshall <[EMAIL PROTECTED]> wrote:
> Attempting to set the overview page for javadoc relative to the working
> directory :
>
> Using the ${basedir} almost works and probably would on a unix
environment
> but on windows I get :
> C:working
> uscany07252006javasamplessdo/src/main/java/overview.html
>
> So it looks as it the javadoc plugin is picking up on the directory
slashes
> as escape charactors.
>
> Any thoughts ?
Could you post the javadoc plugin section of your POM? I assume by
saying "using the basedir" you have
${basedir}/src/main/java/overview.html?
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
--
* * * Charlie * * *
Check out some pics of little Charlie at
http://www.flickr.com/photos/[EMAIL PROTECTED]/sets/
* * * Addresss * * *
1914 Overland Drive
Chapel Hill
NC 27517
* * * Number * * *
919-225-1553
Re: using javadoc overview and maven plugin
On 8/16/06, Robbie Minshall <[EMAIL PROTECTED]> wrote:
Attempting to set the overview page for javadoc relative to the working
directory :
Using the ${basedir} almost works and probably would on a unix environment
but on windows I get :
C:working
uscany07252006javasamplessdo/src/main/java/overview.html
So it looks as it the javadoc plugin is picking up on the directory slashes
as escape charactors.
Any thoughts ?
Could you post the javadoc plugin section of your POM? I assume by
saying "using the basedir" you have
${basedir}/src/main/java/overview.html?
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
Re: using javadoc overview and maven plugin
Robbie Minshall wrote:
>
> Attempting to set the overview page for javadoc relative to the working
> directory :
>
> Using the ${basedir} almost works and probably would on a unix environment
> but on windows I get :
> C:working
> uscany07252006javasamplessdo/src/main/java/overview.html
>
> So it looks as it the javadoc plugin is picking up on the directory
> slashes
> as escape charactors.
>
> Any thoughts ?
>
> Robbie John
>
>
Good day to you, Robin,
You don't need to double your backslashes. Maven-javadoc-plugin
automatically replaces those backslashes with slashes.
Also, it is recommended that you use a relative path to maintain portability
of the project ^_^
Cheers,
Franz
--
View this message in context:
http://www.nabble.com/using-javadoc-overview-and-maven-plugin-tf2110480.html#a5843888
Sent from the Maven - Users forum at Nabble.com.
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
Re: using javadoc overview and maven plugin
Attempting to set the overview page for javadoc relative to the working
directory :
Using the ${basedir} almost works and probably would on a unix environment
but on windows I get :
C:working
uscany07252006javasamplessdo/src/main/java/overview.html
So it looks as it the javadoc plugin is picking up on the directory slashes
as escape charactors.
Any thoughts ?
Robbie John
On 8/16/06, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote:
> -Original Message-
> From: Robbie Minshall [mailto:[EMAIL PROTECTED]
====
>
> I am calling the javadoc plugin from within a pom.xml file like so :
>
If you cant use a relative path. Have you tried a Maven POM
properties
>
>
>
> org.apache.maven.plugins
> maven-javadoc-plugin
>
>
> c:\\working\\tuscany07252006\\java\\samples\\sdo\\sr
> c\\main\\java\\overview.html
>
>
>
>
>
> I would like to specify a relative path to my project (
> i.esrc\\main\java\\overview.html ) for the overview page.
> However, this does not seem to be working.
>
Something like this
${maven.compile.compileSourceDir}samples\\sdo\\sr
c\\main\\java\\overview.html
BTW: I am just guessing the POM property name here.
It might be better to rely on the base directory
${basedir}/src/main/java/overview.html
etc
> How should I correctly specify an overview page when calling
> javadoc plugin from within a pom.xml ?
Good luck
====
--
Peter Pilgrim
UBS Investment Bank,
PTS Portal / IT FIRC OPS LDN,
100 Liverpool Street, London EC2M 2RH, United Kingdom
:: Java EE / E-Commerce / Enterprise Integration / Development ::
Visit our website at http://www.ubs.com
This message contains confidential information and is intended only
for the individual named. If you are not the named addressee you
should not disseminate, distribute or copy this e-mail. Please
notify the sender immediately by e-mail if you have received this
e-mail by mistake and delete this e-mail from your system.
E-mail transmission cannot be guaranteed to be secure or error-free
as information could be intercepted, corrupted, lost, destroyed,
arrive late or incomplete, or contain viruses. The sender therefore
does not accept liability for any errors or omissions in the contents
of this message which arise as a result of e-mail transmission. If
verification is required please request a hard-copy version. This
message is provided for informational purposes and should not be
construed as a solicitation or offer to buy or sell any securities or
related financial instruments.
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
--
* * * Charlie * * *
Check out some pics of little Charlie at
http://www.flickr.com/photos/[EMAIL PROTECTED]/sets/
* * * Addresss * * *
1914 Overland Drive
Chapel Hill
NC 27517
* * * Number * * *
919-225-1553
RE: using javadoc overview and maven plugin
> -Original Message-
> From: Robbie Minshall [mailto:[EMAIL PROTECTED]
====
>
> I am calling the javadoc plugin from within a pom.xml file like so :
>
If you cant use a relative path. Have you tried a Maven POM
properties
>
>
>
> org.apache.maven.plugins
> maven-javadoc-plugin
>
>
> c:\\working\\tuscany07252006\\java\\samples\\sdo\\sr
> c\\main\\java\\overview.html
>
>
>
>
>
> I would like to specify a relative path to my project (
> i.esrc\\main\java\\overview.html ) for the overview page.
> However, this does not seem to be working.
>
Something like this
${maven.compile.compileSourceDir}samples\\sdo\\sr
c\\main\\java\\overview.html
BTW: I am just guessing the POM property name here.
It might be better to rely on the base directory
${basedir}/src/main/java/overview.html
etc
> How should I correctly specify an overview page when calling
> javadoc plugin from within a pom.xml ?
Good luck
====
--
Peter Pilgrim
UBS Investment Bank,
PTS Portal / IT FIRC OPS LDN,
100 Liverpool Street, London EC2M 2RH, United Kingdom
:: Java EE / E-Commerce / Enterprise Integration / Development ::
Visit our website at http://www.ubs.com
This message contains confidential information and is intended only
for the individual named. If you are not the named addressee you
should not disseminate, distribute or copy this e-mail. Please
notify the sender immediately by e-mail if you have received this
e-mail by mistake and delete this e-mail from your system.
E-mail transmission cannot be guaranteed to be secure or error-free
as information could be intercepted, corrupted, lost, destroyed,
arrive late or incomplete, or contain viruses. The sender therefore
does not accept liability for any errors or omissions in the contents
of this message which arise as a result of e-mail transmission. If
verification is required please request a hard-copy version. This
message is provided for informational purposes and should not be
construed as a solicitation or offer to buy or sell any securities or
related financial instruments.
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
using javadoc overview and maven plugin
Hello. I am calling the javadoc plugin from within a pom.xml file like so : org.apache.maven.plugins maven-javadoc-plugin c:\\working\\tuscany07252006\\java\\samples\\sdo\\src\\main\\java\\overview.html I would like to specify a relative path to my project ( i.esrc\\main\java\\overview.html ) for the overview page. However, this does not seem to be working. How should I correctly specify an overview page when calling javadoc plugin from within a pom.xml ? thanks very much for the help, Robbie -- * * * Charlie * * * Check out some pics of little Charlie at http://www.flickr.com/photos/[EMAIL PROTECTED]/sets/ * * * Addresss * * * 1914 Overland Drive Chapel Hill NC 27517 * * * Number * * * 919-225-1553
