You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@xalan.apache.org by sh...@e-z.net on 2012/04/02 18:09:38 UTC
Xalan Java Team - JavaDoc API
Xalan Java Team - JavaDoc API
I finally got a JavaDoc rendered API build for Xalan-Java.
It is now available for review on my committer's web site.
http://www.apache.org/~shathaway/docs/xalan/xalan-j/apiDocs/
On Windows, I needed to tell the underlying Java engine to
use lots more memory than its default. Otherwise I was getting
out-of-memory exception when trying to build the javadoc documents.
I get lots of warnings.
My Java platform is old (jdk1.5.0_18).
Document Branding Requirements:
Do any of you have headers, trailers, and css stylesheets
that can automatically apply the ASF branding requirements
for JavaDoc constructed documents?
Sincerely,
Steven J. Hathaway
Xalan Documentation Project
<sh...@apache.org>
<xa...@xml.apache.org>
---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-dev-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-dev-help@xml.apache.org
Re: Xalan Java Team - JavaDoc API
Posted by sh...@e-z.net.
Xalan Java Team - JavaDoc API
Here are some of the warnings related to creating JavaDoc API
from the Xalan-Java sources. These create the most volume of
warnings.
_ package org.apache.bcel.generic does not exist.
_ @xsl.usage is an unknown tag.
_ @return tag has no arguments.
_ @return tag cannot be used in method with void return type.
_ @param argument "name" is not a parameter name.
_ @see: reference not found: ...
_ @link: reference not found: ...
Output Log Summary:
7 errors
933 warnings
Sincerely,
Steven J. Hathaway
Xalan Documentation Project
> On Mon, Apr 2, 2012 at 12:09 PM, <sh...@e-z.net> wrote:
>
>> Xalan Java Team - JavaDoc API
>>
>> I finally got a JavaDoc rendered API build for Xalan-Java.
>> It is now available for review on my committer's web site.
>>
>> http://www.apache.org/~shathaway/docs/xalan/xalan-j/apiDocs/
>>
>> On Windows, I needed to tell the underlying Java engine to
>> use lots more memory than its default. Otherwise I was getting
>> out-of-memory exception when trying to build the javadoc documents.
>>
>> I get lots of warnings.
>>
>> My Java platform is old (jdk1.5.0_18).
>>
>> Document Branding Requirements:
>>
>> Do any of you have headers, trailers, and css stylesheets
>> that can automatically apply the ASF branding requirements
>> for JavaDoc constructed documents?
>>
>
> Some of the missing information can be passed in to Javadoc directly: the
> title and footer. For example, on
> http://commons.apache.org/io/api-release/index.html the title is "Commons
> IO 2.2 API" and the footer is "Copyright © 2002-2012 The Apache Software
> Foundation. All Rights Reserved."
>
> Gary
>
Thanks Gary,
>>
>> Sincerely,
>> Steven J. Hathaway
>> Xalan Documentation Project
>> <sh...@apache.org>
>> <xa...@xml.apache.org>
>>
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: xalan-dev-unsubscribe@xml.apache.org
>> For additional commands, e-mail: xalan-dev-help@xml.apache.org
>>
>>
>
>
> --
> E-Mail: garydgregory@gmail.com | ggregory@apache.org
> JUnit in Action, 2nd Ed: <http://goog_1249600977>http://bit.ly/ECvg0
> Spring Batch in Action: <http://s.apache.org/HOq>http://bit.ly/bqpbCK
> Blog: http://garygregory.wordpress.com
> Home: http://garygregory.com/
> Tweet! http://twitter.com/GaryGregory
>
---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-dev-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-dev-help@xml.apache.org
Re: Xalan Java Team - JavaDoc API
Posted by Gary Gregory <ga...@gmail.com>.
On Mon, Apr 2, 2012 at 12:09 PM, <sh...@e-z.net> wrote:
> Xalan Java Team - JavaDoc API
>
> I finally got a JavaDoc rendered API build for Xalan-Java.
> It is now available for review on my committer's web site.
>
> http://www.apache.org/~shathaway/docs/xalan/xalan-j/apiDocs/
>
> On Windows, I needed to tell the underlying Java engine to
> use lots more memory than its default. Otherwise I was getting
> out-of-memory exception when trying to build the javadoc documents.
>
> I get lots of warnings.
>
> My Java platform is old (jdk1.5.0_18).
>
> Document Branding Requirements:
>
> Do any of you have headers, trailers, and css stylesheets
> that can automatically apply the ASF branding requirements
> for JavaDoc constructed documents?
>
Some of the missing information can be passed in to Javadoc directly: the
title and footer. For example, on
http://commons.apache.org/io/api-release/index.html the title is "Commons
IO 2.2 API" and the footer is "Copyright © 2002-2012 The Apache Software
Foundation. All Rights Reserved."
Gary
>
> Sincerely,
> Steven J. Hathaway
> Xalan Documentation Project
> <sh...@apache.org>
> <xa...@xml.apache.org>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: xalan-dev-unsubscribe@xml.apache.org
> For additional commands, e-mail: xalan-dev-help@xml.apache.org
>
>
--
E-Mail: garydgregory@gmail.com | ggregory@apache.org
JUnit in Action, 2nd Ed: <http://goog_1249600977>http://bit.ly/ECvg0
Spring Batch in Action: <http://s.apache.org/HOq>http://bit.ly/bqpbCK
Blog: http://garygregory.wordpress.com
Home: http://garygregory.com/
Tweet! http://twitter.com/GaryGregory