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: help: tips from c++ api writers From:"Gilger.John" <JGilger -at- acresgaming -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 5 Apr 2001 08:26:22 -0700
If you understand Java, you should have a reasonably good basic
understanding of C++, since Java is based on C++.
Header files normally have a ".h" extension. That is the convention in C,
which C++ is based upon. You may see extensions like ".hxx" or something.
Header files are part of programming libraries. They refer the compiler to
the library containing the definitions and functions used in the progrram.
For instance, the line "#include <iostream>" tells the compiler to look in
the iostream file in the standard C++ library to find out what "cout <<
endl" means. It is similar in function to the "import" keyword in Java.
Libraries are simply a collection of program functions, variables, etc.
bundled for reuse in other programs.
All source files in a C/C++/Java program are text files that can be read in
a simple text editor such as emacs, vi, or notepad. So go to the source and
have a ball ;)
HTH, if you have other questions I can help with, let me know.
Senioir Technical Writer
Acres Gaming, Inc.
From: Carol Chung [mailto:cychung55 -at- hotmail -dot- com]
Sent: Wednesday, April 04, 2001 06:08 PM
Subject: help: tips from c++ api writers
I don't really know c++ but was asked to document an api on short notice.
I'm expecting some info from the developer but don't know how much detail
he'll provide. If I have to, I heard that you can extract info from header
files. Do you know what the file extension for those are? Do you have any
sample header file to show me what I should look for? A fake example would
I have understanding from Java code how to tell what classes, methods,
parameters, return types look like but am not sure how different this may be
for c++. Are header files in text format or do I need Visual Studio to view
*** 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.