From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp32.i.mail.ru (smtp32.i.mail.ru [94.100.177.92]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dev.tarantool.org (Postfix) with ESMTPS id E6F4446970E for ; Thu, 30 Jan 2020 02:45:06 +0300 (MSK) References: <0d014c80710b24bcfc6380957fcc90b955536599.1579874461.git.roman.habibov@tarantool.org> <20200128174449.GB1049@tarantool.org> <20200129223219.GC16149@tarantool.org> From: Vladislav Shpilevoy Message-ID: <00024a0d-ff5c-deea-a3d9-89ac46a3903d@tarantool.org> Date: Thu, 30 Jan 2020 00:45:03 +0100 MIME-Version: 1.0 In-Reply-To: <20200129223219.GC16149@tarantool.org> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Subject: Re: [Tarantool-patches] [PATCH 1/2] sql: refactor index drop code List-Id: Tarantool development patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Nikita Pettik Cc: tarantool-patches@dev.tarantool.org On 29/01/2020 23:32, Nikita Pettik wrote: > On 29 Jan 22:56, Vladislav Shpilevoy wrote: >>>> diff --git a/src/box/sql/build.c b/src/box/sql/build.c >>>> index bc50ecbfa..58a6a8a6b 100644 >>>> --- a/src/box/sql/build.c >>>> +++ b/src/box/sql/build.c >>>> @@ -1469,6 +1469,26 @@ vdbe_emit_stat_space_clear(struct Parse *parse, const char *stat_table_name, >>>> sql_table_delete_from(parse, src_list, where); >>>> } >>>> >>>> +/** >>>> + * Generate VDBE program to remove entry with @a index_id and @a >>>> + * space_id from _index space. >>> >>> Is @a common shortcat for @param? If so, please share a link to docs, >>> since I've managed to find only this: >>> ''' >>> \a >>> Displays the argument in italics. Use this command to emphasize words. >>> Use this command to refer to member arguments in the running text. >>> ''' >> >> We use @param when describe parameters. In @brief sections we use @a >> intentionally. Probably because >> >> 1) @param is used to attach a description to a paramter, and for >> nothing else: http://www.doxygen.nl/manual/commands.html#cmdparam >> >> 2) @a is just shorter, and we can use parameter name multiple times >> in @brief, so it is important. > > Is this undocumented doxygen feature?:) I failed to find out any description > of '@a' command except for the one I posted above. Or this is purely Tarantool's > codestyle convention? Why undocumented? It is documented, and you've found a correct description. @a is just an italic font for a next word. It is not for parameter names only, and is not related to @param. We use it so as parameter names in function descriptions would be highlighted somehow. Don't know why exactly @a was chosen instead of, for example, @b (bold) or @c (typewriter font).