Received: by 2002:a05:6a10:6744:0:0:0:0 with SMTP id w4csp733161pxu; Fri, 23 Oct 2020 11:54:57 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwL9A1ZYlki5CesJAQg2MvAFn/RQQHfmYxi3bPrzgTTEqgHoOngx2KR9lCEhPnYmdhTXLKw X-Received: by 2002:a17:906:c00c:: with SMTP id e12mr3339388ejz.202.1603479297059; Fri, 23 Oct 2020 11:54:57 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1603479297; cv=none; d=google.com; s=arc-20160816; b=OtgoICdxS0OzVvQl7vhKHfOnw1jD2En4FcUkoLBqIzZ1qeDdSLt5uDFbyU82hIkH1z jR7wCxumFcfJXV/Lzcbv9C508YGzCXjybJm4ZXu0+aq4rUX30tPGNT0eQajVVRLJ+ShF Ce+6Zd+WlRBXTZC+MNRosFSVulroRHz74bcXNCt8LJcnNECuN11SJf2C8fMGLCMI6HNJ G6Ir2ka29pOhIqMvRkUd6cIXm+Y/asPUucn+Qwy/1jnlpVcsTPeqab/8NDuuMt0/+br4 yovdp/W2VSB0pt1koJt9wDuL4WmyithQK5hyXROl9BnoAuOsEvBEZ2k8UYqMsX52JE6O uuHg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=BYaLQq3XL4YLjltf6UlbdlkB/Xys5Fqr7ptSFKOXbAU=; b=qxnCX0pZEzrTEfYn/9tzHzb7f8wNhwCwrRrj27QqeFtkq1OulriMEhg+Ftz5vV6yA1 1F7IaSYr/Lym2d+u7ymBPW4sWQAl7SqpMswGafLeNMG/IVLymHtCsNfGo889EJvXlELM gX5PUGb26eOTHZW6Khxz/7+n2ZjomSA55arXvI0XiTMA99wIDLDG7D2uHayvE4JapsrR N1NpOg7SBm6LbdTi+b2HaqChykCZuqFhxWt2DcP41VBh7OJBEWXTmFZrE3rFUJJN8gid ImcoflnaCkdQ8RVujNtGTag9SXkGvLvSkKDAxkJCf+CoC2klP9l6ktDj4cLjX/xsOvhC uTug== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=PWKegXc4; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id r25si2119115edc.210.2020.10.23.11.54.34; Fri, 23 Oct 2020 11:54:57 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=PWKegXc4; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S461340AbgJWQeS (ORCPT + 99 others); Fri, 23 Oct 2020 12:34:18 -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