Re: Where to document APIs?

2008/9/11 Alex Rousskov <rousskov_at_measurement-factory.com>:

>> 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.

Whats wrong with inline documentation again?

Adrian
Received on Thu Sep 11 2008 - 08:32:15 MDT