Re: Please review javadoc plugin documentation

2006-07-31 Thread Maria Odea Ching
Revised the docs and updated the staging site 
http://people.apache.org/~oching/maven-javadoc-plugin 
http://people.apache.org/%7Eoching/maven-javadoc-plugin

Thanks :)

- Odea

Dennis Lundberg wrote:


Maria Odea Ching wrote:


Hi Everyone,

I've made some changes in the javadoc plugin docs. Could someone 
please review it? :-)


Thanks,
Odea



I've read through the docs and here are some comments:

All
- The title for all pages is Maven Javadoc Report, but all 
references in the text refers to Maven Javadoc Plugin.


usage.html
- Do we need to include the configuration section in the sample pom? 
There is no mention of the max/minmemory settings in the text.


jar-mojo.html
- This page is very wide, wider than my 1280 screen. The reason is the 
groups param example code, and also the tags example. I see in the 
source code that there are line breaks inside the pre-tag, but they 
seem to be ignored. Perhaps a bug in the plugin plugin or the used 
javadoc parser?

- finalName param: Specified the - Specifies the
- nocomment param: Ssee - See
- nonavbar param: Seems to be copy-and-pasted from noindex + two 
default values

- old param: This option created - This option creates
- windowtitle param: two default values

examples/*.html (except alternate-doclet.html)
- The poms in these examples have the javadoc plugin configured in the 
build section. Shouldn't it be the reporting section?





-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Re: Please review javadoc plugin documentation

2006-07-31 Thread Wendy Smoak

On 7/30/06, Maria Odea Ching [EMAIL PROTECTED] wrote:

Revised the docs and updated the staging site
http://people.apache.org/~oching/maven-javadoc-plugin
http://people.apache.org/%7Eoching/maven-javadoc-plugin
Thanks :)


Maria, I submitted a change for the 'using an alternate doclet' page,
so the example there will work with the latest release of UmlGraph.
(If you apply it, the last line of text needs a couple of spaces in
front so it won't be a section header.)

--
Wendy

-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Re: Please review javadoc plugin documentation

2006-07-12 Thread Maria Odea Ching
A staging site is now available at 
http://people.apache.org/~oching/maven-javadoc-plugin 
http://people.apache.org/%7Eoching/maven-javadoc-plugin

Thanks :)

Richard van der Hoff wrote:


Maria Odea Ching wrote:


Okay, will do :)
Thanks..



Could you also fix your clock? It seems to be set for the wrong 
timezone, or something ... either way, it's about 15 hours fast.


Richard




-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Re: Please review javadoc plugin documentation

2006-07-12 Thread Dennis Lundberg

Maria Odea Ching wrote:

Hi Everyone,

I've made some changes in the javadoc plugin docs. Could someone please 
review it? :-)


Thanks,
Odea


I've read through the docs and here are some comments:

All
- The title for all pages is Maven Javadoc Report, but all references 
in the text refers to Maven Javadoc Plugin.


usage.html
- Do we need to include the configuration section in the sample pom? 
There is no mention of the max/minmemory settings in the text.


jar-mojo.html
- This page is very wide, wider than my 1280 screen. The reason is the 
groups param example code, and also the tags example. I see in the 
source code that there are line breaks inside the pre-tag, but they seem 
to be ignored. Perhaps a bug in the plugin plugin or the used javadoc 
parser?

- finalName param: Specified the - Specifies the
- nocomment param: Ssee - See
- nonavbar param: Seems to be copy-and-pasted from noindex + two 
default values

- old param: This option created - This option creates
- windowtitle param: two default values

examples/*.html (except alternate-doclet.html)
- The poms in these examples have the javadoc plugin configured in the 
build section. Shouldn't it be the reporting section?


--
Dennis Lundberg

-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Please review javadoc plugin documentation

2006-07-11 Thread Maria Odea Ching

Hi Everyone,

I've made some changes in the javadoc plugin docs. Could someone please 
review it? :-)


Thanks,
Odea

-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Re: Please review javadoc plugin documentation

2006-07-11 Thread Trygve Laugstøl

Maria Odea Ching wrote:

Hi Everyone,

I've made some changes in the javadoc plugin docs. Could someone please 
review it? :-)


Can you publish the documentation somewhere and also inclue a small 
summary of what you've changed to make it easier to check it? You should 
have an Apache account and home directory you can use for deployment.


--
Trygve

-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Re: Please review javadoc plugin documentation

2006-07-11 Thread Maria Odea Ching

Okay, will do :)
Thanks..

Trygve Laugstøl wrote:


Maria Odea Ching wrote:


Hi Everyone,

I've made some changes in the javadoc plugin docs. Could someone 
please review it? :-)



Can you publish the documentation somewhere and also inclue a small 
summary of what you've changed to make it easier to check it? You 
should have an Apache account and home directory you can use for 
deployment.


--
Trygve

-
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: Please review javadoc plugin documentation

2006-07-11 Thread Richard van der Hoff

Maria Odea Ching wrote:

Okay, will do :)
Thanks..


Could you also fix your clock? It seems to be set for the wrong 
timezone, or something ... either way, it's about 15 hours fast.


Richard

--
Richard van der Hoff [EMAIL PROTECTED]
Telephony Gateways Project Manager
Tel: +44 (0) 845 666 7778
http://www.mxtelecom.com

-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]