Skip to content

Commit 2b91aba

Browse files
committed
Fix Class documentation
1 parent 3df057f commit 2b91aba

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ The serial port should already be initialised when initialising this library.
6868
RUI3(Stream &serial1, Stream &serial);
6969
```
7070
### Parameters:
71-
@param serial1 Serial for responses from RUI3 module: WisDuo ==> host MCU
72-
@param serial Serial for communication with RUI3 module: host MCU ==> debug console
71+
@param serial1 Serial for communication with RUI3 module: WisDuo <==> host MCU
72+
@param serial Serial for debug: host MCU <==> debug console
7373
7474
### Usage:
7575
```cpp

docs/class_r_u_i3.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -330,9 +330,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4f62f64d335005699f9134fc
330330
<div class="ttc" id="aclass_r_u_i3_html"><div class="ttname"><a href="class_r_u_i3.html">RUI3</a></div><div class="ttdef"><b>Definition</b> rui3_at.h:102</div></div>
331331
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
332332
<table class="params">
333-
<tr><td class="paramname">serial1</td><td>Serial for responses from <a class="el" href="class_r_u_i3.html">RUI3</a> module: WisDuo ==&gt; host MCU <br />
333+
<tr><td class="paramname">serial1</td><td>Serial for communication with <a class="el" href="class_r_u_i3.html">RUI3</a> module: WisDuo &lt;==&gt; host MCU <br />
334334
</td></tr>
335-
<tr><td class="paramname">serial</td><td>Serial for communication with <a class="el" href="class_r_u_i3.html">RUI3</a> module: host MCU ==&gt; debug console</td></tr>
335+
<tr><td class="paramname">serial</td><td>Serial for debug: host MCU &lt;==&gt; debug console</td></tr>
336336
</table>
337337
</dd>
338338
</dl>

src/rui3_at.h

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -101,20 +101,20 @@ typedef struct _p2p_settings
101101
class RUI3
102102
{
103103
public:
104-
/**
105-
* @brief Construct a new RUI3 object
106-
* A simplified constructor taking only a Stream ({Software/Hardware}Serial) object.
104+
/**
105+
* @brief Construct a new RUI3 object
106+
* A simplified constructor taking only a Stream ({Software/Hardware}Serial) object.
107107
* The serial port should already be initialised when initialising this library.
108-
*
109-
* ```cpp
110-
* RUI3(Stream &serial1, Stream &serial);
111-
* ```
112-
* @param serial1 Serial for responses from RUI3 module: WisDuo ==> host MCU
113-
* @param serial Serial for communication with RUI3 module: host MCU ==> debug console
114-
*
115-
* @par Usage
116-
* @code
117-
* RUI3 wisduo(Serial1, Serial);
108+
*
109+
* ```cpp
110+
* RUI3(Stream &serial1, Stream &serial);
111+
* ```
112+
* @param serial1 Serial for communication with RUI3 module: WisDuo <==> host MCU
113+
* @param serial Serial for debug: host MCU <==> debug console
114+
*
115+
* @par Usage
116+
* @code
117+
* RUI3 wisduo(Serial1, Serial);
118118
* @endcode
119119
*/
120120
RUI3(Stream &serial1, Stream &serial);

0 commit comments

Comments
 (0)