Received: by 2002:a25:8b91:0:0:0:0:0 with SMTP id j17csp677265ybl; Thu, 23 Jan 2020 05:54:46 -0800 (PST) X-Google-Smtp-Source: APXvYqzGqnEBhq/aBH7G6nf/x+OwpquIrEJ26W0bm/0j7ooVfsJqwwSVN/YLhM9X+jENb7Fuupdc X-Received: by 2002:aca:4183:: with SMTP id o125mr10081347oia.125.1579787686616; Thu, 23 Jan 2020 05:54:46 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1579787686; cv=none; d=google.com; s=arc-20160816; b=MdHxAtn/2l0a8uaRmyhcdHdbG9dS+SLeqv/0s29SiZS+DmpMWxwdEcev7zwN3BqB41 lq5O5q0ydTjtNH+8r0o4e5Vwi2Mnj7OMdxSR+Ar2Sxi4oNEm7PGU1O3iwttyPYh0huaI Beut8Dd0CINgrx6LS6+4jjo++ggqXe10QIqqJmi/7mDU7wgQPQHKsregzgQr+Bl6QvEC 7utJWwwWYAuX8Hq/L5Ftdviacnoa1igMl6JOglHW6cRzpSsX7+MjfVYQW/ADTUKjkwq1 +UfqhAUG1hWtLWTbZPkTZe8wAKI1iT9aaZL+RFuHMIrk2dZ7C4L/gYnfILS5t7FHpj8B asJQ== 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=8liIxT6zLsfytV7ycihDKoHk54Jo0+bATH2tsr3ZYpg=; b=fGw3Te2CrOoeOWFjgeKG8Gwhv8lpim6D1GR4iKZhApT7z6kyLBToBHqYLzuXgW4nsZ hcTgU1+P0u44OZQWewKlbkPiLJKQqFfKaZ8yFyM3RJnpNA8YGu3h8G5aE+brwqQFRj4A E89dCodV1tWZQdZUFeqEoZ+qVAD8xAOKAonayDz7AVfjzzpc5PhpALJ6aOIcTZCKLwxr qLh+JeDo/TtBJ9nNcvQ/LeUTbyct+iM38O+6Z+bKC/cIrwJ5W1VvOYllLVGffsBMu97Y Nqd/UF+4PwIcg+7nXUFs2SGilg4gxAth4L+cfBZBuVONFcbGRnIVx9tMRkntmD4XOonN zdRQ== 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 12si761687oiz.131.2020.01.23.05.54.34; Thu, 23 Jan 2020 05:54:46 -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 S1728842AbgAWNxn (ORCPT + 99 others); Thu, 23 Jan 2020 08:53:43 -0500 Received: from hostingweb31-40.netsons.net ([89.40.174.40]:40925 "EHLO hostingweb31-40.netsons.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726729AbgAWNxn (ORCPT ); Thu, 23 Jan 2020 08:53:43 -0500 Received: from [109.168.11.45] (port=47192 helo=pc-ceresoli.dev.aim) by hostingweb31.netsons.net with esmtpa (Exim 4.92) (envelope-from ) id 1iucvU-000CNg-9u; Thu, 23 Jan 2020 14:53:40 +0100 From: Luca Ceresoli To: linux-i2c@vger.kernel.org, linux-doc@vger.kernel.org Cc: Luca Ceresoli , Wolfram Sang , Jean Delvare , Peter Rosin , linux-kernel@vger.kernel.org Subject: [PATCH v2 07/28] docs: i2c: i2c-protocol: fix kernel-doc function syntax Date: Thu, 23 Jan 2020 14:50:42 +0100 Message-Id: <20200123135103.20540-8-luca@lucaceresoli.net> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200123135103.20540-1-luca@lucaceresoli.net> References: <20200123135103.20540-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 adds a hyperlink to the function documentation. Signed-off-by: Luca Ceresoli Reviewed-by: Jean Delvare --- Documentation/i2c/i2c-protocol.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/i2c/i2c-protocol.rst b/Documentation/i2c/i2c-protocol.rst index 0222c97f3436..f289d7759a51 100644 --- a/Documentation/i2c/i2c-protocol.rst +++ b/Documentation/i2c/i2c-protocol.rst @@ -28,7 +28,7 @@ Count (8 bits): A data byte containing the length of a block operation. Simple send transaction ======================= -This corresponds to i2c_master_send:: +This corresponds to i2c_master_send():: S Addr Wr [A] Data [A] Data [A] ... [A] Data [A] P @@ -36,7 +36,7 @@ This corresponds to i2c_master_send:: Simple receive transaction ========================== -This corresponds to i2c_master_recv:: +This corresponds to i2c_master_recv():: S Addr Rd [A] [Data] A [Data] A ... A [Data] NA P @@ -44,7 +44,7 @@ This corresponds to i2c_master_recv:: Combined transactions ===================== -This corresponds to i2c_transfer +This corresponds to i2c_transfer(). They are just like the above transactions, but instead of a stop bit P a start bit S is sent and the transaction continues. An example of -- 2.25.0