I think Javadoc is very important, especially for those who embrace the features spawning from it's architecture.

For example, selecting Alt-F1 in the context of a package name within the Java source code editor of NetBeans will invoke a browser to be opened with the relative package Javadoc documentation. If no Javadoc documentation exists for the package, there will be nothing to look at.

I'll take a cut at the Javadoc for CXF package descriptions and then perhaps someone can review my work before releasing it.

Thanks,
Robert

--------------------------------------------------
From: "Daniel Kulp" <[email protected]>
Sent: Friday, October 15, 2010 3:40 PM
To: <[email protected]>
Cc: "Robert Liguori" <[email protected]>
Subject: Re: CXF and Javadoc - package descriptions

On Friday 15 October 2010 1:23:59 pm Robert Liguori wrote:
Javadoc for CXF needs a lot of help:
http://cxf.apache.org/javadoc/latest/

For starters, I opened up an issue for completion of the package
descriptions:
https://issues.apache.org/jira/browse/CXF-3013.

Can anyone take a few hours and update the descriptions?

Note: Out of the numerous CXF packages, only nine of them have a package
description.

If there is anyway I can help, please let know.

Honestly, I'm not sure it's important enough of an issue to anyone here to
really devote much time to it. To me, it's more important to fix the bugs
that are preventing things from working than to do javadoc.

Thus, the BEST way to help is to write some javadoc and submit a patch. If
you have specific questions, feel free to ask on the list.

--
Daniel Kulp
[email protected]
http://dankulp.com/blog

Reply via email to