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.
Re: API/javadoc - classes/methods that should not be public
Subject:Re: API/javadoc - classes/methods that should not be public From:Crescent Enterprise <cres -at- cres -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sat, 21 Apr 2001 15:01:19 -0400 (EDT)
On Fri, 20 Apr 2001, David Price wrote:
> Doing a little poll here,
I'd like to see a clean solution to this too, if someone's got one. In
the mean time whether to show the dirty linen or not would depend, for me,
on the state of the API and the expectations of the audience. Usually the
readers are technical and understand ragged edges. The
main concern would be to get warnings in the unsupported methods - put the
warnings at the method level and also a general warning up front.
I think I remember Microsoft getting castigated a few years
back for withholding parts of an API. You might ruffle some feathers doing
so, however well intentioned. A programmer isn't going to use an unsupported
part of an API, if he/she can avoid it, or at the very least they'll call
you to find out its status.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27. http://www.pdfconference.com.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.