Re: Javadoc resources for tech writers?
Joyce Fetterman writes:
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
As far as I remember, Javadoc is not written, rather it is generated in much the same way as a toc in Word or Frame. It picks up some or all of the following:
Not so, Lyndsey--
Programmers (should) embed comments about purpose of class, purpose of method, nature of arguments, etc. THAT's the stuff that needs editing.
Guy K. Haas
guy -at- hiskeyboard -dot- com | gkhaas -at- usa -dot- net
Software Exegete in Silicon Valley
- Re: Javadoc resources for tech writers?, Scott Turner
Previous by Author:
Re: HR electronic warfare (long)
Next by Author: Re: Developing 150-page docs in MS Word XP
Previous by Thread: Re: Javadoc resources for tech writers?
Next by Thread: Re: Javadoc resources for tech writers?
Search our Technical Writing Archives & Magazine