On Fri, 2008-09-12 at 22:28 +0200, Henrik Nordstrom wrote:
> On tor, 2008-09-11 at 09:54 -0600, Alex Rousskov wrote:
>
> > You mean as a large blob of comments at the end of some .h file? The
> > cons are:
>
> I think Adrian is thinking more of blobs next to the implementations
> (.cc)
>
>
> As
On tor, 2008-09-11 at 09:54 -0600, Alex Rousskov wrote:
> You mean as a large blob of comments at the end of some .h file? The
> cons are:
I think Adrian is thinking more of blobs next to the implementations
(.cc)
As time has passed a little I have this slightly refined view:
* Overview type d
On Thu, 2008-09-11 at 16:32 +0800, Adrian Chadd wrote:
> 2008/9/11 Alex Rousskov <[EMAIL PROTECTED]>:
>
> >> 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
2008/9/11 Alex Rousskov <[EMAIL PROTECTED]>:
>> 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 fo
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 cla
The current suggestions are:
.h (as a second-best as .dox in src/) -- Amos
.dox (in src/) -- Kinkie.
.h (longer documents in .dox in docs/ or src/) -- Henrik.
> > To clarify:
> >
> > Longer API documents, .dox file in docs/, or maybe src/ next to the .cc
> >
> > Basic rules the code need to fulfi
> sön 2008-04-20 klockan 22:14 -0600 skrev Alex Rousskov:
>> The current suggestions are:
>>
.h (as a second-best as .dox in src/) -- 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
>
> On Mon, 2008-04-21 at 00:55 +0200, Henrik Nordstrom wrote:
>> sön 2008-04-20 klockan 12:23 -0600 skrev Alex Rousskov:
>>
>> > At this point, I am interested in collecting formal API guarantees,
>> not
>> > writing a true Guide, but it feels like .dox files should go into
>> > doc/Programming-Guid
> On Thu, 2008-04-17 at 17:53 +1200, Amos Jeffries wrote:
>> Alex Rousskov wrote:
>> > Hello,
>> >
>> > Recent Squid3 discussions mentioned a set of rules or guarantees
>> for
>> > AsyncCalls and Comm APIs. Where do you think these things should be
>> > documented?
>> >
>> > * Source code, head
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
On Mon, 2008-04-21 at 00:55 +0200, Henrik Nordstrom wrote:
> sön 2008-04-20 klockan 12:23 -0600 skrev Alex Rousskov:
>
> > At this point, I am interested in collecting formal API guarantees, not
> > writing a true Guide, but it feels like .dox files should go into
> > doc/Programming-Guide.
>
> S
sön 2008-04-20 klockan 12:23 -0600 skrev Alex Rousskov:
> At this point, I am interested in collecting formal API guarantees, not
> writing a true Guide, but it feels like .dox files should go into
> doc/Programming-Guide.
Shouldn't thise go into the .h or .cc next to the code?
Regards
Henrik
On Sun, Apr 20, 2008 at 8:23 PM, Alex Rousskov
<[EMAIL PROTECTED]> wrote:
>
> On Thu, 2008-04-17 at 17:53 +1200, Amos Jeffries wrote:
> > Alex Rousskov wrote:
> > > Hello,
> > >
> > > Recent Squid3 discussions mentioned a set of rules or guarantees for
> > > AsyncCalls and Comm APIs. Where
On Thu, 2008-04-17 at 17:53 +1200, Amos Jeffries wrote:
> Alex Rousskov wrote:
> > Hello,
> >
> > Recent Squid3 discussions mentioned a set of rules or guarantees for
> > AsyncCalls and Comm APIs. Where do you think these things should be
> > documented?
> >
> > * Source code, header files:
Alex Rousskov wrote:
Hello,
Recent Squid3 discussions mentioned a set of rules or guarantees for
AsyncCalls and Comm APIs. Where do you think these things should be
documented?
* Source code, header files: More chances to keep the description up to
date and version-specific but in the way
Hello,
Recent Squid3 discussions mentioned a set of rules or guarantees for
AsyncCalls and Comm APIs. Where do you think these things should be
documented?
* Source code, header files: More chances to keep the description up to
date and version-specific but in the way of day-to-day developme
16 matches
Mail list logo
