[Psi-devel] Re: Psi Documentation

Kevin Smith kevin at kismith.co.uk
Fri Mar 18 12:28:30 PST 2005


On 18 Mar 2005, at 20:21, Remko Troncon wrote:
>> How do I document class methods?
>> Should I write in a header file, inside class definition? Or in cpp
> Header files are but compilation objects, sideeffects of the limits of 
> C++.
> The rule: put it with the definition. So, unless your definition of 
> your method is in the .h file (e.g. to have inlining), put it in the 
> .cpp file.

I disagree here, .cpp files are difficult enough to manage as it is, 
why not let the .h/.cpp artifact work for us a bit?
/K
--
Kevin Smith
Postgraduate Research Student, Computer Science, University Of Exeter
TaeKwon-Do Club Captain, University of Exeter.
Psi project lead/maintainer, http://psi.affinix.com



More information about the Psi-devel-affinix.com mailing list