[Psi-devel] Re: Psi Documentation

[Kevin Smith]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1


On 18 Mar 2005, at 23:25, Michail Pishchagin wrote:
> Kevin Smith wrote:
>> 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?
>
> There is one or two classes in Psi, that are self-contained in one .h 
> file.
> What should I do with them?

If we're doccing all classes in the .h files, the ones that're only .h 
files shouldn't be a problem, just put it in the .h files :)
/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
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (Darwin)

iD8DBQFCO2S2eZW+oiKW71URAvUVAJ9P04DxfxHqiSyBcrybrlFpwXzDBACfcYTr
f1mStubKxQpWTfo9N4abT3Y=
=Pev0
-----END PGP SIGNATURE-----