From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 24739C63697 for ; Fri, 23 Oct 2020 16:34:25 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id C9EB2208C3 for ; Fri, 23 Oct 2020 16:34:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1603470864; bh=9Nh3/zUjIfiEVQ01kmUiyq82XA7e0shNpKQNIZuVNB0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=o51uof4kqCnK6WpSDKRj+D4TZkzQPBlQh3fVQX0Q8Thom35/DbdfhC7OzZbwOQoBk TPPxacH1kIYaGkX5wHmZ89QNiOpV2DAgButs2xAzsk1hQEOoBx30Atg4GG03++UhI9 aWj1ucHoU5tizo/Ty/jAK4zZq8gY8E1kU4SqgLFk= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1750902AbgJWQeV (ORCPT ); Fri, 23 Oct 2020 12:34:21 -0400 Received: from mail.kernel.org ([198.145.29.99]:33694 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751857AbgJWQdu (ORCPT ); Fri, 23 Oct 2020 12:33:50 -0400 Received: from mail.kernel.org (ip5f5ad5a3.dynamic.kabel-deutschland.de [95.90.213.163]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 741E8246C0; Fri, 23 Oct 2020 16:33:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1603470828; bh=9Nh3/zUjIfiEVQ01kmUiyq82XA7e0shNpKQNIZuVNB0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=PWKegXc41sR390mnbbSlOh1al/Q5gjHY78Ad/xOaAbLVBCVK1vslMxqoBCB/hDj3W 4Dw6BX6laEb6N4cvSjsDs4aRdIIMbLnNsbfwdbHB4DCxp2AdkbxX7Ojsq25RVSow8L AZZm2SXXeKVYyoq4vm6tCALx78e5mlw+sKKXcdog= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kW00g-002Ax7-BL; Fri, 23 Oct 2020 18:33:46 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Joel Fernandes (Google)" , "Jonathan Corbet" , "Peter Zijlstra (Intel)" , Davidlohr Bueso , Greg Kroah-Hartman , Thomas Gleixner , linux-kernel@vger.kernel.org Subject: [PATCH v3 39/56] completion: fix kernel-doc markups Date: Fri, 23 Oct 2020 18:33:26 +0200 Message-Id: <071fa0e17be1d7cfaf34440f4a5d302b05e28095.1603469755.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Kernel-doc only supports having the comment just before the identifier. The markup for init_completion is actually for __init_completion. Signed-off-by: Mauro Carvalho Chehab --- Thats said, IMHO, it would make sense to simply rename __init_completion() to init_completion() and drop this define: #define init_completion(x) __init_completion(x) Signed-off-by: Mauro Carvalho Chehab --- include/linux/completion.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/include/linux/completion.h b/include/linux/completion.h index bf8e77001f18..ff354918dbf4 100644 --- a/include/linux/completion.h +++ b/include/linux/completion.h @@ -29,6 +29,14 @@ struct completion { }; #define init_completion_map(x, m) __init_completion(x) + +/** + * init_completion - Initialize a dynamically allocated completion + * @x: pointer to completion structure that is to be initialized + * + * This macro will initialize a dynamically created completion + * structure. + */ #define init_completion(x) __init_completion(x) static inline void complete_acquire(struct completion *x) {} static inline void complete_release(struct completion *x) {} @@ -76,7 +84,7 @@ static inline void complete_release(struct completion *x) {} #endif /** - * init_completion - Initialize a dynamically allocated completion + * __init_completion - Initialize a dynamically allocated completion * @x: pointer to completion structure that is to be initialized * * This inline function will initialize a dynamically created completion -- 2.26.2