[tarantool-patches] Re: [PATCH v2 2/4] sql: refactor getNewIid() function

["n.pettik" <korablev@tarantool.org>]

[-- Attachment #1: Type: text/plain, Size: 1609 bytes --]


>> diff --git a/src/box/sql/build.c b/src/box/sql/build.c
>> index 8fb001433..f55f6d800 100644
>> --- a/src/box/sql/build.c
>> +++ b/src/box/sql/build.c
>> @@ -1918,45 +1918,43 @@ sql_drop_foreign_key(struct Parse *parse_context)
>> 	sqlVdbeChangeP5(sqlGetVdbe(parse_context), OPFLAG_NCHANGE);
>> }
>> 
>> -/*
>> - * Generate code to determine next free Iid in the space identified by
>> - * the iSpaceId. Return register number holding the result.
>> +/**
>> + * Generate code to determine next free index id in
>> + * the space identified by the @space_id.
> 
> 1. According to doxygen docs http://www.doxygen.nl/manual/commands.html <http://www.doxygen.nl/manual/commands.html>
> there is no such a command as @space_id. But obviously I know what
> you've implied here. For references to parameters we use '@a' before a
> parameter. Like this:
>    ...
>    * the space identifier by @a space_id.
>    ...

Does anybody even try to generate doxygen doc?
I still believe that doxygen format may be useful only
for external (aka interface) functions. The rest of comments
(especially for static funcs) are seem to be aimed solely at
developers.

> Note that I deliberately used @return instead of @retval, because
> @return has no arguments - it is just a description.
> 
> =================================================================
> 
> commit 9e77985d09e53332d87b323c6ef74b747c418d8e
> Author: Vladislav Shpilevoy <v.shpilevoy@tarantool.org <mailto:v.shpilevoy@tarantool.org>>
> Date:   Thu Mar 28 15:53:24 2019 +0300
> 
>    Review fix

Thx, applied.



[-- Attachment #2: Type: text/html, Size: 15241 bytes --]