Re: ISO: Urgent Documentation help

Hi

I ASS-U-ME you are interested in creating an API document
for users of your code.  If so then any of the links below
should be helpful.  If you're taling about specific usage
information and design information (including UML
diagrams), then this will be a much longer email.  

Remember the auto-documentation generation tools ( i.e.
doxygen) are only as good as the comments you write in your
source code!  If your comments don't match what the code
does, or you enter simple one line phrases which do not
have any more information than what the user would assume
from reading the name of the function, it won't help you
very much.

Proper documentation (or man pages) takes a significant
amount of work. The idea behind documentation generation
tools, is that you if you had good design documentation,
and wrote detailed initial comments BEFORE you wrote your
code, then your generated API documentation should be in
good shape.


try some useful links:

http://en.wikipedia.org/wiki/Software_documentation
http://en.wikipedia.org/wiki/List_of_documentation_generators

cool documentation generation tool:
  http://www.stack.nl/~dimitri/doxygen/

http://tools.openoffice.org/
http://tools.openoffice.org/autodoc/HowToWriteDocumentation-Cpp.html


happy coding!



--- santash sarkar <[email protected]> wrote:

> Please provide me help on how to document a c++
> project,i've completed the coding already!
>   thanking you
> 
> 				





 
Yahoo! Groups Links

<*> To visit your group on the web, go to:
    http://groups.yahoo.com/group/cppug/

<*> To unsubscribe from this group, send an email to:
    [email protected]

<*> Your use of Yahoo! Groups is subject to:
    http://docs.yahoo.com/info/terms/