TechWhirl Sponsors

---

 

[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Javadoc resources for tech writers?

Subject: Re: Javadoc resources for tech writers?
From: dmbrown -at- brown-inc -dot- com
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 06 Feb 2004 07:56:06 -0800

...generating the output that will be included in your documentation. That
way, when the time comes to update the documentation, you will have much
less work to do.

Why include the JavaDoc output in some *other* documentation?

JavaDoc output is a fully hyperlinked document, presented in a format that is at least familiar to (and typically expected by) the programmers who will use the information.

Just edit the code comments, then generate and deliver the JavaDoc. That's the only practical way to be sure that the documentation matche the code, and *that's* perhaps the greatest benefit of embedding the documentation in the code.

--David

=========================================================================

A V A I L A B L E N O W ! http://www.html-indexer.com

HTML Indexer is still the easiest way to create and maintain real indexes
for web sites, intranets, HTML Help, JavaHelp, and other HTML documents.

---

References:
Re: Javadoc resources for tech writers?: From: Martin Polley

Previous by Author: Re: MS Word--Formatting text in cross reference fields
Next by Author: Re: Saying "RTFM" out loud
Previous by Thread: Re: Javadoc resources for tech writers?
Next by Thread: RE: Javadoc resources for tech writers?

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

---

---

---