From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by turing.freelists.org (Avenir Technologies Mail Multiplex) with ESMTP id EE6CF2A784 for ; Fri, 29 Mar 2019 14:15:57 -0400 (EDT) Received: from turing.freelists.org ([127.0.0.1]) by localhost (turing.freelists.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id szVz-NOvHnVY for ; Fri, 29 Mar 2019 14:15:57 -0400 (EDT) Received: from smtpng2.m.smailru.net (smtpng2.m.smailru.net [94.100.179.3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by turing.freelists.org (Avenir Technologies Mail Multiplex) with ESMTPS id 1CD0A27AAB for ; Fri, 29 Mar 2019 14:15:57 -0400 (EDT) From: "n.pettik" Message-Id: <611549C1-8E50-42E2-9242-1E5CE9AE4D74@tarantool.org> Content-Type: multipart/alternative; boundary="Apple-Mail=_780F0561-8B2E-454A-8688-01DEADEE8044" Mime-Version: 1.0 (Mac OS X Mail 12.2 \(3445.102.3\)) Subject: [tarantool-patches] Re: [PATCH v2 2/4] sql: refactor getNewIid() function Date: Fri, 29 Mar 2019 21:15:54 +0300 In-Reply-To: <32bf26dc-79ef-6bee-725a-2e1acf37d297@tarantool.org> References: <2047d49bec832a3c6c639b253fda249225b9c8ea.1553729426.git.korablev@tarantool.org> <32bf26dc-79ef-6bee-725a-2e1acf37d297@tarantool.org> Sender: tarantool-patches-bounce@freelists.org Errors-to: tarantool-patches-bounce@freelists.org Reply-To: tarantool-patches@freelists.org List-Help: List-Unsubscribe: List-software: Ecartis version 1.0.0 List-Id: tarantool-patches List-Subscribe: List-Owner: List-post: List-Archive: To: tarantool-patches@freelists.org Cc: Vladislav Shpilevoy --Apple-Mail=_780F0561-8B2E-454A-8688-01DEADEE8044 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=us-ascii >> 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); >> } >>=20 >> -/* >> - * 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. >=20 > 1. According to doxygen docs = 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. >=20 > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D >=20 > commit 9e77985d09e53332d87b323c6ef74b747c418d8e > Author: Vladislav Shpilevoy > > Date: Thu Mar 28 15:53:24 2019 +0300 >=20 > Review fix Thx, applied. --Apple-Mail=_780F0561-8B2E-454A-8688-01DEADEE8044 Content-Transfer-Encoding: quoted-printable Content-Type: text/html; charset=us-ascii

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

=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D

commit = 9e77985d09e53332d87b323c6ef74b747c418d8e
Author: Vladislav Shpilevoy <v.shpilevoy@tarantool.org>
Date:   Thu Mar 28 15:53:24 2019 +0300

   Review = fix

Thx, = applied.


= --Apple-Mail=_780F0561-8B2E-454A-8688-01DEADEE8044--