Received: by 2002:a25:8b91:0:0:0:0:0 with SMTP id j17csp742908ybl; Thu, 23 Jan 2020 07:01:20 -0800 (PST) X-Google-Smtp-Source: APXvYqx/w/YrDJi09VZHwPEjG2Uy2IJdXgqXC0AXPTMlrfLiyg7krEjYioyTLAbI6pNtWbT1jzGW X-Received: by 2002:a9d:7f16:: with SMTP id j22mr11651160otq.256.1579791680697; Thu, 23 Jan 2020 07:01:20 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1579791680; cv=none; d=google.com; s=arc-20160816; b=nWA2VT7HuShVuelXoh9RGiuw6uz/5gqqlbM+Ae8XdSgNNtexA56Jx5izhrqHYtlehG 259YDDOrmyoo4P3ZBrIZKXBR8+OqxZ3kRLui3OY6JX3jj6QhUPRCFI96hM2dsuVf64q6 iipV5JPtXxIH9d0YA7kTSHP/Me5co9B/qysWInfk3iWVJA0D/VH7bGUZ2qsoT0sQ6klB ZEhzxqK93f7pyVo/BPR2ttbGWW66sF1MUB6veObPPl2wyHbyxCjH85LhOl9xTbIgXsQ2 NDCAyBQBNics2KEJgaNjln5/VybwA812IBI/wgrcq8/S7ZPwM773P2dpvpkJBFWlf5pn XUHA== 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=/JqL34e2FieELlfLiZBR3VwpC5C3KW729r12Xw+yGEY=; b=WkNGPAv5MN2ZnVwAGCXABxaEvtwqSbo3AIplYI58Kp+DKecXtzTpt2/+8ufjnO5uwn XfkS1wrCiEGYpy+fxOYcbJcFvQ94+bTmMM/Hn9gCB7UCdJ4e/5kSEfjOMf9UmUBHJxR1 4TZvRiD2DYVw6qDrPx8PPanUwUR3OKMhK4l6u/SPd6RH8k1uLGr45aj8whTBZyeM2ewg IJauXO4ly+YqPcfZsu3CfZZav9ucIwZgm6VqgENjI1XUbCtF0bN0i+wHIpUExaBvouOc Ng/pnTk+je8BlId0CmHlJQaEeqUhPzGd+3wI33l+GXd2ZJF+filMH7ZUm7IkFtqq2XYl tXJw== 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 f4si874764oij.133.2020.01.23.07.01.08; Thu, 23 Jan 2020 07:01:20 -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 S1729143AbgAWO6K (ORCPT + 99 others); Thu, 23 Jan 2020 09:58:10 -0500 Received: from hostingweb31-40.netsons.net ([89.40.174.40]:49151 "EHLO hostingweb31-40.netsons.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726811AbgAWO6J (ORCPT ); Thu, 23 Jan 2020 09:58:09 -0500 Received: from [109.168.11.45] (port=47594 helo=pc-ceresoli.dev.aim) by hostingweb31.netsons.net with esmtpa (Exim 4.92) (envelope-from ) id 1iudvr-0005F5-0I; Thu, 23 Jan 2020 15:58:07 +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 16/28] docs: i2c: smbus-protocol: fix kernel-doc function syntax Date: Thu, 23 Jan 2020 15:56:14 +0100 Message-Id: <20200123145626.8102-3-luca@lucaceresoli.net> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200123145626.8102-1-luca@lucaceresoli.net> References: <20200123135103.20540-1-luca@lucaceresoli.net> <20200123145626.8102-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 Reviewed-by: Jean Delvare --- 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.25.0