Javadoc resources for tech writers?

Subject: Javadoc resources for tech writers?
From: Joyce Fetterman <JoyceF -at- gtsoftware -dot- com>
To: "TECHWR-L (E-mail)" <TECHWR-L -at- LISTS -dot- RAYCOMM -dot- COM>
Date: Thu, 5 Feb 2004 16:27:41 -0500

I'm editing Javadoc that was written by offshore developers. I don't know
Java, so I'm already at a loss, and the translation errors just add to the

Can anyone recommend a Javadoc resource that's good for the tech writers who
have to clean it up?

I have searched the Sun Web site and I've found the answers to many
questions, but I'm hoping for a resource that looks at Javadoc from a TW's
perspective. I have read "How to Write Comments for the Javadoc Tool", but
that assumes an understanding of Java.

(To those who would tell me to learn Java, don't bother. That can't happen
in the days before my deadline... This Javadoc must be edited now and I must
do the editing.)

Please copy me directly with responses. Thanks.



Previous by Author: RoboDemo vs. Flash MX
Next by Author: RE: Javadoc resources for tech writers?
Previous by Thread: Re: Highlighting Text in Frame
Next by Thread: Re: Javadoc resources for tech writers?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads