Re: [asycxx-devel] Documentation changes query

[Karthik B. <ka...@hi...>]

2009/3/17 Joe Steeve <js...@hi...>

> Ideally, the 'api documentation' should be in the header files. i.e.,
> anyone who wants to use the API should be looking into the header files
> and not the .cxx files. So, the doxygen comments that describe the API
> should be in the .h files. The .cxx files should have comments that
> explain how things work. But, these comments need not go into doxygen.


Alright. I got few files fixed as noted. But I wasn't sure if i was on the
right
track. I'll send you the patch file tonight/later this evening.


> Yeah, as first step, all the classes should be documented. So, if there
> is missing documentation, please add it.


Ok.

I need 1 more clarification. There is a file core.cxx which is not part
of/class
in itself. Should I alter this file and call it say Utils class ? Since this
method
is used within the asycxx code, i'll create the class structure in the .cxx
file
itself.

-- 
Karthik

HiPro IT Solutions Pvt. Ltd.
http://hipro.co.in/