TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
confusion.
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.)
