Skip to content

Commit 5a9f4d3

Browse files
committed
docs: Fix all build warning.
Signed-off-by: zhanglinjing <Linjing.Zhang@infineon.com>
1 parent 65f8e14 commit 5a9f4d3

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

docs/arduino-deviations.rst

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,14 @@ XMC1400 Kit for Arduino - Interrupt 1 and serial conflict
5050
When using the **KIT_XMC1400_ARDUINO** **Interrupt** 1 does not work when serial (UART) is used.
5151
The Pin Mapped to **Interrupt 1** shares the **same hardware bus configuration as UART**.
5252

53-
**Impact..**
53+
**Impact:**
54+
5455
- Interrupt will not trigger.
5556
- Serial communication also not work.
5657

5758
**Workarounds:**
58-
- use a **Interrupt 0"
59+
60+
- use **Interrupt 0**
5961

6062
Wire/I2C Differences
6163
++++++++++++++++++++
@@ -159,14 +161,18 @@ Analog pins for XMC14_2GO
159161
-------------------------
160162

161163
On the **XMC14_2GO board**, **pins 12 and 13 are incorrectly named**
164+
162165
- Correct mapping:
163-
-pin 12 -> 'A1'
164-
-pin 13 -> 'A0'
166+
167+
- pin 12 -> 'A1'
168+
- pin 13 -> 'A0'
165169

166170
**Correct Usage:**
167-
Use the analog pin defintions instead of 12 and 13 numbers:
168-
analogRead(A0); //Instead of using pin 12
169-
analogRead(A1); //Instead of using pin 13
171+
172+
Use the analog pin defintions instead of 12 and 13 numbers::
173+
174+
analogRead(A0); //Instead of using pin 12
175+
analogRead(A1); //Instead of using pin 13
170176

171177
I2C Analog pins
172178
^^^^^^^^^^^^^^^
@@ -197,11 +203,11 @@ function, or other case as described below.
197203
- | A10 + A11 are alternate pin
198204
| configurations to I2C
199205
* - KIT_XMC1400_ARDUINO
200-
- Alternate pin function
201-
- Matches Arduino Uno
202-
- External hard wired pins
206+
- | Alternate pin function
207+
| Matches Arduino Uno
208+
| External hard wired pins
203209
- | For 3V3 boards set I2C pins to tristate or open drain to use
204-
| For 5V boards refer to [this section](https://xmc-arduino.readthedocs.io/en/latest/hw-platforms.html#connected-i2s-and-analog-pins) on track cuts to enable A4 and A5 to work
210+
| For 5V boards refer to `this section <https://xmc-arduino.readthedocs.io/en/latest/hw-platforms.html#connected-i2s-and-analog-pins>`_ on track cuts to enable A4 and A5 to work
205211
| Level shifter on the 5V board could interfere with tristate/open drain setting
206212
* - KIT_XMC47_RELAX (and variants)
207213
- External hard wired pins
@@ -228,7 +234,7 @@ via the Tools menu as shown in the picture below.
228234
:width: 600
229235

230236
This is generally the case for most of the XMC boards. However, for boards
231-
such as the :ref:`xmc4700-relax`, both the serial
237+
such as the :ref:`KIT_XMC47_RELAX`, both the serial
232238
output modes are simultaneously active and need not be selected or enabled from the menu.
233239

234240
Note: Please note that the sketch must be recompiled when a different serial

docs/hw-platforms.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ on the board itself. If you want to use them check out the subsection :ref:`conn
151151
.. _connected_pins:
152152

153153
Connected I2S and Analog pins
154-
^^^^^^^^^^^^^^^^^^
154+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
155155

156156
For the ``KIT_XMC47_RELAX`` the Arduino pin number ``15`` & ``21`` (``SCL`` & ``A5``) and Arduino
157157
pin number ``14`` & ``20`` (``SDA`` & ``A4``) are connected with each other on the board itself. Although they are different physical pins of the microcontroller,

0 commit comments

Comments
 (0)