On Tuesday 17 June 2008 15:01:43 [EMAIL PROTECTED] wrote: > Log: > [src/gc] Add some basic function-level documentation to src/gc/memory.c as > per RT#48260. More is needed, but I've covered the basics.
Excellent. One thing most people don't notice -- neither criticism nor concern, but a tiny bit of polish I try to apply: > Modified: trunk/src/gc/memory.c > =========================================================================== >=== --- trunk/src/gc/memory.c (original) > +++ trunk/src/gc/memory.c Tue Jun 17 15:01:43 2008 > @@ -30,7 +30,8 @@ > > =item C<void * mem_sys_allocate> > > -Uses C<malloc> to allocate system memory. > +Uses C<malloc> to allocate system memory. Panics if the system cannot > +return memory. Indicative mood. > @@ -203,7 +209,10 @@ > > =item C<void * mem__internal_realloc> > > -RT#48260: Not yet documented!!! > +Resize a chunk of system memory. Unlike realloc(), it can handle a > +NULL pointer, in which case you get a malloc back. If > +C<DETAIL_MEMORY_DEBUG> macro is defined, prints debug information to > +C<STDERR>. Imperative mood. Subtle, but I like the consistency of all indicative all the time. Anyone have any comments, or are you all rolling your eyes and looking up grammatical moods on Wikipedia now? -- c
