Problem running Javadocs

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

Problem running Javadocs

Allan Lewis
Hi,

I get errors like the following when running the javadoc task on my projects.  The error seems to be related to the package.html file, which should be valid (copied from Sun's s template HTML file here: http://java.sun.com/j2se/javadoc/writingdoccomments/package-template).  Also, it seems odd that the build succeeds even thought the javadoc produced errors and did not generate anything.

Error I'm getting:

  [javadoc] javadoc: error - Illegal package name: "C:\Documents and Settings\Allan\Workspace\koios-framework-
trunk\koios-generator\src\main\java\org\koiosframework\generator\package.html"
  [javadoc] 1 error

BUILD SUCCESSFUL

Thanks
Allan
Reply | Threaded
Open this post in threaded view
|

Re: Problem running Javadocs

hans_d
Administrator
Hi Allan,

On Aug 22, 2008, at 7:09 AM, Allan Lewis wrote:

>
> Hi,
>
> I get errors like the following when running the javadoc task on my
> projects.  The error seems to be related to the package.html file,  
> which
> should be valid (copied from Sun's s template HTML file here:
> http://java.sun.com/j2se/javadoc/writingdoccomments/package-template).
> Also, it seems odd that the build succeeds even thought the javadoc  
> produced
> errors and did not generate anything.
>
> Error I'm getting:
>
>   [javadoc] javadoc: error - Illegal package name: "C:\Documents and
> Settings\Allan\Workspace\koios-framework-
> trunk\koios-generator\src\main\java\org\koiosframework\generator
> \package.html"
>   [javadoc] 1 error
>
> BUILD SUCCESSFUL

Could you file a Jira? I have no idea right now about what is going  
on there. Adam might know better.

- Hans

--
Hans Dockter
Gradle Project lead
http://www.gradle.org





---------------------------------------------------------------------
To unsubscribe from this list, please visit:

    http://xircles.codehaus.org/manage_email


Reply | Threaded
Open this post in threaded view
|

Re: Problem running Javadocs

Adam Murdoch-2


Hans Dockter wrote:

> Hi Allan,
>
> On Aug 22, 2008, at 7:09 AM, Allan Lewis wrote:
>
>>
>> Hi,
>>
>> I get errors like the following when running the javadoc task on my
>> projects.  The error seems to be related to the package.html file, which
>> should be valid (copied from Sun's s template HTML file here:
>> http://java.sun.com/j2se/javadoc/writingdoccomments/package-template).
>> Also, it seems odd that the build succeeds even thought the javadoc
>> produced
>> errors and did not generate anything.
>>
>> Error I'm getting:
>>
>>   [javadoc] javadoc: error - Illegal package name: "C:\Documents and
>> Settings\Allan\Workspace\koios-framework-
>> trunk\koios-generator\src\main\java\org\koiosframework\generator\package.html"
>>
>>   [javadoc] 1 error
>>
>> BUILD SUCCESSFUL
>
> Could you file a Jira? I have no idea right now about what is going on
> there. Adam might know better.
>

It looks like gradle doesn't like package.html files at all. Not sure
why yet, but I will investigate fix this very soon. In the meantime, as
a work around, you can use a package-info.java file instead of the
package.html file.


Adam


---------------------------------------------------------------------
To unsubscribe from this list, please visit:

    http://xircles.codehaus.org/manage_email


Reply | Threaded
Open this post in threaded view
|

Re: Problem running Javadocs

Allan Lewis
A couple of other javadoc-related questions:

1 - Any way to make the build fail if the javadoc task fails?
2 - How do I specify a classpath for javadoc?  I'm getting tons of compilation errors when running the task - things still generate correctly, but they're annoying...

Thanks
Allan