Skip to content

Commit c4a706c

Browse files
committed
Update formatting
1 parent 4a6e8cc commit c4a706c

24 files changed

+863
-883
lines changed

docs/en/zigbee/zigbee.rst

Lines changed: 142 additions & 70 deletions
Large diffs are not rendered by default.

docs/en/zigbee/zigbee_analog.rst

Lines changed: 16 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ Creates a new Zigbee analog endpoint.
2525
2626
ZigbeeAnalog(uint8_t endpoint);
2727
28-
**Parameters:**
2928
* ``endpoint`` - Endpoint number (1-254)
3029

3130
Cluster Management
@@ -40,7 +39,7 @@ Adds analog input cluster to the endpoint.
4039
4140
bool addAnalogInput();
4241
43-
**Returns:** ``true`` if successful, ``false`` otherwise
42+
This function will return ``true`` if successful, ``false`` otherwise.
4443

4544
addAnalogOutput
4645
^^^^^^^^^^^^^^^
@@ -51,7 +50,7 @@ Adds analog output cluster to the endpoint.
5150
5251
bool addAnalogOutput();
5352
54-
**Returns:** ``true`` if successful, ``false`` otherwise
53+
This function will return ``true`` if successful, ``false`` otherwise.
5554

5655
Analog Input API
5756
----------------
@@ -68,10 +67,9 @@ Sets the application type for the analog input.
6867
6968
bool setAnalogInputApplication(uint32_t application_type);
7069
71-
**Parameters:**
7270
* ``application_type`` - Application type constant (see esp_zigbee_zcl_analog_input.h for values)
7371

74-
**Returns:** ``true`` if successful, ``false`` otherwise
72+
This function will return ``true`` if successful, ``false`` otherwise.
7573

7674
setAnalogInputDescription
7775
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -82,10 +80,9 @@ Sets a custom description for the analog input.
8280
8381
bool setAnalogInputDescription(const char *description);
8482
85-
**Parameters:**
8683
* ``description`` - Description string
8784

88-
**Returns:** ``true`` if successful, ``false`` otherwise
85+
This function will return ``true`` if successful, ``false`` otherwise.
8986

9087
setAnalogInputResolution
9188
^^^^^^^^^^^^^^^^^^^^^^^^
@@ -96,10 +93,9 @@ Sets the resolution for the analog input.
9693
9794
bool setAnalogInputResolution(float resolution);
9895
99-
**Parameters:**
10096
* ``resolution`` - Resolution value
10197

102-
**Returns:** ``true`` if successful, ``false`` otherwise
98+
This function will return ``true`` if successful, ``false`` otherwise.
10399

104100
setAnalogInputMinMax
105101
^^^^^^^^^^^^^^^^^^^^
@@ -110,11 +106,10 @@ Sets the minimum and maximum values for the analog input.
110106
111107
bool setAnalogInputMinMax(float min, float max);
112108
113-
**Parameters:**
114109
* ``min`` - Minimum value
115110
* ``max`` - Maximum value
116111

117-
**Returns:** ``true`` if successful, ``false`` otherwise
112+
This function will return ``true`` if successful, ``false`` otherwise.
118113

119114
Value Control
120115
*************
@@ -128,10 +123,9 @@ Sets the analog input value.
128123
129124
bool setAnalogInput(float analog);
130125
131-
**Parameters:**
132126
* ``analog`` - Analog input value
133127

134-
**Returns:** ``true`` if successful, ``false`` otherwise
128+
This function will return ``true`` if successful, ``false`` otherwise.
135129

136130
Reporting Methods
137131
*****************
@@ -145,12 +139,11 @@ Sets the reporting configuration for analog input.
145139
146140
bool setAnalogInputReporting(uint16_t min_interval, uint16_t max_interval, float delta);
147141
148-
**Parameters:**
149142
* ``min_interval`` - Minimum reporting interval in seconds
150143
* ``max_interval`` - Maximum reporting interval in seconds
151144
* ``delta`` - Minimum change in value to trigger a report
152145

153-
**Returns:** ``true`` if successful, ``false`` otherwise
146+
This function will return ``true`` if successful, ``false`` otherwise.
154147

155148
reportAnalogInput
156149
^^^^^^^^^^^^^^^^^
@@ -161,7 +154,7 @@ Manually reports the current analog input value.
161154
162155
bool reportAnalogInput();
163156
164-
**Returns:** ``true`` if successful, ``false`` otherwise
157+
This function will return ``true`` if successful, ``false`` otherwise.
165158

166159
Analog Output API
167160
-----------------
@@ -178,10 +171,9 @@ Sets the application type for the analog output.
178171
179172
bool setAnalogOutputApplication(uint32_t application_type);
180173
181-
**Parameters:**
182174
* ``application_type`` - Application type constant (see esp_zigbee_zcl_analog_output.h for values)
183175

184-
**Returns:** ``true`` if successful, ``false`` otherwise
176+
This function will return ``true`` if successful, ``false`` otherwise.
185177

186178
setAnalogOutputDescription
187179
^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -192,10 +184,9 @@ Sets a custom description for the analog output.
192184
193185
bool setAnalogOutputDescription(const char *description);
194186
195-
**Parameters:**
196187
* ``description`` - Description string
197188

198-
**Returns:** ``true`` if successful, ``false`` otherwise
189+
This function will return ``true`` if successful, ``false`` otherwise.
199190

200191
setAnalogOutputResolution
201192
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -206,10 +197,9 @@ Sets the resolution for the analog output.
206197
207198
bool setAnalogOutputResolution(float resolution);
208199
209-
**Parameters:**
210200
* ``resolution`` - Resolution value
211201

212-
**Returns:** ``true`` if successful, ``false`` otherwise
202+
This function will return ``true`` if successful, ``false`` otherwise.
213203

214204
setAnalogOutputMinMax
215205
^^^^^^^^^^^^^^^^^^^^^
@@ -220,11 +210,10 @@ Sets the minimum and maximum values for the analog output.
220210
221211
bool setAnalogOutputMinMax(float min, float max);
222212
223-
**Parameters:**
224213
* ``min`` - Minimum value
225214
* ``max`` - Maximum value
226215

227-
**Returns:** ``true`` if successful, ``false`` otherwise
216+
This function will return ``true`` if successful, ``false`` otherwise.
228217

229218
Value Control
230219
*************
@@ -238,10 +227,9 @@ Sets the analog output value.
238227
239228
bool setAnalogOutput(float analog);
240229
241-
**Parameters:**
242230
* ``analog`` - Analog output value
243231

244-
**Returns:** ``true`` if successful, ``false`` otherwise
232+
This function will return ``true`` if successful, ``false`` otherwise.
245233

246234
getAnalogOutput
247235
^^^^^^^^^^^^^^^
@@ -252,7 +240,7 @@ Gets the current analog output value.
252240
253241
float getAnalogOutput();
254242
255-
**Returns:** Current analog output value
243+
This function will return current analog output value.
256244

257245
Reporting Methods
258246
*****************
@@ -266,7 +254,7 @@ Manually reports the current analog output value.
266254
267255
bool reportAnalogOutput();
268256
269-
**Returns:** ``true`` if successful, ``false`` otherwise
257+
This function will return ``true`` if successful, ``false`` otherwise.
270258

271259
Event Handling
272260
**************
@@ -280,7 +268,6 @@ Sets a callback function to be called when the analog output value changes.
280268
281269
void onAnalogOutputChange(void (*callback)(float analog));
282270
283-
**Parameters:**
284271
* ``callback`` - Function to call when analog output changes
285272

286273
Example

docs/en/zigbee/zigbee_binary.rst

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ Creates a new Zigbee binary sensor endpoint.
3838
3939
ZigbeeBinary(uint8_t endpoint);
4040
41-
**Parameters:**
4241
* ``endpoint`` - Endpoint number (1-254)
4342

4443
Binary Input Application Types
@@ -87,8 +86,7 @@ Adds a binary input cluster to the endpoint.
8786
8887
bool addBinaryInput();
8988
90-
**Returns:**
91-
* ``true`` if successful, ``false`` otherwise
89+
This function will return ``true`` if successful, ``false`` otherwise.
9290

9391
setBinaryInputApplication
9492
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -99,11 +97,9 @@ Sets the application type for the binary input.
9997
10098
bool setBinaryInputApplication(uint32_t application_type);
10199
102-
**Parameters:**
103100
* ``application_type`` - Application type constant (see above)
104101

105-
**Returns:**
106-
* ``true`` if successful, ``false`` otherwise
102+
This function will return ``true`` if successful, ``false`` otherwise.
107103

108104
setBinaryInputDescription
109105
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -114,11 +110,9 @@ Sets a custom description for the binary input.
114110
115111
bool setBinaryInputDescription(const char *description);
116112
117-
**Parameters:**
118113
* ``description`` - Description string
119114

120-
**Returns:**
121-
* ``true`` if successful, ``false`` otherwise
115+
This function will return ``true`` if successful, ``false`` otherwise.
122116

123117
setBinaryInput
124118
^^^^^^^^^^^^^^
@@ -129,11 +123,9 @@ Sets the binary input value.
129123
130124
bool setBinaryInput(bool input);
131125
132-
**Parameters:**
133126
* ``input`` - Binary value (true/false)
134127

135-
**Returns:**
136-
* ``true`` if successful, ``false`` otherwise
128+
This function will return ``true`` if successful, ``false`` otherwise.
137129

138130
reportBinaryInput
139131
^^^^^^^^^^^^^^^^^
@@ -144,8 +136,7 @@ Manually reports the current binary input value.
144136
145137
bool reportBinaryInput();
146138
147-
**Returns:**
148-
* ``true`` if successful, ``false`` otherwise
139+
This function will return ``true`` if successful, ``false`` otherwise.
149140

150141
Usage Example
151142
-------------

0 commit comments

Comments
 (0)