lkml.org 
[lkml]   [2020]   [Jan]   [5]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH 07/26] docs: i2c: i2c-protocol: fix kernel-doc function syntax
Date
This clarifies these are functions and adds a hyperlink to the function
documentation.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
---
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
\
 
 \ /
  Last update: 2020-01-05 23:52    [W:0.248 / U:0.272 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site