Re: Intro to phases of creating API documentation

Subject: Re: Intro to phases of creating API documentation
From: "Guy K. Haas" <guy -at- hiskeyboard -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 08 Nov 2005 17:45:35 -0800


Another thing one has to watch out for in Javadoc/Doxygen environments is code elements that are marked public for arcane archtectural reasons but should not be revealed to the world. The architects sometimes create problems like this, and it's up to the toolsmiths to be sure to provide supression codes for those portions.

--Guy K. Haas
Software Exegete in Silicon Valley



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Try WebWorks ePublisher Pro for Word today! Smooth migration of legacy
RoboHelp content into your new Help systems. EContent Magazine Decision-
maker review (October 2005) is here: http://www.webworks.com/techwr-l

Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: Re: Job/social networking tools
Next by Author: Re: Editing Question--Punch list or Punchlist?
Previous by Thread: RE: Intro to phases of creating API documentation
Next by Thread: re native speakers


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

Sponsored Ads


Sponsored Ads