Received: by 2002:a25:8b91:0:0:0:0:0 with SMTP id j17csp714891ybl; Wed, 29 Jan 2020 08:26:19 -0800 (PST) X-Google-Smtp-Source: APXvYqxuWwvzvMWxRMkiwWh+7PPZOXvdHbfLNU59jQryO62GoF2PXpEaGu0Cp3E1zJdPFlInPwSD X-Received: by 2002:aca:2416:: with SMTP id n22mr6626047oic.169.1580315179597; Wed, 29 Jan 2020 08:26:19 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1580315179; cv=none; d=google.com; s=arc-20160816; b=ZAy6FuWXqjJdTbXgy2uMfMXLKzuCqxrir83uYaf8Qe8traqNhrSKMFrsUqCOGURbrG zKSwZvDiiPA7qvmTmJKxROetRW3YeA7yI+rd66SQssC6p+S91y7NnG9ZhjhxgtReDOnp EYuettcn68keW9eHLOwdsr0a1C7G8gAJuvjJerTFx/gKwjPFZ/2Q4BHNpVW0ZNUxetFt NNx95bowM0U9z3Je1Xotd7RDfo1RROGeUoczmMAWtbAlgiJU0f77WhK6etDImaH8Y9bM A+OXWzAYlZHmWblLG6PXxbAlBujS/8kQlGEtNCnJB+YsO5xO4u70hQIvh70CkZrpzjCv itow== 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=arHDFWEcA4/scb86CwrGzLsiRNkZnqOSgSue85STbiE=; b=sIrPzfbcrExbkPoLr4Qbdnzy0N66GkLhnAjpb5O8OsDc8IAg0GdgLIFd+803OJc3ob zH3GZJNcxhFY78d4lV2KC0VjME2FfcPOHPZ5rYFVlpHNsjXzng17LCXPx34Duee5NozB 6Qf/svCon7Btiey4lrsF7MTrGFUyHIopIg+yHIFQz+w7ntDXBRj3wUCwmCPEgU1AoK3Z tiQUE2//oV8JWqE++syHQePRnVvxltyjScCzTkxVrUeucEfnvRn2pR/1cnTQuqIuyUDi rEiZQlDijABOuF6GAOBnxxuR0XD6+ZzCZy9Se3SAWheINVE/AMO1ADRlS7zbQVXq5/5y eYHg== 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 m24si1266428oic.11.2020.01.29.08.26.07; Wed, 29 Jan 2020 08:26:19 -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 S1727142AbgA2QWu (ORCPT + 99 others); Wed, 29 Jan 2020 11:22:50 -0500 Received: from hostingweb31-40.netsons.net ([89.40.174.40]:47246 "EHLO hostingweb31-40.netsons.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726645AbgA2QWt (ORCPT ); Wed, 29 Jan 2020 11:22:49 -0500 Received: from [109.168.11.45] (port=34038 helo=pc-ceresoli.dev.aim) by hostingweb31.netsons.net with esmtpa (Exim 4.92) (envelope-from ) id 1iwq74-005NDl-DZ; Wed, 29 Jan 2020 17:22:46 +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 v3 16/28] docs: i2c: smbus-protocol: fix kernel-doc function syntax Date: Wed, 29 Jan 2020 16:19:41 +0100 Message-Id: <20200129151953.31582-17-luca@lucaceresoli.net> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200129151953.31582-1-luca@lucaceresoli.net> References: <20200129151953.31582-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