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.
Subject:Re: Info on API documentation From:"Janet Swisher" <swisher -at- enthought -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 9 Dec 2004 11:16:57 -0600
"Prashant Paigude" <prashant_paigude -at- persistent -dot- co -dot- in> wrote:
> I'm seeking guidelines and reference material on API Documentation.
> I've googled without much success. Pointers from you will be
> appreciated.
Your request is a bit vague, so I'm not sure what you're looking for.
Sun's article on "How to Write Doc Comments for the Javadoc Tool" can be
generalized to address style issues for API documentation for a variety of
programming languages. http://java.sun.com/j2se/javadoc/writingdoccomments/
ROBOHELP X5 - SEE THE ALL NEW ROBOHELP X5 IN ACTION!
RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo: http://www.macromedia.com/go/techwrldemo
---
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.
