This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH 02/11] Generalize varobj iterator


On Tue, Jan 21, 2014 at 12:43 PM, Keith Seitz <keiths@redhat.com> wrote:
> [...]
>> diff --git a/gdb/varobj.h b/gdb/varobj.h
>> index 978d9b9..0f68311 100644
>> --- a/gdb/varobj.h
>> +++ b/gdb/varobj.h
>> @@ -308,6 +308,8 @@ extern int varobj_has_more (struct varobj *var, int
>> to);
>>
>>   extern int varobj_pretty_printed_p (struct varobj *var);
>>
>> +extern  struct cleanup *varobj_ensure_python_env (struct varobj *var);
>> +
>
>
> IIRC, we are now adding documentation near declarations, too. Many are often
> as simple as "See description in varobj.c."

I could be wrong of course, but the rules are either:

1) Document at point of definition, and nothing at point of declaration.

2) Document at point of declaration, and add a comment at point of
definition saying something along the lines of "See foo.h".
ref: grep -F '/* See' *.c

As for which to pick, I can argue either point, and don't impose a
particular choice, as long as the choice isn't imposed on me either.
doxygen can make this moot so I'm not worrying about it too much at the moment.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]