[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [glob2-devel] changes for CVS
From: |
Stéphane Magnenat |
Subject: |
Re: [glob2-devel] changes for CVS |
Date: |
Sat, 14 Jan 2006 11:10:32 +0100 |
User-agent: |
KMail/1.9.1 |
Hi, let me endorse my blue helmet and explain a bit, because I think there is
a missunderstanding.
The idea is to put fonction documentation for the caller in the cpp file, so
that a nice doxygen documentation is generated. Of course, there will still
be function implementation documentation inside the function itself.
This has two advantages :
- The people that want to learn and explore the API can do it with a
convenient hyperlinked set of html pages.
- The people that know the code can easily have an overview of a class by
looking at a header file.
I plan to put online on www.globulation2.org (Kyle, could you install doxygen
please, thx :-)), a daily generated code documentation so that you don't need
a local doxygen in order to use it.
Steph
--
http://nct.ysagoon.com