Skip to content

Commit b99b229

Browse files
committed
add some spacing at the end of api sections
1 parent b5cc56f commit b99b229

7 files changed

Lines changed: 30 additions & 0 deletions

File tree

docs/libraries/asyn-library.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ asyn.callParamCallbacks (portName [, addr, parameter])
8787
| addr | number | Optional. The parameter list index. Default: 0. |
8888
| parameter | string | Optional. A specific parameter. Default: all changed values. |
8989

90+
<br>
9091

9192
Reading / Writing Values
9293
------------------------
@@ -126,6 +127,7 @@ asyn.writeParam (portName [, addr], paramName, value)
126127
| paramName | string | The name of the parameter. |
127128
| value | varies | The value to write. |
128129

130+
<br>
129131

130132
Configuration Parameters
131133
------------------------
@@ -204,6 +206,7 @@ asyn.getReadTimeout ()
204206

205207
**Returns:** the current timeout (for get).
206208

209+
<br>
207210

208211
Debug Information
209212
-----------------
@@ -249,6 +252,7 @@ Valid keys: `"nodata"`, `"ascii"`, `"escape"`, `"hex"` (case insensitive).
249252
| key | string | Which mask to change. |
250253
| val | boolean | Whether to turn on or off the mask. |
251254

255+
<br>
252256

253257
Octet Communications
254258
--------------------
@@ -331,6 +335,7 @@ asyn.setOption (portName [, addr], key, val)
331335

332336
**Returns:** the asynStatus value.
333337

338+
<br>
334339

335340
asynOctetClient Object
336341
----------------------
@@ -502,6 +507,7 @@ local port1 = port0[1] -- same port, address 1
502507

503508
**Returns:** a new asynOctetClient object.
504509

510+
<br>
505511

506512
asynPortDriver
507513
--------------

docs/libraries/bytestream-library.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ bs.match("%{off|on|standby}", "standby") -- returns 2
9292
bs.format("%{off|on|standby}", 1) -- returns "on"
9393
```
9494

95+
<br>
9596

9697
Formatting and Parsing
9798
----------------------
@@ -189,6 +190,7 @@ bs.add_format {
189190
| - | - | - |
190191
| specifier | table | Table with `identifier` (string), `read` (function), and/or `write` (function). |
191192

193+
<br>
192194

193195
Bytestream Client
194196
------------------
@@ -310,6 +312,7 @@ Properties delegated to the underlying `asyn.client`:
310312
| `portName` | string | Read-only. The port name. |
311313
| `addr` | number | Read-only. The address. |
312314

315+
<br>
313316

314317
Usage with DTYP Device Support
315318
------------------------------
@@ -358,6 +361,7 @@ drvAsynIPPortConfigure("SENSOR1", "192.168.1.100:5025")
358361
luaLoadFile("sensor.lua", {P="dev1:", PORT="SENSOR1"})
359362
```
360363

364+
<br>
361365

362366
Comparison with StreamDevice
363367
----------------------------

docs/libraries/database-library.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ db.loadTemplate("motor.db", {
149149

150150
**Returns:** nothing.
151151

152+
<br>
152153

153154
Record Inspection
154155
-----------------
@@ -172,6 +173,7 @@ for _, rec in ipairs(records) do
172173
end
173174
```
174175

176+
<br>
175177

176178
Record Object
177179
-------------
@@ -187,6 +189,7 @@ The dbrecord object returned by `db.record` and `db.list` provides:
187189
| `rec:field(name, value)` | Set a field value by name. |
188190
| `rec:info(name, value)` | Add an info tag to the record. |
189191

192+
<br>
190193

191194
Database Hooks
192195
--------------
@@ -207,6 +210,7 @@ invoked. The callback receives the file path and a table of macros.
207210
| - | - | - |
208211
| callback | function | Called with `(filepath, macros_table)`. |
209212

213+
<br>
210214

211215
Static Database Access
212216
----------------------

docs/libraries/epics-library.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ epics.put("my:stringwf", {"Hello", "World"})
102102

103103
**Returns:** an error string on failure.
104104

105+
<br>
105106

106107
PV Object
107108
---------
@@ -193,6 +194,7 @@ Writes a field using the same options as `epics.put`.
193194

194195
**Returns:** nothing on success, error string on failure.
195196

197+
<br>
196198

197199
Array Types
198200
-----------

docs/libraries/event-library.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ local ready = event.flag("dataReady") -- named (shared)
5858

5959
**Returns:** an event flag object.
6060

61+
<br>
6162

6263
Flag Methods
6364
------------
@@ -146,6 +147,7 @@ end
146147

147148
**Returns:** `true` if the flag is set, `false` if the timeout expired.
148149

150+
<br>
149151

150152
Examples
151153
--------

docs/libraries/seq-library.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ local prog = seq.program("myProgram", { poll = 0.05 })
6060

6161
**Returns:** a program object.
6262

63+
<br>
6364

6465
Defining States
6566
---------------
@@ -120,6 +121,7 @@ current state name):
120121

121122
By default, `entry` and `exit` only run when the state actually changes.
122123

124+
<br>
123125

124126
Transitions
125127
-----------
@@ -183,6 +185,7 @@ seq.when(seq.delay(5.0)) {
183185

184186
**Returns:** a delay condition object.
185187

188+
<br>
186189

187190
Running Programs
188191
----------------
@@ -223,6 +226,7 @@ prog:stop ()
223226

224227
The program exits at the end of its current evaluation cycle.
225228

229+
<br>
226230

227231
Error Handling
228232
--------------
@@ -231,6 +235,7 @@ If a condition, action, or entry/exit function raises an error, the
231235
sequencer logs the error message and continues running. Condition
232236
errors are treated as false (the transition does not fire).
233237

238+
<br>
234239

235240
Usage Pattern
236241
-------------
@@ -281,6 +286,7 @@ iocInit()
281286
The `11-Sequencer` example IOC demonstrates this pattern with a
282287
traffic light controller and a voltage monitor.
283288

289+
<br>
284290

285291
Comparison with SNL
286292
-------------------

docs/luaPortDriver.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ as Lua functions. There are two approaches:
3232
Both approaches produce a standard asynPortDriver that works with all
3333
asyn device support record types (asynInt32, asynFloat64, asynOctet).
3434

35+
<br>
3536

3637
Creating a Driver
3738
-----------------
@@ -95,6 +96,7 @@ Octet "MESSAGE" ("Ready") -- string param, default "Ready"
9596

9697
**Returns:** a parameter specification table.
9798

99+
<br>
98100

99101
Parameter Access
100102
----------------
@@ -148,6 +150,7 @@ Convenience methods that work on both `find` and `new` drivers.
148150

149151
**Returns:** the parameter value (for readParam).
150152

153+
<br>
151154

152155
Read and Write Callbacks
153156
-------------------------
@@ -207,6 +210,7 @@ Internal state fields do not conflict with parameter names. Parameters
207210
are accessed via the parameter proxy (`drv.PARAM.value`), while internal
208211
state is accessed directly (`self.fieldname`).
209212

213+
<br>
210214

211215
Finding Existing Drivers
212216
------------------------
@@ -225,6 +229,7 @@ drv.SETPOINT.value = 25.0
225229
The parameter proxy, `callParamCallbacks`, `writeParam`, and `readParam`
226230
documented above all work on drivers obtained via `find` as well.
227231

232+
<br>
228233

229234
Creating Records
230235
----------------
@@ -292,6 +297,7 @@ luaSpawn("device.lua", {P="dev2:", PORT="DEV2", DEVICE_PORT="serial2", CONV="0.1
292297

293298
The `09-PortDriver` example IOC demonstrates this pattern.
294299

300+
<br>
295301

296302
Legacy: luaPortDriver iocsh Command
297303
------------------------------------

0 commit comments

Comments
 (0)