Re: Where to document APIs?

On Mon, 2008-04-21 at 07:00 +0200, Henrik Nordstrom wrote:
> sön 2008-04-20 klockan 22:14 -0600 skrev Alex Rousskov:
> > The current suggestions are:
> >
> > .dox (in docs/Programming Guide or in src/, not clear) -- Amos.
> > .dox (in src/) -- Kinkie.
> > .h (or perhaps .cc) -- Henrik.
>
> To clarify:
>
> Longer API documents, .dox file in docs/, or maybe src/ next to the .cc
>
> Basic rules the code need to fulfill, or until the API documentation
> grows large, in the .h or .cc file.

You all have seen the current API notes for Comm and AsyncCalls. Do you
think they should go into a .dox or .h file?

I think they are big enough (and growing) to justify a .dox file. I will
probably add those files to trunk (next to the corresponding .h files)
unless there are better ideas.

Thank you,

Alex.
Received on Thu Sep 11 2008 - 06:49:17 MDT