4.0.0 Contribution: Javadoc Cleanup

[Eliot Kimber <ek...@contrext.com>]

As both a technical writer by training and as a user of the POI XWPDF API I'd like to make a pass over the javadocs to make sure every public class and method has an appropriate and accurate description and add usage tips to classes as appropriate.

That’s all the XWPF* classes and anything else under org.apache.poi.ooxml that needs documenting for end users.

Could also use a package-level Javadoc file but that's a bit more involved and I'm not sure I can commit to that much time (and it may not be something the team wants to have to maintain in the future). Might be a better use of my time to contribute some more examples.

Since this work would touch all the classes I don't want to do something that would make the committers' jobs harder.

If this is something the team would like let me know how best to coordinate the work so I don't disrupt ongoing development activity.

Cheers,

Eliot
--
Eliot Kimber
http://contrext.com
 



---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@poi.apache.org
For additional commands, e-mail: user-help@poi.apache.org

Re: 4.0.0 Contribution: Javadoc Cleanup

[Andreas Beeker <ki...@apache.org>]

Hi Eliot,

as always: "just do it" ... please provide your patches in a reasonable size (e.g. by package)
If they make sense and we have the impression that you'll stick with the project,
we usually invite developers to become committers - especially as the hwpf/xwpf
apis are a bit in dire straits.

As javadoc changes usually don't have side effects, it should be straight forward
to apply your patches.

Andi