From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751321AbdGQJUn (ORCPT ); Mon, 17 Jul 2017 05:20:43 -0400 Received: from mx2.suse.de ([195.135.220.15]:34242 "EHLO mx1.suse.de" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1751278AbdGQJUl (ORCPT ); Mon, 17 Jul 2017 05:20:41 -0400 Date: Mon, 17 Jul 2017 11:12:33 +0200 From: Jan Kara To: sayli karnik Cc: linux-ext4@vger.kernel.org, "Theodore Ts'o" , Jan Kara , linux-kernel@vger.kernel.org Subject: Re: [PATCH] fs: jbd2: transaction: Add kernel-doc parameter descriptions Message-ID: <20170717091233.GA18199@quack2.suse.cz> References: <20170626045022.GA32222@sayli-HP-15-Notebook-PC> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20170626045022.GA32222@sayli-HP-15-Notebook-PC> User-Agent: Mutt/1.5.24 (2015-08-30) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Mon 26-06-17 10:20:22, sayli karnik wrote: > Add function parameters in kernel-doc comments to fix warnings in the > Sphinx build: > transaction.c:511: warning: No description found for parameter 'type' > transaction.c:511: warning: No description found for parameter 'line_no' > > Signed-off-by: sayli karnik I'd suggest to have more useful description like below: > + * @type: type of handle the reason why transaction handle was started - one of EXT4_TH_ defines > + * @line_no: line number of handle the line from which the function was called (used for debug output) Honza -- Jan Kara SUSE Labs, CR