Received: by 2002:a25:8b91:0:0:0:0:0 with SMTP id j17csp20913412ybl; Sun, 5 Jan 2020 14:52:16 -0800 (PST) X-Google-Smtp-Source: APXvYqzFfAapQQFqX50tWuxWf516PkNygEzsaKcrr5HrwtxcRdFpEiJCS5GZAeO+HDyFzjcKVf/b X-Received: by 2002:a9d:3a65:: with SMTP id j92mr113480154otc.37.1578264736293; Sun, 05 Jan 2020 14:52:16 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1578264736; cv=none; d=google.com; s=arc-20160816; b=yZFwzeJrBV2Xvbo2LF+lJvixqNoa3F1CgVTNaGe+F3Y9sSx/FezH/ob/NHbJjydmaR aVXWzsx6VLjsiafXinFaZlXdFg6vKAU4fXATkPE8ClFkPazSBTxw4Ww+PomZvw7LT9w5 4ERt5gIIVu3TSXq+DhSrg6rfoNKW3p2IoD8oBst5XgZGvVmfCdFKxdaH+vV9MTLkhHZH mah1FcQICVZ3XvM2Nnz89o1+EvIVodP5JBhqHGN99+GnKkUKqz99Ac4vI30Dk+20mxgK xBD8HUiQ7lvy7mZSbYJaT08XN/t5IN96gd7Qwoodsw+vy3iRP0/cYY4ZKNxfiAtgsGJ3 RUqg== 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=BBErv8gFPjK9hX9R3JHobs0eWQp0LL8bjSb5oXRR258=; b=GSutsSFZiuH/bJTDuYDglV0FMLnB8Ehw67KRyXDG6k6eiNhq0M08Q3i7QgxRI4K3k+ Qht3wcvTj2uoO5vMM3InOzXu/M0idP018R5vQvFplhCv0Dgq+pQRNknRLJsou7m9EwsX G5f9n/fo1NSDksoXiygptt27cDjzE+jrMDhSXUBQco6SBJ6aV3bbfkTuH19U4mQv8X3h FxYqebI6aBEWtF8ANcYTBeS/qD1noFRPnoiMrkR08P06XFOUOLcB0bnI5tkg77OmAvfK 0wQmeCUH2C5345e+zKwST7ceIetoz9hi0SNsv7n7a8vLOR9n7dzv/WQCW4nafRbiVDik Z1Zg== 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 a10si18213335oid.84.2020.01.05.14.52.04; Sun, 05 Jan 2020 14:52:16 -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 S1727331AbgAEWvK (ORCPT + 99 others); Sun, 5 Jan 2020 17:51:10 -0500 Received: from hostingweb31-40.netsons.net ([89.40.174.40]:59427 "EHLO hostingweb31-40.netsons.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727201AbgAEWvJ (ORCPT ); Sun, 5 Jan 2020 17:51:09 -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 1ioEji-00GSqI-O9; Sun, 05 Jan 2020 23:51:06 +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 07/26] docs: i2c: i2c-protocol: fix kernel-doc function syntax Date: Sun, 5 Jan 2020 23:49:53 +0100 Message-Id: <20200105225012.11701-7-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 adds a hyperlink to the function documentation. Signed-off-by: Luca Ceresoli --- 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.24.1