Re: Code docu, parameter validation, CMyString
Steffen Ryll <[email protected]> Fri, 30 Mar 2007 19:48:45 +0200
| Newsgroups | gmane.comp.security.passwordsafe.devel |
|---|---|
| Message-ID | <[email protected]> |
Hi,
Rony Shapiro wrote:
> - Doxygen is cool, and adding comments so that they can be parsed by it
> would be great. If you (or anyone) cares to write a "template" .h and .cpp
> file showing how to do this, that would help a lot.
I have just commited a doxygen config file and such a template .h and
.cpp file. I've also set an svn:ignore property, so that all generated
documentation HTMl files aren't listed as unversioned by Subversion.
All you have to do is downloading doxygen from www.doxygen.org and point
it to Doxyfile. Be sure that your working directory is the project
directory, otherwise it won't put the HTML where you expect it :-)
In the files DoxyTempl.{h,cpp} is a small intro to writing documentation
for and with doxygen.
Please let me know if you have any questions
Cheers,
Steffen
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys-and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV