Received: by 2002:a25:8b91:0:0:0:0:0 with SMTP id j17csp20914215ybl; Sun, 5 Jan 2020 14:53:52 -0800 (PST) X-Google-Smtp-Source: APXvYqyd74tzWD9jAiOraqM2+vZc8Ca/WlC7Rjm84F3RfRZH+CPJ9xnp+NM1vQZYo+BcTPJXn1rP X-Received: by 2002:a9d:7d99:: with SMTP id j25mr95987841otn.226.1578264832385; Sun, 05 Jan 2020 14:53:52 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1578264832; cv=none; d=google.com; s=arc-20160816; b=qghuRWvrl4mISy1plJt5h+CU1SOROGqacYosKEOJtMgAAHq1Ij3UuJZYDyLBOO4+Xi jf+b4L7c0h6Kij9kGLtYa3eYE610bU3KxReUgHMCgQuyt0AuWT/G5ZoJfDwdIgH1uNAZ 4vC9Di5jjAtBPpiqBcldU4VqufFLB5RllDCqT9eiXnKgaKu4woAqcWxrlji0gfgCmUMq 1tSUx1GLNmQmP9qQhLVS0WQJSBBhXJH3MVX5ZMltX9Pp/bFKV7nXkXprt9rMW2qtyXMK p7a1W7MzV4AOEdykKdAwjHAxO/2AJUwn03CWiaNupuUonrlhLRnNgJGljZV/0xVs7ZRC sj4g== 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; bh=Qxb5JxUgLvoG+CbbXc/LTX9BpRMJ29VlFBK8k46pbDw=; b=QTwUwKpgLIZ/PKvyWRLZPBDv9/bv0T73dylvoTWFiTrSJ7+Hv33hcYsjcea7UW0DMi h7+JludJEylg/ppnqmaRX5SsMzwBpKnZC/JgJnB1YHkC/NmhZE+ROFkjLaKacBazV62e F0YSAFzXmwhrOPj8SxlPozUYfPGjb7igDbBb1GO3aoUsty8LO+zijMLTyfXUdaVZCW7A 0s4uxw7TZ66SUMsrfBZ4mIRFiGurKQOC8n4gzKwmyXOj3IGq9HHVHR9on+6OgoHa7C0a Oc7TqdxHBIiK44xXzzuGlapul9ITtVkeitPh5yXG3quioReR75sMRcwC4kH18/l4pt6I 2jyQ== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id k131si27612528oia.64.2020.01.05.14.53.40; Sun, 05 Jan 2020 14:53:52 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727467AbgAEWvm (ORCPT + 99 others); Sun, 5 Jan 2020 17:51:42 -0500 Received: from hostingweb31-40.netsons.net ([89.40.174.40]:44712 "EHLO hostingweb31-40.netsons.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727189AbgAEWvi (ORCPT ); Sun, 5 Jan 2020 17:51:38 -0500 Received: from [37.160.42.38] (port=5507 helo=melee.fritz.box) by hostingweb31.netsons.net with esmtpa (Exim 4.92) (envelope-from ) id 1ioEkB-00GSqI-BC; Sun, 05 Jan 2020 23:51:35 +0100 From: Luca Ceresoli To: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org Cc: Luca Ceresoli , Wolfram Sang , Peter Rosin , linux-kernel@vger.kernel.org Subject: [PATCH 16/26] docs: i2c: smbus-protocol: fix kernel-doc function syntax Date: Sun, 5 Jan 2020 23:50:02 +0100 Message-Id: <20200105225012.11701-16-luca@lucaceresoli.net> X-Mailer: git-send-email 2.24.1 In-Reply-To: <20200105225012.11701-1-luca@lucaceresoli.net> References: <20200105224006.10321-1-luca@lucaceresoli.net> <20200105225012.11701-1-luca@lucaceresoli.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - hostingweb31.netsons.net X-AntiAbuse: Original Domain - vger.kernel.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - lucaceresoli.net X-Get-Message-Sender-Via: hostingweb31.netsons.net: authenticated_id: luca+lucaceresoli.net/only user confirmed/virtual account not confirmed X-Authenticated-Sender: hostingweb31.netsons.net: luca@lucaceresoli.net X-Source: X-Source-Args: X-Source-Dir: Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This clarifies these are functions (and would/will adds a hyperlink to the function documentation if/when documented). Signed-off-by: Luca Ceresoli --- Documentation/i2c/smbus-protocol.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/i2c/smbus-protocol.rst b/Documentation/i2c/smbus-protocol.rst index 997945e90419..3c0fb3a2044d 100644 --- a/Documentation/i2c/smbus-protocol.rst +++ b/Documentation/i2c/smbus-protocol.rst @@ -118,7 +118,7 @@ byte. But this time, the data is a complete word (16 bits):: Functionality flag: I2C_FUNC_SMBUS_READ_WORD_DATA -Note the convenience function i2c_smbus_read_word_swapped is +Note the convenience function i2c_smbus_read_word_swapped() is available for reads where the two data bytes are the other way around (not SMBus compliant, but very popular.) @@ -152,7 +152,7 @@ specified through the Comm byte.:: Functionality flag: I2C_FUNC_SMBUS_WRITE_WORD_DATA -Note the convenience function i2c_smbus_write_word_swapped is +Note the convenience function i2c_smbus_write_word_swapped() is available for writes where the two data bytes are the other way around (not SMBus compliant, but very popular.) -- 2.24.1