From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <korablev@tarantool.org>
Received: from smtpng3.m.smailru.net (smtpng3.m.smailru.net [94.100.177.149])
 (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 2893346970E
 for <tarantool-patches@dev.tarantool.org>;
 Thu, 30 Jan 2020 01:32:20 +0300 (MSK)
Date: Thu, 30 Jan 2020 01:32:19 +0300
From: Nikita Pettik <korablev@tarantool.org>
Message-ID: <20200129223219.GC16149@tarantool.org>
References: <cover.1579874461.git.roman.habibov@tarantool.org>
 <0d014c80710b24bcfc6380957fcc90b955536599.1579874461.git.roman.habibov@tarantool.org>
 <20200128174449.GB1049@tarantool.org>
 <f51b8b06-f090-7d21-bffe-b9c1b54e61d0@tarantool.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
In-Reply-To: <f51b8b06-f090-7d21-bffe-b9c1b54e61d0@tarantool.org>
Subject: Re: [Tarantool-patches] [PATCH 1/2] sql: refactor index drop code
List-Id: Tarantool development patches <tarantool-patches.dev.tarantool.org>
List-Unsubscribe: <https://lists.tarantool.org/mailman/options/tarantool-patches>, 
 <mailto:tarantool-patches-request@dev.tarantool.org?subject=unsubscribe>
List-Archive: <https://lists.tarantool.org/pipermail/tarantool-patches/>
List-Post: <mailto:tarantool-patches@dev.tarantool.org>
List-Help: <mailto:tarantool-patches-request@dev.tarantool.org?subject=help>
List-Subscribe: <https://lists.tarantool.org/mailman/listinfo/tarantool-patches>, 
 <mailto:tarantool-patches-request@dev.tarantool.org?subject=subscribe>
To: Vladislav Shpilevoy <v.shpilevoy@tarantool.org>
Cc: tarantool-patches@dev.tarantool.org

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 <word>
> > 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?